Trigger attributes

In Lycia, every trigger of an application action has a fixed set of attributes:

• identifier
• text
• action image
• comment
• accelerators
• statical
• validate
• show in context menu
• default view
• place
• order

Among these attributes, only identifier is mandatory, and other ones are optional and can be used to modify the look and feel of the trigger.

Identifier (mandatory)

Identifies (= names) the trigger. Is used to associate the trigger with an action.

Data type: STRING

Possible values: any, if meets the requirements

Specific requirements:

• Identifier must be unique.
• Identifier can include only letters, digits, and the underscore symbol (_). Blank spaces, punctuation marks, and other symbols (not letters or digits) are not allowed.
• Identifier should begin with a letter (A-Z, a-z).
• Identifiers are not case-sensitive.

Text

Specifies the text displayed to the trigger.

Data type: STRING

Possible values: any

Specific requirements:

• When you think through the trigger's text, keep in mind the size of the form and its elements. If the text is too long, it will not fit into the intended space or will corrupt the application layout.

Action image

Specifies the image which is displayed to the trigger.

Data type: STRING

Possible values:

a path to the image file,

• absolute: C:/my_user/images/lycia_images/image.png
• relative: qx://application/image.png

Comment

Specifies the text that is displayed at hover and usually describes the action.

Data type: STRING

Possible values: any

Accelerators (1-4)

Defines the accelerator key(s) that will trigger the action at runtime.

Data type: STRING

Possible values: key names or their combinations

Specific requirements:

• you can choose upto 4 accelerator keys

Statical

Determines whether triggers are visible even if they are not defined.

Data type: BOOLEAN

Possible values:

• true – not-defined actions are visible
• false – not-defined actions are not visible

Default value: false

Validate

Determines whether data validation is required for the action.

Data type: BOOLEAN

Possible values:

• true – data validation is required
• false – data validation is not required

Default value: false

Show in Context Menu

Determines whether the action can be triggered from the context menu.

Possible values:

• auto – the action can be triggered from the context menu provided that this action is visible and no other triggers are defined,
• yes – the action can be triggered from the context menu provided that this action is visible, and
• no – the action canNOT be triggered from the context menu.

Default value: auto

Default view

Determines whether the trigger is visible on the toolbar.

Possible values:

• auto – the trigger is visible on the toolbar provided that this action is visible and no other triggers are defined,
• yes – the trigger is visible on the toolbar provided that this action is visible, and
• no – the trigger is NOT visible on the toolbar.

Default value: auto

Place

Allows pining triggers in the form of a toolbar button to the navigation bar in Lycia with Material Design.

Data type: STRING

Possible values:

• top – trigger is rendered to the navigation bar of the MD toolbar
• top-popup – trigger is rendered to the drop-down menu of the MD toolbar

Default value: top-popup

Order

Indicates in what order triggers appear on the toolbar.

Data type: INTEGER

Possible values: any integer

Default value:

not defined which means that the trigger is added to the end of the list of actions.