FormMultiCheckboxField¶
Definition¶
Extends¶
Extended By¶
None
Description¶
A field that allows for multiple check boxes
Method Summary¶
| Owner | Name | Return Type | Description |
|---|---|---|---|
| FormMultiCheckboxField | addOptions(options) | Boolean | Adds to the field's existing options. |
| FormMultiCheckboxField | clearOptions() | Boolean | Removes all options. |
| FormMultiCheckboxField | clearSelected() | Boolean | Clears all the selected options. |
| FormField | exportConfig() | Map | Exports this field's configuration to a map. |
| FormField | focus() | Boolean | Requests user input be focused on this field, will make panel visible if necessary. Returns false if this field can not be focused. Note that the focus is not immediate, meaning a call to isFocused() directly after calling focus may still return false |
| DashboardResource | getCallback(callbackName) | Callback | Returns a callback by name |
| DashboardResource | getCallbacks() | Map | Returns a map of all callback definitions. |
| DashboardResource | getChildren() | List | Returns a list of the child dashboard resources. |
| Object | getClassName() | String | Returns the string name of this object's class type. |
| FormField | getCssClass() | String | Returns the CSS class. |
| DashboardResource | getDRI() | String | Returns the Dashboard Resource Indicator (DRI) as a string. DRI is the unique identifier of this resources within the entire dashboard. |
| DashboardResource | getDashboardResourceType() | String | Returns the Dashboard Resource Type as a string |
| FormField | getDisabled() | Boolean | Returns true if field is disabled, false otherwise. |
| FormField | getDisplayMode() | String | DEPRECATED, use isVisible instead. Returns display type of field. Will return "ABSOLUTE" if field is displayed using absolute positioning. Will return "HTML" if field is displayed using form HTML. |
| FormMultiCheckboxField | getDisplayValueSortOption() | String | Returns the sort option set for the display values. |
| FormField | getFieldValue(varName) | Object | Returns the value of the field with the associated varName for the form that owns this field. |
| DashboardResource | getFormula(formulaName) | Formula | Returns a Formula given the formula name. |
| DashboardResource | getFormulaNames() | Set | Returns a set of the names of all formulas for this object. |
| DashboardResource | getFormulas() | Map | Returns a map of all available formulas for this object. The key is the formula name. |
| DashboardResource | getLRI() | String | Returns the Localized Resource Indicator (LRI) as a string. LRI is the unique identifier of this resource with the parent element. |
| FormField | getLabel() | String | Returns the label associated with this field. |
| FormField | getLabelTooltip() | String | Returns the tooltip associated with this field's label. |
| FormMultiCheckboxField | getOption(key) | String | Returns the option mapped to the specified key. NUll on invalid key. |
| FormMultiCheckboxField | getOptions() | Map | Returns a map of options. |
| DashboardResource | getOwner() | DashboardResource | Returns the DashboardResource that owns this object. |
| FormField | getPanel() | FormPanel | Returns the panel that contains this field. |
| FormField | getPosition() | Rectangle | Returns a Rectangle object representing the field's position as (x,y,w,h). |
| FormMultiCheckboxField | getSelected() | List | Returns ordered list of keys corresponding to the selected items. |
| FormField | getStyleSet() | StyleSet | Returns the StyleSet for this form field. |
| FormMultiCheckboxField | getUnselected() | List | Returns ordered list of keys corresponding to the unselected items. |
| FormField | getValue() | Object | Returns the value associated with this field. |
| FormField | getVariableName() | String | Returns the variable name associated with this field. |
| DashboardResource | invokeCallback(callbackName, args) | Object | Executes the specified callback definition and returns the result from the callback. |
| FormField | isAtDefaultPosition() | Boolean | Returns whether field is at the default position specified in field editor. |
| FormField | isFocused() | Boolean | Returns true if this field has focus, false otherwise. |
| FormField | isTransient() | Boolean | Returns whether a field is transient. |
| FormField | isVisible() | Boolean | Returns true if this field is visible, false otherwise. |
| FormMultiCheckboxField | putOption(key, value) | Boolean | Adds an option to the multi-checkbox field. Returns false if operation fails, true otherwise. |
| FormMultiCheckboxField | removeOption(key) | Boolean | Removes the option from the multi-checkbox field. Returns false if operation fails, true otherwise. |
| FormField | resetCssClass() | Boolean | Resets CSS class to default (as configured in AMI editor). |
| FormField | resetDisabled() | Boolean | Resets the disabled flag to default (as configured in AMI editor). |
| FormMultiCheckboxField | resetOptions() | Boolean | If options have been manually set using amiscript, this resets to default values |
| FormField | resetPosition() | Boolean | Resets field position to default position specified in field editor. |
| FormField | setCssClass(cssStyle) | Boolean | Sets CSS class. Returns empty string for no css. |
| FormField | setDisabled(disabled) | Boolean | Set the disabled status of the field (true for disabling, false for enabling). |
| FormField | setDisplayMode(mode) | Boolean | DEPRECATED, use setVisible instead. Sets display mode of field. Setting to "ABSOLUTE" will display field using absolute positioning. Setting to "HTML" will allow field to be displayed using the form HTML. Any other input will throw an exception. |
| FormMultiCheckboxField | setDisplayValueSortOption(displaySortOption) | Boolean | Sets the sorting option for the display values in the autocomplete menu. |
| FormField | setFieldValue(key, value) | Boolean | Sets the key value pair to this portlet's attributes and returns true if successful. For key, put in the field's variable name, then set the value. |
| FormField | setLabelTooltip(tooltip) | Boolean | Sets the label tooltip. |
| FormMultiCheckboxField | setOptions(options) | Boolean | Set the field's options using the provided map. Removes any previous options before setting it to the new one. Note: previous options will still be cleared even if the operation fails. Returns true if the operation is successful, false otherwise. |
| FormField | setPosition(x, y, w, h) | Boolean | Sets the field position. Specify (x,y) position, width, and height in pixels. Passing null to an argument is equivalent to not setting a value for that specific argument. |
| FormField | setPosition(rect) | Boolean | Sets the position, if the position is null then resets the overrides |
| FormField | setValue(value) | Boolean | Set this field's value. This is a generic set method that is available for every field in AMI. For FormRangeSlider and FormImage field, it is advisable to use their own setValue() method. |
| FormField | setVisible(visible) | Boolean | Sets the visibility of this field. Returns false iff the argument is null, true otherwise. |
| Object | toJson() | String | Returns a json representation of this object. |
Method Definitions¶
addOptions(options)¶
Boolean FormMultiCheckboxField::addOptions(Map options)
Description¶
Adds to the field's existing options.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| options | Map | Options to be added |
clearOptions()¶
Boolean FormMultiCheckboxField::clearOptions()
Description¶
Removes all options.
clearSelected()¶
Boolean FormMultiCheckboxField::clearSelected()
Description¶
Clears all the selected options.
getDisplayValueSortOption()¶
String FormMultiCheckboxField::getDisplayValueSortOption()
Description¶
Returns the sort option set for the display values.
getOption(key)¶
String FormMultiCheckboxField::getOption(Object key)
Description¶
Returns the option mapped to the specified key. NUll on invalid key.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| key | Object | Key for which the corresponding option is returned |
getOptions()¶
Map FormMultiCheckboxField::getOptions()
Description¶
Returns a map of options.
getSelected()¶
List FormMultiCheckboxField::getSelected()
Description¶
Returns ordered list of keys corresponding to the selected items.
getUnselected()¶
List FormMultiCheckboxField::getUnselected()
Description¶
Returns ordered list of keys corresponding to the unselected items.
putOption(key,value)¶
Boolean FormMultiCheckboxField::putOption(Object key, String value)
Description¶
Adds an option to the multi-checkbox field. Returns false if operation fails, true otherwise.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| key | Object | Key to be added |
| value | String | Value to be added |
removeOption(key)¶
Boolean FormMultiCheckboxField::removeOption(Object key)
Description¶
Removes the option from the multi-checkbox field. Returns false if operation fails, true otherwise.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| key | Object | Key to be removed |
resetOptions()¶
Boolean FormMultiCheckboxField::resetOptions()
Description¶
If options have been manually set using amiscript, this resets to default values
setDisplayValueSortOption(displaySortOption)¶
Boolean FormMultiCheckboxField::setDisplayValueSortOption(String displaySortOption)
Description¶
Sets the sorting option for the display values in the autocomplete menu.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| displaySortOption | String | Expected Values: NONE (original ordering), ASC, DESC |
setOptions(options)¶
Boolean FormMultiCheckboxField::setOptions(Map options)
Description¶
Set the field's options using the provided map. Removes any previous options before setting it to the new one. Note: previous options will still be cleared even if the operation fails. Returns true if the operation is successful, false otherwise.
Parameter Definition¶
| Name | Type | Description |
|---|---|---|
| options | Map | Options to be added |