Reference Properties
This section describes the properties available for a page element reference 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 |
General
| Property | Description | Example |
|---|---|---|
| Allow Focus? | Indicates whether the element will allow focus. | true |
| 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 |
| 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 |
| 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 |
| Force Hidden? | Indicates whether a component will be hidden despite other visibility checks. | true |
| Id | A unique (with the containing element) identifier for this element. It is entered via a pop up window. | ReferenceToKeyboard |
| 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 |
| Parameters | Data that is passed onto the referenced page definition.. This is done via a pop up window with the following fields: Name - name of the parameter, e.g. enactor.diaryMaintenance.Day. Value - value of the parameter, e.g. #{calendarEntries[0]}. Type - type of the parameter, e.g. com.enactor.diary.CalendarEntry. | [enactor.diaryMaintenance.Day] |
| Referenced Element ID | The ID of the element in the referenced page definition to include. | CRM/ListFilters |
| Referenced Page Definition URL | The URL of a page definition to include elements from. | Pos/Keyboard/ShiftAlphaKeyboard |
| 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, entered using a pop up window. | removeLink |
| Transparent Background | Indicates whether the background is transparent. | false |
| Update Triggers | A trigger ID that will cause this element to update, value entered via a pop up window. | [applicationLogListBox] |
| 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 |
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 |