Class ecm.widget.DropDownInput
Extends
dijit.form.DropDownButton.
Provides a widget that combines a drop-down list and a field. A user can enter a value in the field or
select a value from the drop-down list.
Defined in: <ecm\widget\DropDownInput.js>.
Constructor Summary
Constructor Attributes | Constructor Name and Description |
---|---|
Field Summary
Field Attributes | Field Name and Description |
---|---|
The initial value of the control, used for timestamp properties.
|
|
Prompt message to display if there is an error.
|
|
Boolean indicating if the value is required.
|
|
The value.
|
Method Summary
Method Attributes | Method Name and Description |
---|---|
destroy()
Cleans up the data when the widget is destroyed.
|
|
displayMessage(message)
Displays the input message in a tooltip.
|
|
Sets text in the control to "read only".
|
|
getErrorMessage(isFocused)
Retrieves the error message.
|
|
getValue()
Returns the value from the drop-down pane.
|
|
Determines if the drop-down input and dialog is editable.
|
|
isValid()
Determines if the value is valid.
|
|
Creates the
DropDownDialog widget, sets the label on this widget, and listens to the following
events: onChange , onClickOK , onClickCancel ,
openDropDown . |
|
setAllowCloseOnBlur(allowCloseOnBlur)
Sets whether or not the drop-down list should close when it loses focus.
|
|
setCustomValidationError(errorMessage)
Sets the custom validation error and validates the widget.
|
|
setDropDownClass(className)
|
|
setMultiSelectClear(kwArgs)
Clears control for multi-value editing
|
|
validate(isFocused)
Validates the drop-down value.
|
Field Detail
initialDateTimeValues
The initial value of the control, used for timestamp properties. Used to compare initial values with those
displayed by the control to know when values have changed.
promptMessage
Prompt message to display if there is an error.
required
Boolean indicating if the value is required.
value
The value.
Method Detail
destroy()
Cleans up the data when the widget is destroyed.
displayMessage(message)
Displays the input message in a tooltip.
- Parameters:
- message
- String to show in the tooltip.
displayReadOnlyText()
Sets text in the control to "read only". Used in multi item editing for read only properties.
getErrorMessage(isFocused)
Retrieves the error message.
- Parameters:
- isFocused
- Returns:
- The error message string.
getValue()
Returns the value from the drop-down pane.
- Returns:
- The value from the drop-down pane. If the drop-down pane is a
SingleValueTreePane
, then the value is not an array. Otherwise the value is an array.
{Boolean} isEditable()
Determines if the drop-down input and dialog is editable.
- Returns:
- {Boolean} A value of
true
if the drop-down input and dialog are editable, otherwisefalse
.
{Boolean} isValid()
Determines if the value is valid.
- Returns:
- {Boolean} A value of
true
if the value is valid, otherwisefalse
.
postCreate()
Creates the
DropDownDialog
widget, sets the label on this widget, and listens to the following
events: onChange
, onClickOK
, onClickCancel
,
openDropDown
.
setAllowCloseOnBlur(allowCloseOnBlur)
Sets whether or not the drop-down list should close when it loses focus.
- Parameters:
- allowCloseOnBlur
- A Boolean value. If
true
, the drop-down list is automatically closed when it loses focus.
setCustomValidationError(errorMessage)
Sets the custom validation error and validates the widget.
- Parameters:
- errorMessage
- The custom validation error.
setDropDownClass(className)
- Parameters:
- className
setMultiSelectClear(kwArgs)
Clears control for multi-value editing
- Parameters:
- kwArgs
- Object containing information about the property.
{Boolean} validate(isFocused)
Validates the drop-down value.
- Parameters:
- isFocused
- A Boolean value indicating if this widget has the focus.
- Returns:
- {Boolean} A value of
true
if the drop-down value is valid, otherwisefalse
.