Properties
This section describes the properties available for individual elements in the print document. The properties will vary according to the type of element.
General
| Property | Description | Example |
|---|---|---|
| Alignment | Controls the alignment of the contained elements or text within the element, selected from a drop down list. | CENTRE |
| Applicability | Controls if the item is 'applicable', similar effect to a visibility expression. | #{item.isTrackedItem && cMTransaction.countedItemMap[item.tenderKey] != null} |
| Applicable Class Name | An item is only applicable if it has the specified classname. | com.enactor.core.services.ServiceDescription |
| Applicable Entity Name | An item is only applicable if it has the specified entity name. | com.enactor.core.services.ServiceDescription |
| Barcode Size | Size of barcode, selected from a drop down list. | MEDIUM |
| Barcode Type | Type of barcode, selected from a drop down list. | EAN_8 |
| Colour | Indicates the colour of the element, can be shown as the colour name for common colours 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 Def ID | The ID for this column definition. | Left Column |
| Data | Barcode: controls the structure of the barcode. Column Definition: the data for this column definition. | [enactor.cashManagement.BagType] |
| Data Expression | This is entered via a pop-up window and must be enclosed in '#{' and '}'. | #{creditNoteTenderItem.serialNumber} |
| Default Message Resource | Messages file to be used. | Pos/Account/AccountMessages |
| Description | Description of the element. | xxx |
| End | Numerical value, the end position of the column specified as a percentage. | 0 |
| End Position | Numerical value, the end position of the column specified as a number of characters. | 70 |
| Entity References | Used to declare data available in EL expressions during the render of the print document. See More | [mmGroup] |
| Font Name | The name of the font for the element, selected via a pop up window, from a drop down list of available fonts. | Arial |
| Font Size | The size of the font for the element. Numerical value entered via a pop up window. | 10 |
| Font Style | 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] |
| Format ID | The ID for this format element. | customerNameAndAddress |
| Formatters | Used to convert object or primitive values into strings that can be printed. See More | xxx |
| HRI | Indicates whether the 'Human Readable Interface' version of the barcode will be displayed beneath it. | true/false |
| Id | Indicates ID of the element, format can vary according to element. | AddressKey |
| Included Template URLS | The URLS of the other document templates this template refers to. | Pos/Print/ReceiptGeneralFormatEntries44 |
| List Expression | An expression that supplies the list of data for this table. | #{manifest.versionList} |
| Message Base | Indicates the location of the messages file containing the required message. | Pos/Account/AccountMessages |
| 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 drop-down list. It can also contain an expression which determines when the message is to be output. | ACCOUNT_TYPE |
| Original Filename | Original filename for image. | xxx |
| Page Definition URL | URL of the associated page definition. | Pos/Account/DisplayAccountBalanceEnquiryTemplate |
| Page Footer Format ID | Format for page footer, selected from a drop-down list. | customerAddress |
| Page Header Format ID | Format for page header, selected from a drop-down list. | storeAddress |
| Start | The start position of the column specified as a percentage. | 0 |
| Start Position | The start position of the column specified in characters. | 60 |
| Style | The style for the element. It is entered using a pop-up window. | BOLD |
| Style Class | The style class for the element, entered using a pop-up window. | listHeader |
| Sub Title | Sub title of the print document. | xxx |
| Sub Title Message Id | ID of the message associated with the sub title. | xxx |
| Template URL | URL of template used for xxx. | xxx |
| Title | Title of the print document. | Display Account Balance Enquiry Template |
| Title Message Id | Message ID of title if applicable. | EDIT_PREFERENCE_TITLE |
| To | The target of the variable expression. | customerAddress |
| Type | The data type of the variable expression. | com.enactor.mfc.address.Address |
| Value | The source of the variable expression. This is entered via a pop-up window. | customer.customerAddress |
| Variable Declarations | A list of variable names that are available within the print document. This is only used during validation. This is done via a pop-up window with the following fields: Name - name of variable, e.g. view. Type - type of variable, e.g. java.util.Map. Required - indicates whether variable is required. | [view] |
| 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. | #{account.accountCreditLimit > 0} |
| Visible? | Indicates whether the element is visible. | true |
| Wrap? | Indicates whether text can wrap within element. | true/false |
| Width | Width of the print document. Can be specified as an absolute pixel value (e.g. 50), a percentage value (10%), or an automatically sized value (auto). | 75 |
| Window Type | Type of window for page definition, selected from a drop-down list. | View Panel (View Controller) |
Entity References
Used to declare data available in EL expressions during the render of the print document.
| Field | Description | Example |
|---|---|---|
| Reference Name | The name for this reference. This is also the value that will be used as the variable name for the reference. | mmGroup |
| Entity Name | The entity name of the entity for the reference. Only required if you are not using a KeyValueExpression. | group |
| Entity Namespace | The namespace for the entity for the reference. Only required if you are not using a KeyValueExpression. | http://www.enactor.com/core |
| Entity Interface | The java interface name for the entity. This is only used during validation and design. | xxx |
| Key value expression | An expression that is used to load the entity. | #{product.MMGroupKey} |
| Key Properties | The properties used to load the key, i.e. name and value. Only required if you are not using a KeyValueExpression. | groupId and #{productPrice.data['priceGroupKey.groupId']} respectively |
Formatters
Used to convert object or primitive values into strings that can be printed.
| Field | Description | Example |
|---|---|---|
| Amount | ||
| Abs Value? | Indicates whether the formatter should format the value to its absolute value | true/false |
| Negate? | Indicates whether the value should be negated while being formatted. | true/false |
| Amount in Words (For Cheques) | ||
| Maximum Line Length | The maximum length of the line once formatted, any extra characters will be truncated. | xxx |
| Line Prefix | A prefix which is added to the beginning of the line. | xxx |
| Line Suffix | A suffix which is added to the end of the line. | xxx |
| Centre | ||
| Pad | The character used to pad the value. | xxx |
| Width | The required width of the value. Can be specified as an absolute pixel value (e.g. 50), a percentage value (10%), or an automatically sized value (auto). | xxx |
| Date | ||
| Input Pattern | This controls the format the user must use when entering data, for interactive elements. | xxx |
| Pattern | A pattern that is applied to the value when formatting, for example a date might be formatted with the string 'dd-MM-yyyy'. | xxx |
| Exchange Rate | ||
| Currency ID | The ID of a currency used to format a currency value | xxx |
| Number | ||
| Abs Value? | Indicates whether the formatter should format the value to its absolute value | true/false |
| Negate? | Indicates whether the value should be negated while being formatted. | true/false |
| Integer Value? | Indicates if a floating point number is passed, use its integer value. | true/false |
| Pad Left | ||
| Pad | The character used to pad the value. | xxx |
| 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). | xxx |
| Pad Right | ||
| Pad | The character used to pad the value. | xxx |
| 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). | xxx |
| Substring | ||
| Start | When formatting with a substring, the start position to substring from. | xxx |
| End | When formatting with a substring, the end position to substring to. | xxx |