JavaScript API Reference for Oracle ADF Faces

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

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

public class AdfServerEventQueue
extends AdfObject

_discreteEventQueue

private Object _discreteEventQueue

_noResponseEventQueue

private Object _noResponseEventQueue

_serverEventQueue

private Object _serverEventQueue

AdfServerEventQueue

public AdfServerEventQueue()

Implementation of the server event queue for AdfDhtmlPage

_getMinimumTimeoutForDelivery

private Number _getMinimumTimeoutForDelivery()

Determines the minimum time interval when one of the events in the queue should be delivered. Returning 0 indicates that there are events to deliver now

Return:

Number - the timeout or -1 if no events are waiting to be delivered within a certain time

getWaitingTimeout

public Number getWaitingTimeout()

Retrieves the minimum timeout of the events in the queue that are waiting to be delivered within a certain time

Return:

Number - the timeout or -1 if no events are waiting to be delivered within a certain time

hasEventsToDeliver

public Boolean hasEventsToDeliver()

Return:

Boolean - null true if the queue contains any events that should be delivered at the time of calling.

Init

protected Object Init()

Initializes the instance. Subclasses of AdfObject must call their superclass' Init

Return:

Object

Overrides:

AdfObject.Init()

push

public Object push(AdfBaseEvent event)

Adds event to teh queue

Parameters:

event

Return:

Object

_scrubEvents

private static Object _scrubEvents(Array eventQueue,
                                   boolean needsUnwrapping)

As a pre-condition of sending queued events to the server, scrub the event queue for events that have a reference to a dead component - it may have been replaced via PPR. Try to re-find dead components. If that fails, it has been dropped and we need to remove the event from the server queue before committing to send a request to the server.

Parameters:

eventQueue	-	event queue to clean
needsUnwrapping	-	- true if the event objects were wrapped, and the event itself needs to be referenced as a '.event' property

Return:

Object

shiftEvents

public Array shiftEvents(Boolean hasNonEventPayload,
                         Boolean hasDeltas)

Retrieves and removes the events that can be delivered to the server Note that this method may return a non-empty array even if hasEventsToDeliver() returned false because it includes all events that may be delivered with the request including those whose MaxTimeBeforePropagation has not lapsed.

Parameters:

hasNonEventPayload	-	- true if non-event payload (excluding deltas) will be combined with the event
hasDeltas	-	- true if deltas will be combined with the event

Return:

Array - events

validate

public Object validate()

Ensures that the queue contains events fromc omponent sources that are still present on the page

Return:

Object