Combo Box Properties
Combo Box Properties
This section describes the properties available for combo box element in the page definition, i.e. a drop down list from which a selection(s) can be made.
Effective Constraint
| Property | Description | Example |
|---|---|---|
| Constraint Source | The location that is providing the constraint for this element. | TEMPLATE_CONSTRAINT |
| Constraint Type | The type of constraint for this element, i.e. Bounds - The element is being position absolutely. Flow - The element is flowing. None - The element has no position constraint. | BOUNDS |
| height | The height of the element in pixels. | 63 |
| width | The width of the element in pixels. | 281 |
| x | The x location of the element in pixels, relative to its parent element. | 445 |
| y | The y location of the element in pixels, relative to its parent element. | 184 |
Element Constraint
| Property | Description | Example |
|---|---|---|
| Constraint Type | The type of constraint to apply to the element, i.e. Bounds - The element should be absolutely positioned. Flow - The element should flow. None - No constraint for the element should be supplied here (although a constraint may be inferred from somewhere else, e.g. a template). | BOUNDS |
| height | The height of the element. Can be specified in pixels (e.g. 50), as a percentage (e.g. 10%), or as an automatic value based on the size of the content of the element (auto). | 64 |
| width | The width of the element. Can be specified in pixels (e.g. 50), as a percentage (e.g. 10%), or as an automatic value based on the size of the content of the element (auto). | 321 |
| x | The x location of the element, specified as a value in pixels. It is only available when using a Bounds constraint. | 13 |
| y | The y location of the element, specified as a value in pixels. It is only available when using a Bounds constraint | 314 |
Events
| Property | Description | Example |
|---|---|---|
| Enter Pressed | Indicates what action to be raised when the specified event occurs. | OKPressed |
General
| Property | Description | Example |
|---|---|---|
| Allow Blank? | Indicates whether the combo box will allow a blank element to be selected. | true |
| Allow Focus? | Indicates whether the element will allow focus. | true |
| Allow Wrap? | Indicates whether contents of element can wrap around. | false |
| Background Colour | The background colour for the element. It can be shown as the colour name for common colours, e.g. RED, or a hex code, e.g. #ff0000. It could also contain a conditional statement to determine which colour is to be used, e.g. #{notEmpty(view.currentlyInTrainingMode)&& view.currentlyInTrainingMode ? '#80FF80': 'WHITE' }. | RED |
| Background Image URL | Indicates the URL for background image to be displayed on the element. | Mac1024x768/Pos/PosDialogHoverButton1024x768.gif |
| Border Colour | The border colour for the element. It can be shown as the colour name for common colours, e.g. RED, or a hex code, e.g. #ff0000. It could also contain a conditional statement to determine which colour is to be used, e.g. #{notEmpty(view.currentlyInTrainingMode)&& view.currentlyInTrainingMode ? '#80FF80': 'WHITE' }. | #ff0000 |
| Border Size | Indicates the size of border in pixels. Integer value, 0 means no border. | 1 |
| Border Style | Indicates the style of the element's borders. Styles are selected from a drop down list. | Line |
| Classname | An optional classname that allows the capabilities of the element to be extended. | com.enactor.coreUI.swing.pageElementHandlers. SwingClockLabelElementHandler |
| Colour | The foreground colour for the element. It can be shown as the colour name for common colours, e.g. RED, or a hex code, e.g. #ff0000. It could also contain a conditional statement to determine which colour is to be used, e.g. #{notEmpty(view.currentlyInTrainingMode)&& view.currentlyInTrainingMode ? '#80FF80': 'WHITE' }. | WHITE |
| Data | Additional data that is set into the prompt when the button is pressed, consisting of: Name - name of data, e.g. enactor.cashManagement.BagType. Data Type - type of data, e.g. java.lang.String. Expression - data expression, e.g. Banking. | [enactor.cashManagement.BagType] |
| Document Template URL | Used to format the items in the combo/list box for display. | #{view.itemsFormatter} |
| Editable? | Indicates whether the element is editable. | true |
| Editable Expression | An expression that determines if the element is editable. This will take precedence over the Enabled flag. This is entered via a pop up text window. | #{!readOnly} |
| Enabled? | Indicates whether the element is enabled. | true |
| Enabled Expression | An expression that determines if the element is enabled. This will take precedence over the Enabled flag. This is entered via a pop up text window. | #{size(addressList) > 0} |
| Field Validation Data | See the Reference | Float |
| Field Validation Data Expression | Allows the value in the element to be validated based on the result of an expression. This is entered via a pop-up window. The expression must be enclosed in '#{' and '}'. | #{childOption.validationData} |
| Focus Order | Controls the order the element is tabbed into. Setting to -1 will prevent the element from accepting tab focus. | 3 |
| Font Name | Indicates the name of font for element, selected via a pop up window, from a drop down list of available fonts. | Arial |
| Font Size | Indicates the size of font for element. Numerical value entered via a pop up window. | 10 |
| Font Style | Indicates the style of font for element, e.g. bold, italic etc. Selected from list of available styles. The User can set more than one style on the element. | [Bold,Underline] |
| Force Hidden? | Indicates whether a component will be hidden despite other visibility checks. | true |
| Free Entry Allowed | Indicates whether the combo box will allow free-entry? | true |
| Horizontal Alignment | Indicates the horizontal alignment text of the element, i.e. Left, Right or Centre. | Left |
| Id | A unique (with the containing element) identifier for this element. It is entered via a pop up window. | ComboFieldTitle |
| Item Value Expression | An expression applied against each element in the list that determines what value is bound to the value. | #{item.key.contactTypeId} |
| List Expression | An expression that supplies the list of data for the combo box/list. | #{employeeGradesList} |
| Message Base | Indicates the location of the messages file containing the required message. | Pos/General/PosSwingViewMessages |
| Message ID | This is the name of the message, as found in the message file in the previous field. Can be either typed in directly, if known, or selected from a a drop down list. It can also contain an expression which determines when the message is to be output, e.g. Message ID #{notEmpty(view.transactionHandler.model.basket) && notEmpty(view.user) ? (view.transactionHandler.model.basket.total >= 0 ? 'TOTAL' : 'CREDIT_DUE') : ""}. | ADMIN_BUTTON |
| Messages | A list of optional messages for a text element. It provides a convenient way to specify alternative content for a text element. Each message has an applicability expression. The applicability expressions are evaluated in turn until one returns true. If no match is found the text elements normal text content is used as the default. Messages, like text elements, have value, messageId and messageBase properties. All may be EL expressions. If value is specified it takes precedence over messageId. messageBase is optional. This is done via a pop up window with the following fields: Applicability - indicates when the message is applicable. Message Base - indicates the location of the messages file containing the required message, e.g. com.enactor.maintenance.resources.UserMaintenanceMessages. Message ID - the name of the message, as found in the message file in the previous field. Can be either typed in directly, if known, or selected from a a drop down list. Value - If there is no message currently defined, the User can use this field to define a new message. | [#{messageId}] |
| Options | Controls the list of options displayed in the combo box. This is done via a pop up window with the following fields: Applicability - indicates when the option is applicable. Message Base - indicates the location of the messages file containing the required message, e.g. com.enactor.maintenance.resources.UserMaintenanceMessages. Message ID - the name of the message, as found in the message file in the previous field. Can be either typed in directly, if known, or selected from a drop down list. Value - If there is no message currently defined, the User can use this field to define a new message. | [null,Mr,Mrs,Ms,Miss,Master] |
| Password Mode? | Indicates whether the input text box will hide the data being entered (for example with asterisks). | false |
| Selectable Expression | An expression that determines if the item in the combo box/list is selectable. | #{listItemVisibilityTest} |
| Selected Background Colour | The background colour of the item that is selected. It can be shown as the colour name for common colours, e.g. RED, or a hex code, e.g. #ff0000. It could also contain a conditional statement to determine which colour is to be used, e.g. #{notEmpty(view.currentlyInTrainingMode)&& view.currentlyInTrainingMode ? '#80FF80': 'WHITE'}. | #FF0000 |
| Selected Foreground Colour | The foreground colour of the item that is selected. It can be shown as the colour name for common colours, e.g. RED, or a hex code, e.g. #ff0000. It could also contain a conditional statement to determine which colour is to be used, e.g. #{notEmpty(view.currentlyInTrainingMode)&& view.currentlyInTrainingMode ? '#80FF80': 'WHITE'}. | WHITE |
| Selected Index | The index of the item that is selected. | -1 |
| Skip Page Validation? | Indicates whether page validation will be skipped for this element. | false |
| Style | The style for the element. It is entered using a pop up window. | vertical-align:top |
| Style Class | The style class for the element. It is entered using a pop up window. | removeLink |
| Transparent Background | Indicates whether background of element is transparent. | false |
| Type | The type of Input Text box, or Button to display, which will vary according to element type, i.e. Text Box: Rich Text - A text box that allow formatted text. Text Area - A multi-line text input box. Text Pane - A multi-line text input box that can display formatted text (doesn't allow formatted text entry however). Text Input - A standard single-line text input box. Button: Link - A button that displays its text as a clickable link. Push Button - A button that displays as a normal button with a label. Image Button - A button that renders a clickable image with a label. | Text Field |
| Update Triggers | A trigger ID that will cause this element to update, value entered via a pop up window. | [applicationLogListBox] |
| Value | This will vary according to element type. For display only elements it will control the label for the element. For data entry elements it will control the value the element has. | ${name.sex} |
| Vertical Alignment | Indicates the vertical alignment text of the element, i.e. Centre, Top or Bottom. | Centre |
| Visibility Expression | An expression that determines if the element is visible, according to privileges etc. This will take precedence over the Visible flag. It is entered via a pop up window. | #{basket:testAnyVoidFunctionValid()} |
| Visible? | Indicates whether the element is visible. | true |
List Template Constraints
For all the 'Allow' properties below, the User can select either inherit (i.e. use the associated template values), true or false.
| Property | Description | Example |
|---|---|---|
| Allow Change Bounds? | Indicates whether the bounds of the element can be changed. | Inherit |
| Allow Creation? | Indicates whether new child elements can be added to the element. | Inherit |
| Allow Edit? | Indicates whether the properties of the element can be modified. | Inherit |
| Allow Removal | Indicates whether the properties of the element can be removed. | Inherit |
| Allow Replacement? | Indicates whether child elements that were contributed by the template can be replaced with other elements. | Inherit |
Template Constraints
For all the 'Allow' properties below, the User can select either inherit (i.e. use the associated template values), true or false.
| Property | Description | Example |
|---|---|---|
| Allow Bounds to Change? | Indicates whether the bounds of the element can be changed. | Inherit |
| Allow Edit? | Indicates whether the properties of the element can be modified. | Inherit |
| Allow Removal? | Indicates whether the properties of the element can be removed. | Inherit |
| Allow Replacement? | Indicates whether child elements that were contributed by the template can be replaced with other elements. | Inherit |
| Render Mode | Indicates the mode of rendering for the page definition and affects when an element is drawn. It is selected from a drop down list, i.e. At Initialisation, Whenever Rendered or Use Template. | Whenever Rendered |
Field Validation Data
Field Validation Data Allows the value in the element to be validated in a number of different ways, selected from a drop down list. A selection of the following options will be displayed, depending on the type of field:
| Field | Description | Example |
|---|---|---|
| Allow Nulls | A tick indicates that nulls are allowed for this element. | Set |
| Earliest Date | Earliest allowed date - entered either as dd/mm/yyyy format, or by using the up and down arrows to the right of the field. The date can also be set as unbounded, via a tick box. | 24/06/2020 |
| Latest Date | Latest allowed date - entered either as dd/mm/yyyy format, or by using the up and down arrows to the right of the field. The date can also be set as unbounded, via a tick box. | 24/06/2020 |
| Display Format | Indicates whether the required format is to be displayed. | shortDate |
| Custom Validation Classname | Classname used for customer validation. | xxx |
| Input Mask | Mask used against input data for validation. | 00 |
| Minimum Value | Minimum value of the element. | 0 |
| Maximum Value | Maximum value of the element. | 9999 |
| Minimum length | Minimum length of the string. | 1 |
| String Format | Format of the string, selected from a drop down list, e.g. alpha, URL etc. | URL |
Float