Page Definition Properties
This section describes the general properties available for the page definition.
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 Close? | Indicates whether the page definition will show a 'close' button. | true |
| Allow Help? | Indicates whether the page definition will show a 'help' button | true |
| Allow Move? | Indicates whether the page definition will support being moved on the screen. | true |
| Allow Pause? | Indicates whether the page definition will show a 'pause' button. | true |
| Allow Resize? | Indicates whether the page definition will support being resized. | 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 |
| 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 |
| Default Message Resource | The default message base used when resolving message IDs for the page. | Pos/Sale/SaleMessages |
| 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 Editable flag. | #{!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} |
| 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] |
| Function Libraries | A list of the function libraries that are available in this page definition. This is done via a pop up window with the following fields: Name - name of function, e.g. customerPage. Path - path of function, e.g. class:com.enactor.crm.customer.CustomerEditPage. | [customerPage] |
| Handler Classnames | Specifies which handlers should be used to support the custom element given a view type. This is done via a pop up window with the following fields: View ID - ID of the view, e.g. JSFMaintenance. Handler Classname - classname of the handler, e.g. com.enactor.coreUI.web.JSF.pageElementHandlers.custom.PageControlElementHandler. | [JSFMaintenance] |
| Has Title Bar? | Indicates whether the page definition has a title bar. | true |
| Height | The height of the element, specified as an absolute pixel value (e.g. 50), a percentage (e.g. 10%) or automatically sized (auto). | 200 |
| Management Bean Classname | The name of a management bean class that provides additional functions that can be called by expressions in the page definition. | com.enactor.crm.customer.CustomerEditPage |
| Management Bean Name | The variable name used to access the management bean within the page definition. | customerPage |
| MSR Data Name | If MSR input is enabled, this is the name of the state data item into which the MSR data will be captured. This must be of type string. | enactor.pos.CardTrack2 |
| MSR Enabled? | Indicates whether input from a Magnetic Stripe Reader is enabled, if present, default false | true |
| Page Definition URL | URL of the whole page definition. | Pos/Sale/Sale |
| Page Events | Indicates events that are handled by the page. Each entry has an event name, a destination page element and an action name to raise on that element. It allows a page to receive events and perform actions on individual elements. For example: event 'key.EnterPressed', action 'OKPressed', destination 'Prompt'. This is done via a pop up window with the following fields: Event Name - e.g. TrackChanges. Action Name - e.g. #{changesMade}. Destination - e.g. page. | [TrackChanges] |
| Page Validation Events | Events that, when fired, trigger validation of the data within the page. If not supplied, all events will trigger validation. | [Save] |
| Preferred Constraint Type | The preferred constraint type for the page definition. New elements will by default use this constraint type when they are added to the page definition. It is selected from a drop down list, i.e. bounds or flow. | BOUNDS |
| Scanner Data Name | If scanner input is enabled, this is the name of the state data item into which the scanner data will be captured. This must be a string variable. | enactor.pos.ProductCodeScanned |
| Scanner Enabled? | Indicates whether input from a barcode scanner is enabled, if present, default false | true |
| 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 |
| Stylesheets | A list of design time stylesheets, used to help the designer present a more realistic preview. | [Mac/portalstyles.css] |
| Sub Title | The subtitle for the page definition. | xxx |
| Sub Title Message Id | The message ID to use as the subtitle for the page definition. | xxx |
| Template URL (Design Time) | URL of template used for design of page definition. | Pos/StandardPosTemplate |
| Timeout | A timeout in milliseconds. If the no button is pressed within this timeout, the page will automatically expire and raise an event back to the process. | 0 |
| Title | Title of page definition. | Sale |
| Title Message Id | Message ID of title if applicable. | EDIT_PREFERENCE_TITLE |
| Transparent Background | Indicates whether background of element is transparent. | false |
| URL Resolver | A class that will determine how the URLs on the page definition are interpreted. | com.enactor.coreUI.web.JSF.pageElementHandlers. ButtonServletURLResolver |
| Variable Declarations | A list of variable names that are available within the page definition. This is only used during validation. This is done via a pop up window with the following fields: Name - name of variable, e.g. enactor.coreUI.User. Type - type of variable, e.g. com.enactor.core.signOn.ISignedOnUser. Required - indicates whether variable is required. | [enactor.mfc.TransactionHandler,enactor.coreUI.User] |
| Width | The width of the element. Can be specified as an absolute pixel value (e.g. 50), a percentage value (10%), or an automatically sized value (auto). | 833 |
| Window Type | This takes various values to determine the kind of window, frame or dialog that should be displayed. | View Panel (View Controller) |
| x | If the element is absolutely positioned, the x coordinate it should appear at (relative to the element's parent) | 0 |
| y | If the element is absolutely positioned, the y coordinate it should appear at (relative to the element's parent) | 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 |