List Box Properties
This section describes the properties available for a list box element in the page definition.
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 |
|---|---|---|
| On Selection | Indicates what action to be raised when the specified event occurs. | page.userRoleListBox.changed |
General
| Property | Description | Example |
|---|---|---|
| Alignment | Controls the alignments of the contained elements or text within the element, selected from a drop down list. | CENTRE |
| Allow Focus? | Indicates whether the element will allow focus. | true |
| Allow Multi-Selection? | Indicates whether more than one entry can be selected in a list box. | true |
| Auto Advance Expression | Applies only to ListBox elements. An EL expression which if present is evaluated after a listbox item is selected. If true it causes the next listbox item to be automatically highlighted. | xxx |
| 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 |
| Column Defs | The definitions of the columns for the list box. This is done via a pop up window with the following fields: Alignment - alignment of column contents, e.g. left. Selected from a drop down list. Start -start point of column, followed by absolute or percentage, depending on requirement. End - end point of column, followed by absolute or percentage, depending on requirement. Wrap - a tick indicates that the contents of the column will wrap around. | [1,2,3,Wide3,4,6] |
| Document Template URL | Used to format the items in the combo/list box for display. | Pos/User/UserRoleListTemplate |
| 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} |
| Focus Order | Controls the order the element is tabbed into. Setting to -1 will prevent the element from accepting tab focus. | -1 |
| 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 |
| Hide Intersecting | Indicates whether intersecting page elements will hidden when a panel is made visible. Applies to Panel-based elements. | false |
| Horizontal Scrollbars | Indicates whether horizontal scroll bars are to be displayed. | None |
| Id | A unique (with the containing element) identifier for this element. It is entered via a pop up window. | userRoleListBox |
| 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} |
| Naming Container? | If the element a naming container, i.e. when the ID for child elements is constructed, indicates whether the ID of this element will contribute towards it. | true |
| 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. | [BLANK] |
| 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. | 0 |
| Skip Page Validation? | Indicates whether page validation will be skipped for this element. | false |
| Start With First Item Expression | An expression that determines if the ListBox should start with the first element selected. Applies only to ListBox elements. | #{true} |
| Start With Last Item Expression | An expression that determines if the ListBox should start with the last element selected. Applies only to ListBox elements. | #{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, entered using a pop up window. | removeLink |
| Transparent Background | Indicates whether background of element is transparent. | false |
| 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. | ${enactor.mfc.ProductCode} |
| Vertical Scrollbars | Indicates whether vertical horizontal scroll bars are to be displayed. | None |
| 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 |
| Visible Item Count | The number of items that are visible in the list box. | 0 |
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 |