JavaScript API Reference for Oracle ADF Faces

oracle.adfinternal.view.js.laf.dhtml.rich
Class AdfPollHelper

org.ecmascript.object.Object
   |
   +--oracle.adf.view.js.base.AdfObject
         |
         +--oracle.adfinternal.view.js.laf.dhtml.rich.AdfPollHelper

public class AdfPollHelper
extends AdfObject

_componentIDsArray

private Object _componentIDsArray

_globalTimeoutInterval

private Object _globalTimeoutInterval

AdfPollHelper

public AdfPollHelper()

_applyPollTimeoutStyle

private Object _applyPollTimeoutStyle()

Callback function to apply the "poll timeout" style to all components that were updated by the LAST poll, before the <af:poll> component timed out, due to user inactivity.

Return:

Object

_calculatePollingTimeoutInterval

private Object _calculatePollingTimeoutInterval(Object interval)

+ * Calculates the global "timeout interval" for the af:poll components. + + *

Parameters:

interval

-

the amount of time (in ms) after which the polling + * components should timeout, as specified in web.xml file. +

Return:

Object

_createPollingTimeoutLayerElement

private HTMLElement _createPollingTimeoutLayerElement(HTMLElement element)

Helper function which creates a (simple) layer/DIV element to be placed ontop of those components that are no longer being updated, once the <af:poll> component has been "timed out".

Parameters:

element

-

Root DOM Element of the ADF component, which needs a layer on top.

Return:

HTMLElement - Returns the newly created HTML (layer) element.

_forcePollingComponentStop

private Object _forcePollingComponentStop()

Callback function which forces all <af:poll> components to stop sending polling requests down to the server since they timed out, due to user inactivity.

Return:

Object

Init

protected Object Init()

Create an instance of an AdfPollHelper

Return:

Object

Overrides:

AdfObject.Init()

InitClass

protected static Object InitClass()

Initializes the AdfPollHelper class

Return:

Object

initializePollingTimeout

public Object initializePollingTimeout(Object interval)

Triggers the calculation of the global timeout interval of the embedding PAGE and schedules the timeout callback, if needed

Parameters:

interval

-

the timeout interval, as specified in the web.xml

Return:

Object

isPollingTimeout

public boolean isPollingTimeout()

Helper method to request the "state" of the polling timeout interval

Return:

boolean - true if the polling has timed out

_isPollingTimeout

private boolean _isPollingTimeout()

Helper method to request the "state" of the polling timeout interval

Return:

boolean - true if the polling has timed out

registerPollComponent

public Object registerPollComponent(Object component)

Hook for the PollPeer to register its component to keep track of its ID and timeout value.

Parameters:

component

Return:

Object

_removePollingTimeoutLayer

private Object _removePollingTimeoutLayer()

Removes the "polling timeout layer" HTML elements and removes the "polling timeout" styles from those components that are no longer updated, once the polling times out.

Return:

Object

_rescheduleOrScheduleTimerIfNeeded

private Object _rescheduleOrScheduleTimerIfNeeded()

Helper function to cancel and reschedule the timer callback.

Return:

Object

_resetPollingTimeoutHandler

private Object _resetPollingTimeoutHandler(Object event)

If needed this function (called by _redistribute()) resets the timeout interval

Parameters:

event

Return:

Object

unregisterPollComponent

public Object unregisterPollComponent(Object component)

Called by the ComponentRemoved of the Peer to trigger the unregister of the removed component. We remove the clientID and regenerate the 'per page' valid timeout interval

Parameters:

component

Return:

Object