JavaScript API Reference for Oracle ADF Faces

oracle.adf.view.js.event
Class AdfPollEvent

org.ecmascript.object.Object
   |
   +--oracle.adf.view.js.base.AdfObject
         |
         +--oracle.adf.view.js.event.AdfBaseEvent
               |
               +--oracle.adf.view.js.event.AdfPhasedEvent
                     |
                     +--oracle.adf.view.js.event.AdfComponentEvent
                           |
                           +--oracle.adf.view.js.event.AdfPollEvent

public class AdfPollEvent
extends AdfComponentEvent

POLL_EVENT_TYPE

public static Object POLL_EVENT_TYPE

setPartial

public Object setPartial

AdfPollEvent

public AdfPollEvent(Object source)

Poll Event class

Parameters:

source

-

Source of the Poll event

getClearMessages

public boolean getClearMessages()

If the poll component has the immediate property turned on, return false indicating that messages should not be cleared as part of the response. If the request is immediate, it will bypass the validation phase so the messages should remain. Otherwise, messages are cleared because the validation phase is invoked.

Return:

boolean - true if messages should be cleared for the response.

Overrides:

AdfBaseEvent.getClearMessages()

Init

protected Object Init(Object source)

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

Parameters:

source

-

Source of the Poll event

Return:

Object

Overrides:

AdfObject.Init()

isResponseAnnounced

public Object isResponseAnnounced()

Indicates whether the response should be announced to assistive technology users. Some assistive technologies (eg. screen readers) do not provide sufficient notification of request/response activity, particularly for Ajax requests that are issued over XmlHttpRequest. ADF Faces attempts to compensate by using a WAI-ARIA live region to notify AT users when partial page responses complete. However, for certain types of repetitive requests, such as polling-related requests, an announcement upon completion of every request would be an annoyance. This method provides a mechanism for indicating that the response to the event should not be announced. Subclasses that wish to suppress announcement of response completion should override this method to return false.

Return:

Object

Overrides:

AdfBaseEvent.isResponseAnnounced()

propagatesToServer

public Boolean propagatesToServer()

Override to cause the event to propagate to the server.

Return:

Boolean - null true if the event should propagate to the server if not canceled

See also:

AdfBaseEvent.cancel()

AdfBaseEvent.isCancelable()

AdfBaseEvent.isCanceled()

Overrides:

AdfBaseEvent.propagatesToServer()

queue

public static Object queue(Object component)

Convenience function for queueing an Poll event from a component.

Parameters:

component

Return:

Object

Overrides:

AdfComponentEvent.queue(Boolean)