Tersus: Distinguished Element Names

Distinguished Element NamesDate: Mar 6, 2013Tags:HelpThe following tables list all distinguished (ie. reserved) names of model elements. These elements have specific, predefined functionality in the Tersus platform. The only exception to this are user-defined (custom) event handlers - see <On [Custom Event Name]>.

Process/Display Elements

Name

Element type

Parent model

Description

Comments

<Add Attachment>

Button

HTML Editor

Executes when the Add an attachment button in the editor toolbar is clicked

Requires specific configuration of the editor via web/settings.js

<Desktop View>

Top level display

Root system

Contains the desktop GUI part of a mobile application, which is displayed by default when the application is accessed from a desktop browser

<Footer>

Group

Table

Contains rows appearing below the regular rows of a table

<Header>

Group

Table

Contains rows appearing above the regular rows, and below the caption and column headings of a table

The common usage for this is as a container for filtering row(s) as demonstrated here.

Any display

Tree Item

Contains the display elements displayed for each tree item

<Init>

Process

Any Display

Executes when the display is initialized (on load/refresh)

The execution of multiple <Init> processes (in multiple displays) is top-to-bottom, i.e. if display A contains display B, A's <Init> will execute before B''s <Init>. Other non-event-handler processes will execute after all <Init>s have executed, and in bottom-to-top order.

A usage example is available here.

<Insert Image>

Button

HTML Editor

Executes when the Insert/edit an image button in the editor toolbar is clicked

<Mobile View>

Top level display

Root system

Contains the mobile GUI part of a mobile application, which is displayed by default when the application is accessed from the mobile browser

can be displayed in a desktop browser, by appending /mobile.html to the application's url

Replaces the deprecated <iPhone View>

<On Blur>

Process

Any display

Executes when the user exits the display element

Based on the browser's onblur event

<On Browse>

Process

Input Field display

Executes when the browse button added to the input field is clicked

Existence of this element causes a browse button (showing an ellipsis icon) to be appended to the input field

<On Change>

Process

Editable display

Executes when the user exits the display element, if the value in that element has changed

Based on the browser's onchange event

<On Click>

Process

Clickable display

Executes when the user clicks the display element

Note that an editable display element becomes clickable when it is read-only, but not disabled.
Based on the browser's onclick event.

A usage example is available here.

<On Collapse>

Process

Tree Item

Executes when the user clicks the collapse (-) icon of a tree item

<On Context Menu>

Process

Any display

