JavaScript API Reference for Oracle ADF Faces

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

_immediate

private Object _immediate

_isDiscrete

private Object _isDiscrete

_params

private Object _params

setPartial

public Object setPartial

setRoot

public Object setRoot

AdfCustomEvent

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

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.
discrete	-	if the event should be delivered to the server by itself after all other events have been processed.

AddMarshalledProperties

protected Object AddMarshalledProperties(Object properties)

Parameters:

properties

Return:

Object

Overrides:

AdfBaseEvent.AddMarshalledProperties(Object)

getMaxTimeBeforePropagation

public Object getMaxTimeBeforePropagation()

Retrives maximum delay in milliseconds before this event should be propagated to server. Returning -1 indicates that this event should only be propagated when a different event or a partial update request is sent to the server.

Return:

Object

See also:

setMaxTimeBeforePropagation(Object)

Overrides:

AdfBaseEvent.getMaxTimeBeforePropagation()

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,
                      Object discrete)

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

Parameters:

source	-	of the Custom event
type
params
immediate
discrete

Return:

Object

Overrides:

AdfObject.Init()

IsDeleveryDiscrete

protected Object IsDeleveryDiscrete()

Apparently overriding isDeliveryDiscrete causes regression

Return:

Object

See also:

IsDeleveryDiscrete()

Overrides:

AdfBaseEvent.IsDeleveryDiscrete()

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,
                           Object discrete)

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

Return:

Object

Overrides:

AdfComponentEvent.queue(Boolean)

setMaxTimeBeforePropagation

public Object setMaxTimeBeforePropagation(Object millis)

Specifies maximum delay in milliseconds before this event should be propagated to server. Passing -1 indicates that this event should only be propagated when a different event or a partial update request is sent to the server.

Parameters:

millis

Return:

Object

See also:

getMaxTimeBeforePropagation()

toDebugString

public Object toDebugString()

Return:

Object

Overrides:

AdfObject.toDebugString()