Class Index | File Index

Classes


Class finesse.containerservices.ContainerServices.Topics

This is the set of Topics used for subscribing for events from ContainerServices. Use finesse.containerservices.ContainerServices#addHandler to subscribe to the topic.
Defined in: finesse.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Field Summary
Field Attributes Field Name and Description
 
Topic for subscribing to be notified when the active tab changes.
 
Topic for listening to gadget view changed events.
 
Topic for listening to max available height changed events.
 
Topic for Reload Gadget events traffic.
 
Topic for Timer Tick event.
 
Topic for WorkflowAction events traffic.
Class Detail
finesse.containerservices.ContainerServices.Topics()
Field Detail
ACTIVE_TAB
Topic for subscribing to be notified when the active tab changes. The provided callback will be invoked when the tab that the gadget that subscribes with this becomes active. To ensure code is called when the gadget is already on the active tab use the finesse.containerservices.ContainerServices#makeActiveTabReq method.

GADGET_VIEW_CHANGED_EVENT
Topic for listening to gadget view changed events. The provided callback will be invoked when a gadget changes view. The callback will be passed a finesse.containerservices.GadgetViewChangedEvent.

MAX_AVAILABLE_HEIGHT_CHANGED_EVENT
Topic for listening to max available height changed events. The provided callback will be invoked when the maximum height available to a maximized gadget changes. This event is only meant for maximized gadgets and will not be published unless a maximized gadget exists. The callback will be passed a finesse.containerservices.MaxAvailableHeightChangedEvent.

RELOAD_GADGET_EVENT
Topic for Reload Gadget events traffic. Only the master ContainerServices instance will handle this event.

TIMER_TICK_EVENT
Topic for Timer Tick event. The provided callback will be invoked when this event is fired. The callback will be passed a finesse.containerservices.TimerTickEvent.

WORKFLOW_ACTION_EVENT
Topic for WorkflowAction events traffic. The provided callback will be invoked when a WorkflowAction needs to be handled. The callback will be passed a finesse.containerservices.WorkflowActionEvent that can be used to interrogate the WorkflowAction and determine to use or not.

Documentation generated by JsDoc Toolkit 2.3.2 on Mon Nov 06 2017 08:00:55 GMT-0500 (EST)