JavaScript API Reference for Oracle ADF Faces

SUMMARY: FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

oracle.adf.view.js.event
Class AdfBaseEvent

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

Direct Known Subclasses:

AdfBusyStateEvent, AdfPhasedEvent, AdfPropertyChangeEvent

public class AdfBaseEvent
extends AdfObject

Base Event class, modeled on DOM Level 2 Events. In general, most events will not be direct subclasses of AdfBaseEVent, but rather subclasses of AdfComponentEvent.

Field Summary

public static Number	AT_TARGET_PHASE Phase Constant for event delivery phase after the AdfBaseEvent.CAPTURING_PHASE, when the event is delivered to the target, before the AdfBaseEvent.BUBBLING_PHASE.
public static Number	BUBBLING_PHASE Phase Constant for event delivery phase after the AdfBaseEvent.AT_TARGET_PHASE, when events that can bubble, bubble back through the target's ancestors.
public static Number	CAPTURING_PHASE Phase Constant for event delivery phase when each parent of the event target is notified from most distant ancestor to nearest.
private Object	_source
private Object	_type

Fields inherited from oracle.adf.view.js.base.AdfObject

constructor, superclass

Fields inherited from org.ecmascript.object.Object

prototype

Constructor Summary

public

AdfBaseEvent() Base Event class, modeled on DOM Level 2 Events.

Method Summary

protected Object	AddMarshalledProperties(Object properties)
public Object	cancel() If the event is cancelable, calling this function will cancle the event, preventing any default handling from occurring.
public Object	forceFullSubmit() Specifies that the event must be delivered with a full page submit regardless of what isPartial() returns
public Object	getClearMessages() By default page level messages are cleared (before new messages added) when returning from the server.
public Object	getCurrentTarget() Returns the object whose listeners are currently being called.
public Object	getDoesBubbles()
public Number	getEventPhase() Returns the current event delivery phase that the event is being delivered in.
public Object	getProperties()
public Object	getRoot() Returns the root object for the event.
public Object	getShowMessages() By default page.showMessages() is called when returning from the server.
public Object	getSource() Returns the original source of the event, which will be different than the current target during the capture and bubbling phases.
public String	getType() Returns the type of event.
protected Object	Init(Object source, String type) Initializes the instance.
public Object	isBubblingStopped() Returns true if a stopBubbling() has been called on an event
public Object	isCancelable() Returns true if the calling cancel() on the event will prevent the event's default action from being performed.
public Object	isCanceled() Returns true if a cancel() has been called on a cancelable event.
protected Boolean	IsDeleveryDiscrete()
public Object	isFullSubmitForced() Returns true if the event must be delivered with a full page submit regardless of what isPartial() returns, false otherwise
public Boolean	isImmediate() Returns true if this event should only trigger validation of immediate fields.
public Object	isPartial() Returns true if the event should be a partial request, false if it should result in a full postback.
public Object	isResponseAnnounced() Indicates whether the response should be announced to assistive technology users.
public Object	isResponseExpected() Returns true if the event is expected to produce response handled by the framework, false otherwise
protected Boolean	IsUserInputPrevented()
public Boolean	isValidationNeeded() Returns true if this event should trigger validation.
public Object	noResponseExpected() Specifies that this event is not expected to produce a response handled by the framework, such as when export contents are streamed to Excel or when a file is downloaded.
public Object	preventUserInput() Calling this method prevents all user input while the event is being processed, including while the event is propagated to the server.
public Boolean	propagatesToServer() Returns true if the this event should propagate to the server.
public Object	setPartial(Object partial) Sets if the event should be a partial request.
public Object	setRoot(Object root) Returns the root object for the event.
public Object	stopBubbling() Cancels the current event from bubbling up the hierarchy of event handlers.
public Object	toDebugString()

Methods inherited from oracle.adf.view.js.base.AdfObject

adopt, clone, createCallback, createInitializedObject, createSubclass, ensureClassInitialization, equals, getClass, GetLazyArrayProperty, GetLazyMapProperty, getTypeName, toString

Field Detail

AT_TARGET_PHASE

public static Number AT_TARGET_PHASE

Phase Constant for event delivery phase after the AdfBaseEvent.CAPTURING_PHASE, when the event is delivered to the target, before the AdfBaseEvent.BUBBLING_PHASE. Canceling an event halts delivery.

See also:

getEventPhase()

CAPTURING_PHASE

BUBBLING_PHASE

BUBBLING_PHASE

public static Number BUBBLING_PHASE

Phase Constant for event delivery phase after the AdfBaseEvent.AT_TARGET_PHASE, when events that can bubble, bubble back through the target's ancestors. Canceling an event halts delivery.

See also:

getEventPhase()

CAPTURING_PHASE

AT_TARGET_PHASE

CAPTURING_PHASE

public static Number CAPTURING_PHASE

Phase Constant for event delivery phase when each parent of the event target is notified from most distant ancestor to nearest. Canceling an event halts delivery.

See also:

getEventPhase()

AT_TARGET_PHASE

BUBBLING_PHASE

_source

private Object _source

_type

private Object _type

Constructor Detail

AdfBaseEvent

public AdfBaseEvent()

