Class ecm.widget.ComboBox

Provides a widget that displays a combination box that consists of a field and a drop-down list. The user can select a value from the list or type a value in the field. The value in the field does not need to match a value in the list.

This class extends the Dojo dijit.form.ComboBox class to provide hover help for the combination box.

Defined in: <ecm\widget\ComboBox.js>.

Constructor Summary

Constructor Attributes	Constructor Name and Description
	ecm.widget.ComboBox()

Method Summary

Method Attributes	Method Name and Description
	getErrorMessage(isFocused) Returns the error message.
	getSelectedDisplayedValue() Returns the selected display value.
	getValue() Returns the value selected in the combo box.
	isValid() Returns boolean indicating if valid.
	postCreate()
	setCustomValidationError(errorMessage) Sets the custom validation error and validates.
	setSelectedDisplayedValue(displayedValue) Sets the selected display value.

Constructor Detail

ecm.widget.ComboBox()

Method Detail

getErrorMessage(isFocused)

Returns the error message.

Parameters:
isFocused: Boolean indicating if this widget is focused.

Returns:: String error message.

getSelectedDisplayedValue()

Returns the selected display value.

Returns:: The selected display value that was passed into the setSelectedDisplayedValue method.

getValue()

Returns the value selected in the combo box.

Returns:: The selected value.

isValid()

Returns boolean indicating if valid.

Returns:: Boolean indicating if valid.

postCreate()

setCustomValidationError(errorMessage)

Sets the custom validation error and validates.

Parameters:
errorMessage: The input custom error message.

setSelectedDisplayedValue(displayedValue)

Sets the selected display value.

Parameters:
displayedValue: The displayed value to set.