Executes when the user issues a context menu request (mouse's right-click)

Based on the browser's oncontextmenu event

<On Delete>

Process

Any Display

Executes when a display element is deleted, as a result of Display Actions/Delete Element, Display Actions/Close Window, or a remove flow

<On Double Click>

Process

Clickable display

Executes when the user double-clicks the display element

Note that an editable display element becomes clickable when it is read-only, but not disabled.
Based on the browser's ondblclick event.

<On Element Change>

Process

Any display

Executes when the value of a non-distinguished data element in the display has changed

<On Expand>

Process

Tree Item

Executes when the user clicks the expand (+) icon of a tree item

<On Focus>

Process

Any display

Executes when the user enters the display element

Based on the browser's onfocus event

<On Key Down>

Process

Any display

Executes when the user presses a key in the context of the display (on the down movement)

This process will usually contain Get Event Attributes to retrieve the code of the key.
Executes before <On Key Press>.
Based on the browser's onkeydown event.

<On Key Press>

Process

Any display

Executes when the user presses a key in the context of the display

This process will usually contain Get Event Attributes to retrieve the code of the key.
Executes after <On Key Down> and before <On Key Up>.
Based on the browser's onkeypress event.

<On Key Up>

Process

Any display

Executes when the user presses a key in the context of the display (on the up movement)

This process will usually contain Get Event Attributes to retrieve the code of the key.
Executes after <On Key Press>.
Based on the browser's onkeyup event.

<On Leave View>

Process

Top level display

Executes when the user switches to another view

<On Location Change>

Process

Top level display

Executes when a change has occurred in the url of the current view

This process will usually contain Get View Parameters to retrieve parameters from the URL. Use Create Location to create a changed url which will be sent to Go to URL.

<On Login>

Process

System

Executes when a user login occurs

<On Logout>

Process

System

Executes when a user logout occurs

<On New Session>

Process

System

Executes when a new user session is started

<On Message>

Process

Subscribe

Executes when a message on the subscribed channel is received

Must be marked repetitive to support multiple messages received om the same channel

<On Mouse Down>

Process

Any display

Executes when the user presses a mouse button in the context of the display (on the down movement)

Executes before <On Click>.
Based on the browser's onmousedown event.

<On Mouse Move>

Process

Any display

Executes when the user moves the mouse pointer in the context of the display

Based on the browser's onmousemove event

<On Mouse Out>

Process

Any display

Executes when the user moves the mouse pointer out of the display

Based on the browser's onmouseout event

<On Mouse Over>

Process

Any display

Executes when the user moves the mouse pointer into the display

Based on the browser's onmouseover event

<On Mouse Up>

Process

Any display

Executes when the user presses a mouse button in the context of the display (on the up movement)

Executes after <On Click>.
Based on the browser's onmouseup event.

<On Orientation Change>

Process

<Mobile View>

Executes when the user changes the orientation of the mobile device

<On Select>

Process

Menu Button

Executes when the user selects an option from the menu

Process

Display element child of Tabbed Pane

Executes when the user selects the tab associated with the display

<On Session Timeout>

Process

System

Executes when a session timeout occurs

<On Sort>

Process

Table

Executes when the user clicks a sortable column in the table

<On Touch End>

Process

Any display

Executes when the user raises his finger, ending a touch gesture

<On Touch Move>

Process

Any display

Executes when the user moves his finger during a touch gesture

<On Touch Start>

Process

Any display

Executes when the user touches the display, starting a touch gesture

<On Unload>

Process

Top level display

Executes when the user closes the browser window or switches to another url

Obsolete

<Open>

Process

Obsolete Tree display

Obsolete

<Welcome>

Process

Root system

Executes when a new application session is initiated

A usage example is available here.

<On [Custom Event Name]>

Process

Any Display

Executes when the event is explicitly fired in the model (using Display Actions/Fire Event)

Custom (user-defined) events allow for decoupling of a model from any specific container, while providing a means for the model to execute logic specific to each container in which it is reused

Data Elements

Name

Element type

Parent model

Description

Comments

<All Columns>

Text

Table

An automatically maintained, comma-separated list of all columns in the table

This element is used in conjunction with <Hidden Columns> to control column visibility.

A usage example is available here.

<Caption>

Text

Any display

The caption of the display element

<Checked>

Boolean

Check Box / Radio Button

The checked state of the display element

 <Col Span>

Number

Any display

The number of columns the <td> tag resulting from the current element spans

The container display element should be in a Row which is itself in a Grid/Table

<Currency Position>

Number display

The position of the currency symbol in relation to the number

 <Currency Symbol>

Number display

<Current Content>

Anything

Variable Pane

A reference to the currently displayed element (pane)

 <Decimal Places>

Number

Number display

The number of decimal places to display

 <Direction>

Text

Any display

The direction ('ltr'/'rtl') of the display element

<Disabled>

Boolean

The disabled state of the display element

<Done>

Nothing (exit)

Any process

An exit slot activated when the process execution has completed

On asynchronous processes, such as Background Process, Popup/Pop-in/Dialog and Timer, activation is immediate

<Empty Option Text>

Text

Chooser

The text displayed when <Value> is empty

<Expandable>

Boolean

Tree Item

Controls whether the tree item displays an expand/collapse icon

<Expanded>

Boolean

Tree Item

The expand/collapse state of the tree item

<HTML Text>

Text

HTML Editor

The HTML code created and displayed by the editor

<Height>

Text/Number

Any display

The height of the display element

Use a text data element to include display units (px, %, em, etc.) supported by the browser

<Hidden Columns>

Text

Table

A comma-spearated list of table columns which are hidden

This element is used in conjunction with <All Columns> to control column visibility.

A usage example is available here.

<Image Path>

Text

Menu Item

<Labels>

Map

Top level display

A map of text translations of labels and captions

Additional details on the built-in translation mechanism is available here,

<Max Length>

<Options>

Any type

Chooser / Menu Button

The options from which a user must select

The type must match that of the <Value> element. If a composite type is used, the first text element of each option is displayed in the list. Element should be repetitive.

<Path>

Text

Image

The url of the image whose content is displayed

<Read Only>

Boolean

Any display

The read-only state of the display element

Setting <Read Only> of a display to Yes, overrides the read-only state of all child displays, without changing the value of their <Read Only> element, if it exists

<Resources>

Map

Top level display

A map of resource translations of image and html paths

Additional details on the built-in translation mechanism is available here,

 <Row Span>

Number

Any display

The number of rows the <td> tag resulting from the current element spans

The container display element should be in a Row which is itself in a Grid/Table

<Screen X>

Number

Any display

The horizontal position of the display element

<Screen Y>

Number

Any display

The vertical position of the display element

<Selected HTML Element>

HTML Editor

<Selected HTML Text>

HTML Editor

 <Selected Item>

Tree Item

Tree

A reference to the currently selected item in the tree

<Selected Pane>

Anything

Tabbed Pane

A reference to the display element implementing the current tab

<Selected Row> 

Row

Table

A reference to the currently selected row in the table

<Sort Order>

Text

Table

The current sort order of the table

This is the actual string used in the ORDER BY clause included in the SELECT statement built by Advanced Find

<Style Class>

Text

Any display

The style class of the display element

Project-specific style classes are defined in web/stylesheet.css

<Style>

Text

Any display

An inline css style for the display element

<Tooltip>

Text

Any display

The tooltip for the display element, displayed when the mouse pointer hovers over the display

<Use Thousands Separator>

Number display

<Valid Values>

Structure

Top level display

A container for valid value definitions defined by the table wizard for rich table(s) in the view

A usage example is available here.

<Validation Message>

Text

Any display

When not empty, the message is displayed as a tooltip, and the display element's style class is set to invalid (red background by default)

When the current view/popup/popin/dialog includes at least one display element with a validation message set, pressing any button with property html.validate set to true will not execute the model in it, and instead display the validation message in an alert

<Value>

Any type

Editable / read-only display

The value contained in the display

<Visible>

Boolean

Any display

The visibility of the display element

Setting <Visible> of a display to No, overrides the visibility of all child displays, without changing the value of their <Visible> element, if it exists

<Width>

Text/Number

Any display

The width of the display element

Use a text data element to include display units (px, %, em, etc.) supported by the browser