Input attribute of selection dropdown type.
Syntaxpublic class SelectionBoxAttribute Base class/Interfaces MembersAll public members of the SelectionBoxAttribute class, including all inherited members.
| Name | Description |
|---|---|
| Default value (if provided) | |
| Constructor. | |
| Constructor. | |
| Detailed description of the attribute. | |
| Attribute Id. | |
| Input type can be changed from the State Editor by checking/unchecking the input attribute checkbox, to set to InputType#SESSION or InputType#ATTRIBUTE, respectively. | |
| More efficient way to check and obtain the value of the input attribute using a single database call. | |
| Similar to getInputValue() but this method throws RequiredParameterMissingException when the input attribute is not optional (or mandatory) but the value is null (or not populated). | |
| List of items that will be used for the dropdown list. | |
| Helper method to find the value of the specified key from the dropdown list. | |
| The text that was entered in the input field on the state editor. | |
| Get the InputValue with no warning. | |
| Whether the UI checkbox component is enabled or not. | |
| Whether the input attribute is optional. | |
| Return True/False when the InputAttribute contains value or not, respectively. | |
| Enable or disable the checkbox. | |
| Sets the processing engine context. | |
| Detailed description of the attribute. | |
| Attribute Id. | |
| Input type can be changed from the State Editor by checking/unchecking the input attribute checkbox, to set it to InputType#SESSION or InputType#ATTRIBUTE, respectively. | |
| Set the list of items to be used in populating the dropdown list. | |
| Set the input attribute optional status. | |
| Indicate how to treat the value provided in the input field, either as a "static value" or as a "session variable name" to retrieve the actual value from session variable using the specified name. |
All protected members of the SelectionBoxAttribute class, including all inherited members.
| Name | Description |
|---|---|
| Sets the processing engine context. | |
| Helper class used internally by the getInputValue(), getInputValueWithWarning(), and getValue(). | |
| Helper class called internally by getRawValue(). | |
| Description that will be displayed on the state editor for user consumption. | |
| Indicator of whether this attribute is encrypted or not. | |
| Unique Id of the attribute. |
RemarksThe State Editor will display this input attribute using a selection dropdown component with preset list. User can select a value from the dropdown list but not entering a new one.
By default, the SelectionBoxAttribute has a InputAttribute.InputType#ATTRIBUTE type, so the input attribute checkbox will be unchecked, and it means the value is static and will be used as is. The choice made by the user on the State Editor will be treated as a static value, and used as is. The dropdown is populated with a "Key-Value" list, and the selected value is the "Key". The "Value" is the displayed text shown on the UI.
This SelectionBoxAttribute can also be set to InputAttribute.InputType#SESSION type, to retrieve the value from the session variable. The name of the session variable will be the ID of this selectionbox attribute, and it cannot be changed. On the state editor, the ID will be shown on mouse-hover over the input attribute description. When set to the InputAttribute.InputType#SESSION type, the selection should be left null.
SelectionBoxAttribute constructor
getInputValue method
getItems method
getItemValue method
getRawValueLog method
isSet method
setItems method
 |
Discuss this page in DocCommentXchange.
|
Copyright © 2012, Sybase, Inc. - Brand Mobiliser API 1.3.0 - October 24, 2012 |