Text Properties
This section describes the properties available for a text 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 |
| Allow Wrap? | Indicates whether the text within the element will wrap. | 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 | Indicates the colour of border of element, 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 for this element in pixels. Integer value, 0 means no border. | 1 |
| Border Style | Indicates the style of the border for this element. 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 |
| 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 | The name of the font to use for the element. It is selected via a pop up window, from a drop down list of available fonts. | Arial |
| Font Size | The size of the font to use for the element. It is a numerical value entered via a pop up window. | 10 |
| Font Style | The style of the font to use for the element, e.g. bold, italic etc. It is 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 |
| Horizontal Alignment | Indicates the horizontal alignment of the element, i.e. Left, Right or Centre. | Left |
| Id | A unique (with the containing element) identifier for this element, entered via a pop up window. | Prompt |
| Message Base | The message base used to resolve message Ids for the element. | #{captureAddressPromptMessageBase} |
| Message ID | This is the name of the message, as found in the message file in the previous field. It 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') : ""}. | ENTER_ADDRESS_PROMPT |
| 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, e.g. #{!empty(messageId)}. 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}] |
| Skip Page Validation? | Indicates whether page validation will be skipped for this element. | false |
| Style | The style for the element, 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 |
| 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, entered via a pop up window. | [applicationLogListBox] |
| Value | This will vary according to element type, and is entered via a pop-up window. 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 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 of the Visible flag. It is entered via a pop up window. | #{basket:testAnyVoidFunctionValid()} |
| Visible? | Indicates whether the element 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 |