Namespace actuate.viewer.EventConstants

The class EventConstants defines constants for viewer events.
Member of: actuate.viewer.

Namespace Summary
Constructor Attributes	Constructor Name and Description
	actuate.viewer.EventConstants The class EventConstants defines constants for viewer events.

Field Summary
Field Attributes	Field Name and Description
<static> <constant>	ON_CONTENT_CHANGED Content changed event, which is fired whenever the displayed content has changed, for example when changing pages.
<static> <constant>	ON_CONTENT_SELECTED Content selected event, which is fired whenever the user selects supported report elements.
<static> <constant>	ON_EXCEPTION Exception event, which is fired whenever an exception occurs during an asynchronous operation.
<static> <constant>	ON_SESSION_TIMEOUT Session timeout event.

Namespace Detail

actuate.viewer.EventConstants

The class EventConstants defines constants for viewer events.

See:: actuate.Viewer

Field Detail

<static> <constant> {String} ON_CONTENT_CHANGED

Content changed event, which is fired whenever the displayed content has changed, for example when changing pages.
The event handler takes the following arguments:

actuate.Viewer: viewer for which the event occurred

See:: actuate.Viewer

<static> <constant> {String} ON_CONTENT_SELECTED

Content selected event, which is fired whenever the user selects supported report elements. Supported selected contents are:

Column
Table
Data
Label
Text

The event handler takes the following arguments:

actuate.Viewer: viewer for which the event occurred
actuate.viewer.SelectedContent: selected content object

See:: actuate.Viewer; actuate.viewer.SelectedContent

<static> <constant> {String} ON_EXCEPTION

Exception event, which is fired whenever an exception occurs during an asynchronous operation.
The event handler takes the following arguments:

actuate.Viewer: viewer for which the event occurred
actuate.Exception: exception object

See:: actuate.Viewer; actuate.Exception; actuate.viewer.ViewerException

<static> <constant> {String} ON_SESSION_TIMEOUT

Session timeout event. Whenever a session timeout event occurs and the user tries to perform any operation on a viewer, a prompt dialog will be shown to ask whether the user wants to login again or not. If the user clicks yes, the ON_SESSION_TIMEOUT event will be fired. If no handler has been registered for this event, a default built-in login dialog will be displayed.
The event handler takes the following arguments:

actuate.Viewer: viewer for which the event occurred

Note that this behavior and event is only available if the "SessionReloginTimeout" flag is set to true in the server configuration from which the API was initialized.

See:: actuate.Viewer

Classes

Namespace actuate.viewer.EventConstants