Class ecm.widget.search.AttributeDefinitionsForm

Extends dijit._WidgetBase.
Provides a widget that is used to define attributes for an IBM Content Manager class or item type. By using a ContentClass object, this widget can render a form that contains either attribute definitions or a template.

To use this widget, a search form must be specified. If a search form is not specified, the widget renders an empty form with disabled buttons.

Defined in: <ecm\widget\search\AttributeDefinitionsForm.js>.

Constructor Summary

Constructor Attributes	Constructor Name and Description
	ecm.widget.search.AttributeDefinitionsForm()

Field Summary

Field Attributes	Field Name and Description
	showFormButtons Sets the value to `false` if the widget will not show the form buttons.
	showHiddenAttributes Sets the value to `true` if the widget will show hidden attributes.
	showSystemAttributes Sets the value to `true` if the widget will show system attributes.

Method Summary

Method Attributes	Method Name and Description
	addAllAttributeDefintions() Adds all attribute definitions to the attribute definition widgets list.
	addAttributeDefintions(criteria, dontClearExistion) Adds all criterion to the attribute definitions list.
	addOneMoreAttributeDefinition() Add the default attribute definition to the attribute definition widget list.
	appendAttributeDefinition(attributeDefinitions) Append some attribute definitions to the attribute definitions list.
	constructor()
	createSearchCriteriaFromAttributeDefintions() Turns all of the attribute definitions in the attribute container into a search criterion list.
	destroy() Destroys the widget.
	findAttributeDefinitionWidgetsByAttributeDefinitionId(id) Find attribute defintion widgets by attribute definition ID.
	getChildren() Gets all children in the attribute container.
	getContentClass() Returns the content class currently being edited.
	getDefaultAttributeDefinitionId() Get the default attribute definition ID.
	getPropertyDisplayValue(fieldName) Retrieves the display value from the property field identified by `fieldName`.
	getShowAll() Gets the value of if show all.
	getWidth() Gets the width of the form.
	isIncludeSubclasses() If include sub classes.
	onChange() Runs after the form is changed.
	onFinishLoadingAttributes() Runs after all attributes are loaded.
	onFormValidate(valid) Runs if the form is valid.
	onKeyDown(e) Runs if a key down event is fired.
	postCreate()
	removeAttributeDefinitions(attributeDefinitionIDs) Remove attribute definitions.
	removeAttributeDefinitionWidgets(attributeDefinitionId) Removes all attribute definition widgets that use the given attribute definition ID.
	resize()
	setAttributeDefinitions(attributeDefinitions, childDefinitions, searchCriteria) Set the attribute definitions.
	setContentClass(contentClass, includeSubclasses, searchCriteria, searchCriteria) Renders the given content class attribute definitions;
	setDefaultAttributeDefinitionId(A) Set the default attribute definition ID.
	setShowAll(showAll) If true, show all, if false, show one.
	updateAttributeDefinition(attributeDefinition, reset) Update the attribute definitions if they have same ID.
	validate(ignoreRequired) Validates all attribute definitions in the attribute container.

Constructor Detail

ecm.widget.search.AttributeDefinitionsForm()

Field Detail

showFormButtons

Sets the value to false if the widget will not show the form buttons.

showHiddenAttributes

Sets the value to true if the widget will show hidden attributes.

showSystemAttributes

Sets the value to true if the widget will show system attributes.

Method Detail

addAllAttributeDefintions()

Adds all attribute definitions to the attribute definition widgets list.

addAttributeDefintions(criteria, dontClearExistion)

Adds all criterion to the attribute definitions list.

Parameters:
criteria: Array of ecm.model.SearchCriterion. Will be added into attribute defintions list.
dontClearExistion: Boolean value. If true, all existing values in attribute definitions list will not be clear before adding.

addOneMoreAttributeDefinition()

Add the default attribute definition to the attribute definition widget list.

appendAttributeDefinition(attributeDefinitions)

Append some attribute definitions to the attribute definitions list.

Parameters:
attributeDefinitions: Array of ecm.model.AttributeDefinition objects.

constructor()

createSearchCriteriaFromAttributeDefintions()

Turns all of the attribute definitions in the attribute container into a search criterion list.

Returns:: Array of ecm.model.SearchCriterion

destroy()

Destroys the widget.

findAttributeDefinitionWidgetsByAttributeDefinitionId(id)

Find attribute defintion widgets by attribute definition ID.

Parameters:
id: String value of ID for finding.

Returns:: Array of ecm.widget.search.AttributeDefinitionWidget.

getChildren()

Gets all children in the attribute container.

Returns:: Array of objects in the attribute container.

getContentClass()

Returns the content class currently being edited.

Returns:: Returns an instance of ecm.model.ContentClass

getDefaultAttributeDefinitionId()

Get the default attribute definition ID.

Returns:: String value of default attribute definition ID.

getPropertyDisplayValue(fieldName)

Retrieves the display value from the property field identified by fieldName.

Parameters:
fieldName: A property Id string.

Returns:: The display value string.

getShowAll()

Gets the value of if show all. True means show all. False means show one.

Returns:: Returns a boolean value of if show all.

getWidth()

Gets the width of the form.

Returns:: Value of width.

isIncludeSubclasses()

If include sub classes.

Returns:: Boolean value of if include sub classes. True means including.

onChange()

Runs after the form is changed.

onFinishLoadingAttributes()

Runs after all attributes are loaded.

onFormValidate(valid)

Runs if the form is valid.

Parameters:
valid: Boolean that indicates whether the form is valid.

onKeyDown(e)

Runs if a key down event is fired.

Parameters:
e

postCreate()

removeAttributeDefinitions(attributeDefinitionIDs)

Remove attribute definitions.

Parameters:
attributeDefinitionIDs: Array of strings.

removeAttributeDefinitionWidgets(attributeDefinitionId)

Removes all attribute definition widgets that use the given attribute definition ID. If the form becomes empty as a result, a new attribute definition widget is added.

Parameters:
attributeDefinitionId

Since:: 2.0.3.6

resize()

setAttributeDefinitions(attributeDefinitions, childDefinitions, searchCriteria)

Set the attribute definitions.

Parameters:
attributeDefinitions: Array of ecm.model.AttributeDefinition objects.
childDefinitions: Array of ecm.model.AttributeDefinition objects.
searchCriteria: Array of ecm.model.SearchCriterion objects.

setContentClass(contentClass, includeSubclasses, searchCriteria, searchCriteria)

Renders the given content class attribute definitions;

Parameters:
contentClass: Content class to render, or list of content classes
includeSubclasses: Boolean indicating if sub classes should be retrieved.
searchCriteria: Initial search criteria (optional)
searchCriteria

setDefaultAttributeDefinitionId(A)

Set the default attribute definition ID.

Parameters:
A: string value of default attribute definition ID.

setShowAll(showAll)

If true, show all, if false, show one.

Parameters:
showAll: A boolean value.

updateAttributeDefinition(attributeDefinition, reset)

Update the attribute definitions if they have same ID.

Parameters:
attributeDefinition: Array of ecm.model.AttributeDefinition objects.
reset: A boolean value. If it's true, reset all ecm.widget.search.AttributeDefinitionWidget objects for each update ecm.model.AttributeDefinition.

validate(ignoreRequired)

Validates all attribute definitions in the attribute container.

Parameters:
ignoreRequired: Boolean value. If true, the validation will ignore required.