Class ecm.widget.MultiValueInputPane
Extends
dijit._Widget.
Provides a widget that is used to enter multiple values. This widget is used for IBM FileNet Content
Manager repositories.
Defined in: <ecm\widget\MultiValueInputPane.js>.
Constructor Summary
Constructor Attributes | Constructor Name and Description |
---|---|
Field Summary
Field Attributes | Field Name and Description |
---|---|
Boolean indicating if the selected values grid allows duplicates.
|
|
Boolean indicating whether sorting is supported.
|
|
Boolean indicating whether strings are trimmed when added to the list.
|
Method Summary
Method Attributes | Method Name and Description |
---|---|
destroy()
Cleans up the widget when it is destroyed.
|
|
getLabel()
Returns the label string for the input values.
|
|
getValue()
Returns the value.
|
|
onSave()
Called by the
DropDownInput widget when the user clicks the OK button. |
|
onShow()
Called when showing the widget.
|
|
An event triggered when the values in the grid change.
|
|
resize(changeSize)
Resizes the widget.
|
|
setData(inargs)
Sets the data.
|
|
setDataValues(values, dataType, dataFormat, valueTimeZoneOffset)
Sets the data values.
|
|
setEditable(bool)
Indicates if the data is editable.
|
|
setLabelArray(labelArray)
Clears the existing grid and adds each label in the array to the grid.
|
Field Detail
allowDuplicateValues
Boolean indicating if the selected values grid allows duplicates. If set to
false
, then the
value will be the identifier for the store.
hasSorting
Boolean indicating whether sorting is supported. If set to
false
, then the move up down
buttons do not show.
trimStrings
Boolean indicating whether strings are trimmed when added to the list.
Method Detail
constructor()
destroy()
Cleans up the widget when it is destroyed.
getLabel()
Returns the label string for the input values.
- Returns:
- The full label string. When multiple values are entered, the label for each entered value is appended
to the label string. The
_separator
character is used to separate multiple labels in the label string.
getValue()
Returns the value.
- Returns:
- An array of the input values.
onSave()
Called by the
DropDownInput
widget when the user clicks the OK button. Gets
the data in the value grid.
onShow()
Called when showing the widget. Loads the values grid.
onValuesChanged()
An event triggered when the values in the grid change.
- Since:
- 3.0.9
postCreate()
resize(changeSize)
Resizes the widget.
- Parameters:
- changeSize
- The changed size.
setData(inargs)
Sets the data. Also, constructs the editor widget used to enter input values using the single property editor
factory.
- Parameters:
- inargs
- Object containing the attributes for the input widget. Used to call the
SinglePropertyEditorFactory
widget'screateSinglePropertyEditor
method.
setDataValues(values, dataType, dataFormat, valueTimeZoneOffset)
Sets the data values. This function performs no validation of the input values.
- Parameters:
- values
- Array holding new data values to set.
- dataType
- dataFormat
- valueTimeZoneOffset
- Since:
- 2.0.3
setEditable(bool)
Indicates if the data is editable.
- Parameters:
- bool
- Boolean indicating if the data is editable.
setLabelArray(labelArray)
Clears the existing grid and adds each label in the array to the grid. If any label is invalid, then this
method returns the error message.
- Parameters:
- labelArray
- An array of labels.
- Returns:
- If a label is invalid, the error message is returned in the field named
error
of a new object. An empty object is returned if all labels were valid.