LGUI2:Event Handlers

From Lavish Software Wiki
(Redirected from LGUI2:Event Handler)
Jump to navigation Jump to search

LavishGUI 2 has a system of event handlers tied to Elements. Each element has a table of event names, which map to event handlers.

Types of Event Handlers

Defining an Event Handler

Each Event Handler is defined by a JSON object enclosed by {}, or JSON array enclosed by []. An object may be preferable for explicitness, or an array may be preferable for compactness.

As a JSON Array

When defining an Event Handler with a JSON array, each item in the array is expected to be a string, and we will refer to them as parameters.

The first parameter is to be the type of event handler, one of "code" or "method". Following the type parameter will be any type-specific parameters.

Event Handler types defined by JSON Arrays
  • code: Code requires only one additional parameter, being LavishScript code to execute. Example: ["code","echo Hi mom!"]
  • method: Method requires two parameters in this order. First, the LavishScript object (globally accessible) with the method to execute. Second, the name of the method to execute. Example: ["method","MyBindingController","IDidIt"]. This case is also equivalent to ["code","MyBindingController:IDidIt"].
  • forward: Forward requires at least one additional parameter, and up to 4: event, elementName, elementType, flags. See the Event Handler properties table below for details on each.
  • style: Style requires at least one additional parameter, and up to 5: styleName, event, elementName, elementType, flags. See the Event Handler properties table below for details on each.
  • animation: Animation requires at least one additional parameter, and up to 5: animation (JSON format), event, elementName, elementType, flags. See the Event Handler properties table below for details on each.
  • task: Task requires at least two additional parameters in this order: taskManager, task. See the Event Handler properties table below for details on each.

As a JSON Object

When defining an Event Handler with a JSON object, each item in the object is expected to be a string, and we will refer to them as properties.

Event Handler properties
type One of "method" "code" or "forward", with additional properties below depending on the type
"method" type
object The LavishScript object (globally accessible) with the method to execute
method The method on the object to execute
"code" type
code LavishScript code to execute
"forward" type
event (required) The Name of an event to forward to, on the forward element
elementName (optional) The Name of a related element to forward to
elementType (optional) The Type of a related element to forward to
flags (optional) The relationships to search for the intended element; by default, only ancestors are searched.
"style" type
styleName (required) The Name of the style to activate, on the forward element
elementName (optional) The Name of a related element to forward to
elementType (optional) The Type of a related element to forward to
flags (optional) The relationships to search for the intended element; by default, only ancestors are searched.
"animation" type
animation An Animation definition specifying the Animation to activate
elementName (optional) The Name of a related element to forward to
elementType (optional) The Type of a related element to forward to
flags (optional) The relationships to search for the intended element; by default, only ancestors are searched.
"task" type
taskManager The name of an existing Task Manager used to perform the Task
task The JSON Object describing the Task to perform
stacking (optional) true/false indicating whether multiple instances of this Task can exist, or if the Event Handler stops the already-running Task


Examples

See lgui2eventargs for a detailed example using LavishScript methods.

LavishGUI 2 Topics