Base Event class, modeled on DOM Level 2 Events. In general, most events will not be direct subclasses of AdfBaseEVent, but rather subclasses of AdfComponentEvent.

Method Detail

AddMarshalledProperties

protected Object AddMarshalledProperties(Object properties)

Parameters:

properties

Return:

Object

cancel

public Object cancel()

If the event is cancelable, calling this function will cancle the event, preventing any default handling from occurring. Once an event has been canceled, there is no way to uncancel the event.

Return:

Object

See also:

isCancelable()

isCanceled()

forceFullSubmit

public Object forceFullSubmit()

Specifies that the event must be delivered with a full page submit regardless of what isPartial() returns

Return:

Object

getClearMessages

public Object getClearMessages()

By default page level messages are cleared (before new messages added) when returning from the server. Subclasses should returns false from this method if page level messages should not be cleared. This method returns true by default. Messages will still be cleared unless all the queued client events return false from this method.

Return:

Object

getCurrentTarget

public Object getCurrentTarget()

Returns the object whose listeners are currently being called. This will be different than the source of the event during the capture and bubble phases.

Return:

Object - Object

getDoesBubbles

public Object getDoesBubbles()

Return:

Object

getEventPhase

public Number getEventPhase()

Returns the current event delivery phase that the event is being delivered in. One of AdfBaseEvent.CAPTURING_PHASE, AdfBaseEvent.AT_TARGET_PHASE, AdfBaseEvent.BUBBLING_PHASE.

Return:

Number - null

See also:

CAPTURING_PHASE

AT_TARGET_PHASE

BUBBLING_PHASE

getProperties

public Object getProperties()

Return:

Object

getRoot

public Object getRoot()

Returns the root object for the event. This will be undefined by default, but can be set to limit an event to a particular root - typically a subtree of components.

Return:

Object

getShowMessages

public Object getShowMessages()

By default page.showMessages() is called when returning from the server. Subclasses should return false from this method if calling page.showMessages() is not desired. This method returns true by default. Messages will still be shown unless all the queued client events return false from this method.

Return:

Object

getSource

public Object getSource()

Returns the original source of the event, which will be different than the current target during the capture and bubbling phases.

Return:

Object - Object

getType

public String getType()

Returns the type of event. This information can be used when sharing lsiteners among multiple event types to change the behavior of the listening logic.

Return:

String - null

Init

protected Object Init(Object source,
String type)

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

Parameters:

source
type

Return:

Object

Overrides:

AdfObject.Init()

isBubblingStopped

public Object isBubblingStopped()

Returns true if a stopBubbling() has been called on an event

Return:

Object

See also:

stopBubbling()

getDoesBubbles()

isCancelable

public Object isCancelable()

Returns true if the calling cancel() on the event will prevent the event's default action from being performed.

Return:

Object

See also:

isCanceled()

cancel()

isCanceled

public Object isCanceled()

Returns true if a cancel() has been called on a cancelable event.

Return:

Object

See also:

isCancelable()

cancel()

IsDeleveryDiscrete

protected Boolean IsDeleveryDiscrete()

Return:

Boolean - null true if the event should be delivered to the server by itself after all other events have been processed.

isFullSubmitForced

public Object isFullSubmitForced()

Returns true if the event must be delivered with a full page submit regardless of what isPartial() returns, false otherwise

Return:

Object

isImmediate

public Boolean isImmediate()

Returns true if this event should only trigger validation of immediate fields.

Return:

Boolean - null true if immediate

isPartial

public Object isPartial()

Returns true if the event should be a partial request, false if it should result in a full postback.

Return:

Object

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

isResponseExpected

public Object isResponseExpected()

Returns true if the event is expected to produce response handled by the framework, false otherwise

Return:

Object

IsUserInputPrevented

protected Boolean IsUserInputPrevented()

Return:

Boolean - null true if the blocking pane should be displayed

See also:

preventUserInput()

isValidationNeeded

public Boolean isValidationNeeded()

Returns true if this event should trigger validation.

Return:

Boolean - null true if validation should be triggered

noResponseExpected

public Object noResponseExpected()

Specifies that this event is not expected to produce a response handled by the framework, such as when export contents are streamed to Excel or when a file is downloaded.

Return:

Object

preventUserInput

public Object preventUserInput()

Calling this method prevents all user input while the event is being processed, including while the event is propagated to the server. The UI is automatically unblocked when processing for this event is complete. Ignores request for events that do not propagate to the server.

Return:

Object

See also:

isPartial()

propagatesToServer()

propagatesToServer

public Boolean propagatesToServer()

Returns true if the this event should propagate to the server.

Return:

Boolean - null true if this event should propagate to the server.

setPartial

public Object setPartial(Object partial)

Sets if the event should be a partial request.

Parameters:

partial

Return:

Object

setRoot

public Object setRoot(Object root)

Returns the root object for the event. This will be undefined by default, but can be set to limit an event to a particular root - typically a subtree of components.

Parameters:

root

Return:

Object

stopBubbling

public Object stopBubbling()

Cancels the current event from bubbling up the hierarchy of event handlers.

Return:

Object

See also:

getDoesBubbles()

isBubblingStopped()

toDebugString

public Object toDebugString()

Return:

Object

Overrides:

AdfObject.toDebugString()

SUMMARY: FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD