JavaScript API Reference for Oracle ADF Faces

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

oracle.adf.view.js.event
Class AdfCustomEvent

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.AdfCustomEvent

Direct Known Subclasses:

AdfDropEvent

public class AdfCustomEvent
extends AdfComponentEvent

Custom Event class

Field Summary

private Object	_immediate
private Object	_params
public Object	setPartial
public Object	setRoot

Fields inherited from oracle.adf.view.js.event.AdfComponentEvent

BLUR_EVENT_TYPE, FOCUS_EVENT_TYPE

Fields inherited from oracle.adf.view.js.event.AdfBaseEvent

AT_TARGET_PHASE, BUBBLING_PHASE, CAPTURING_PHASE

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

constructor, superclass

Fields inherited from org.ecmascript.object.Object

prototype

Constructor Summary

public

AdfCustomEvent(AdfUIComponent source, String type, Object params, Boolean immediate) Custom Event class

Method Summary

protected Object	AddMarshalledProperties(Object properties)
protected Object	GetParams() Returns the custom event's params Object
protected Object	Init(AdfUIComponent source, Object type, Object params, Object immediate) Initializes the instance.
public Object	isImmediate() Returns true if this event should only trigger validation of immediate fields.
public Object	propagatesToServer() Returns true if the this event should propagate to the server.
public static Object	queue(AdfUIComponent component, String type, Object params, Boolean immediate) Convenience function for queueing an Custom event from a component.
public Object	toDebugString()

Methods inherited from oracle.adf.view.js.event.AdfPhasedEvent

getCurrentTarget, getDoesBubbles, getEventPhase, isCancelable, nextEventPhase, setCurrentTarget

Methods inherited from oracle.adf.view.js.event.AdfBaseEvent

cancel, forceFullSubmit, getClearMessages, getProperties, getRoot, getShowMessages, getSource, getType, isBubblingStopped, isCanceled, IsDeleveryDiscrete, isFullSubmitForced, isPartial, isResponseAnnounced, isResponseExpected, IsUserInputPrevented, isValidationNeeded, noResponseExpected, preventUserInput, setPartial, setRoot, stopBubbling

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

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

Field Detail

_immediate

private Object _immediate

_params

private Object _params

setPartial

public Object setPartial

setRoot

public Object setRoot

Constructor Detail

AdfCustomEvent

public AdfCustomEvent(AdfUIComponent source,
String type,
Object params,
Boolean immediate)

Custom Event class

Parameters:

source	-	of the Custom event
type	-	the type of the event
params	-	a map of parameters to include on the event. Reserved parameter names are "type" and "immediate".
immediate	-	whether the custom event is "immediate" - which will cause it to be delivered during Apply Request Values on the server, or not immediate, in which case it will be delivered during Invoke Application.

Method Detail

AddMarshalledProperties

protected Object AddMarshalledProperties(Object properties)

Parameters:

properties

Return:

Object

Overrides:

AdfBaseEvent.AddMarshalledProperties(Object)

GetParams

protected Object GetParams()

Returns the custom event's params Object

Return:

Object - null

Init

protected Object Init(AdfUIComponent source,
Object type,
Object params,
Object immediate)

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

Parameters:

source	-	of the Custom event
type
params
immediate

Return:

Object

Overrides:

AdfObject.Init()

isImmediate

public Object isImmediate()

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

Return:

Object

Overrides:

AdfBaseEvent.isImmediate()

propagatesToServer

public Object propagatesToServer()

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

Return:

Object

Overrides:

AdfBaseEvent.propagatesToServer()

queue

public static Object queue(AdfUIComponent component,
String type,
Object params,
Boolean immediate)

Convenience function for queueing an Custom event from a component.

Parameters:

component	-	Component to queue the custom event on
type	-	the type of the event
params	-	a set of parameters to include on the event. Reserved parameter names include "type" and "immediate".
immediate	-	whether the custom event is "immediate" - which will cause it to be delivered during Apply Request Values on the server, or not immediate, in which case it will be delivered during Invoke Application.

Return:

Object

Overrides:

AdfComponentEvent.queue(Boolean)

toDebugString

public Object toDebugString()

Return:

Object

Overrides:

AdfObject.toDebugString()

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