Class ecm.widget.search.AttributeDefinitionWidget

Extends dijit._WidgetBase.
Provides a widget that is used by the search builder to represent a property in a search template.
Defined in: <ecm\widget\search\AttributeDefinitionWidget.js>.

Constructor Summary

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

Field Summary

Field Attributes	Field Name and Description
	attributeDefinition The property definition this widget is modeling.
	attributeDefinitions The property definitions widget.

Method Summary

Method Attributes	Method Name and Description
	constructor(args) Constructor
	destroy() Destroys the widget.
	getAttributeDefinition() Gets the model of attribute definition of this widget.
	getChildAttributeDefinitions() Gets the child attribute definitions.
	getFieldNamesSelect() Gets the property names select field value of this AttributeDefinitionWidget.
	getFields() Gets fields of the property editors.
	getNodeForFocus() Gets nodes for focus on.
	getOperator() Gets the operator.
	getOperatorSelect() Gets the operator select field value of this AttributeDefinitionWidget.
	getPropertyEditors() Retrieves the properties pane property editors.
	getValue() Gets the value(s) of the attribute.
	getValues() Gets values of the attribute.
	getWidth() Gets the width of the widget.
	onAttributeDefinitionChange(oldAttributeDefinition, newAttributeDefinition) An event that is triggered when the attribute definition is changed.
	onAttributeValidate(valid) Launches when the attribute is validated.
	onChange() Launches when the widget is changed.
	onChangeOperator(select, input, hoverHelp) Launches when change operator.
	onKeyDown(e) Launches when a key down event is fired.
	onTabBackwards() Event fired when tab backwards out of this widget.
	onValueChange() An event that is triggered when the value is modified.
	setAttributeDefinition(attributeDefinitions, attributeDefinition) Sets attribute definition(s) of the widget.
	setChildAttributeDefinition(childAttributeDefinition) Sets the child attribute definition.
	setOperator(operator) Sets the operator.
	setValue(value) Sets the value of the attribute.
	setValues(values) Sets values of the attribute.
	validate(ignoreRequired) Validates all fields of the widget.

Constructor Detail

ecm.widget.search.AttributeDefinitionWidget()

Field Detail

attributeDefinition

The property definition this widget is modeling.

attributeDefinitions

The property definitions widget.

Method Detail

constructor(args)

Constructor

Parameters:
args

destroy()

Destroys the widget.

getAttributeDefinition()

Gets the model of attribute definition of this widget.

Returns:: A ecm.model.AttributeDefinition object.

getChildAttributeDefinitions()

Gets the child attribute definitions.

Returns:: Array of ecm.model.AttributeDefinition objects.

getFieldNamesSelect()

Gets the property names select field value of this AttributeDefinitionWidget.

Since:: 2.0.3

Returns:: The operator select field widget

getFields()

Gets fields of the property editors.

Returns:: All fields of the property editors.

getNodeForFocus()

Gets nodes for focus on.

Returns:: Array of selected names.

getOperator()

Gets the operator.

Returns:: Operator value.

getOperatorSelect()

Gets the operator select field value of this AttributeDefinitionWidget.

Since:: 2.0.3

Returns:: The operator select field widget

getPropertyEditors()

Retrieves the properties pane property editors.

Returns:: A ecm.widget.PropertyEditors object.

getValue()

Gets the value(s) of the attribute.

Returns:: Value of the attribute.

getValues()

Gets values of the attribute.

Returns:: Values of the attribute as array.

getWidth()

Gets the width of the widget.

Returns:: Number value of width.

onAttributeDefinitionChange(oldAttributeDefinition, newAttributeDefinition)

An event that is triggered when the attribute definition is changed.

Parameters:
oldAttributeDefinition: The previously used ecm.widget.AttributeDefinition object
newAttributeDefinition: The currently used ecm.widget.AttributeDefinition object

Since:: 2.0.3

onAttributeValidate(valid)

Launches when the attribute is validated.

Parameters:
valid: Boolean value of true if the attribute is valid.

onChange()

Launches when the widget is changed.

onChangeOperator(select, input, hoverHelp)

Launches when change operator.

Parameters:
select: A ecm.widget.Select object.
input: A ecm.widget.TextBox object. Or a ecm.widget.NumberTextBox object.
hoverHelp: The ecm.widget.HoverHelp object.

onKeyDown(e)

Launches when a key down event is fired.

Parameters:
e

onTabBackwards()

Event fired when tab backwards out of this widget.

onValueChange()

An event that is triggered when the value is modified.

Since:: 2.0.3

setAttributeDefinition(attributeDefinitions, attributeDefinition)

Sets attribute definition(s) of the widget.

Parameters:
attributeDefinitions: Array of ecm.model.AttributeDefinition. It will be stored in the widget.
attributeDefinition: A ecm.model.AttributeDefinition object. It will be the model of the widget.

setChildAttributeDefinition(childAttributeDefinition)

Sets the child attribute definition.

Parameters:
childAttributeDefinition: A ecm.model.AttributeDefinition object.

setOperator(operator)

Sets the operator.

Parameters:
operator: String value of operator

setValue(value)

Sets the value of the attribute.

Parameters:
value: A object of single value.

setValues(values)

Sets values of the attribute.

Parameters:
values: Array of values.

validate(ignoreRequired)

Validates all fields of the widget.

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