Configuring Siebel Open UI > Application Programming Interface > Methods of the Siebel Open UI Application Programming Interface >

Event Helper Class

The Event Helper Class uses the Event Helper Object to facilitate Event Binding in the Physical Renderer or Plug-in Wrapper.

To retrieve the event helper:

var evtHelper = this.Helper("EventHelper" );

Manage is the singular API exposed by the Event Helper Class for unified event binding for DOM elements across multiple platforms. Use the following API specification as a guideline to use the EventHelper object to bind an event:

evtHelper.Manage( el, eventName, eventData, eventHandler );

NOTE:  This syntax is similar to a jQuery bind call. With this call, an attempt is being made to bind event eventName to element el with event data eventData and event handler eventHandler.

Use the following API specification as a guideline to use delegate-on type for event binding:

evtHelper.Manage( el, eventName, eventData, eventHandler, elChild );

For example:

var evtHelper = this.Helper( "EventHelper" );

evtHelper.Manage( el, "down" , functionRef );

The down event is attached to element el, with functionRef defined as the Event Handler. Both touch and mouse events are handled, depending on the environment. The down value will get translated to mousedown in a mouse-enabled environment, and to touchstart in a touch-enabled environment.

In Siebel Innovation Pack 2014 and later, inter-platform event mappings done by the Event Helper object have been harmonized. Consequently, similar actions that create different events on different platforms now result in the same behavior across platforms.

Table 40 shows unified event names and their corresponding actions on touch and non-touch platforms. Using the new unified events creates familiar experiences for users across platforms.

Furthermore, the same unified bindings translate to pointer-based events if the Siebel Open UI Client application detects that the browser supports the pointer object. This behavior is specific to Internet Explorer browsers and pointer events used by Microsoft to unify event handling across different devices on Internet Explorer 10 and later.

Table 41 describes the pointer event mapping.

A double click event is usually handled natively by the browser, such as the zoom action in touch based devices. Consequently, it is not recommended that you attach custom handlers to the double-click event. Attaching custom handlers might make it impossible to unify the behavior of the double-click action.

Events not unified by the Event Helper or listed in Table 40 and Table 41 can still be used with Manage API to attach custom handlers. This applies to events supported by jQuery natively and to custom events that are generated by custom PR/PW code or by third-party plug-in customizations.

For example, a plug-in like iScroll might trigger events such as scollLeft or scrollStop on the element to which the plug-in is attached. The custom PR code can effectively attach custom handlers to these events using the Manage API.