JavaScript API Reference for Oracle ADF Faces

oracle.adf.view.js.event
Class AdfValueChangeEvent

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

public class AdfValueChangeEvent
extends AdfComponentEvent

_autoSubmit

private Object _autoSubmit

_newValue

private Object _newValue

_oldValue

private Object _oldValue

setRoot

public Object setRoot

VALUE_CHANGE_TYPE

public static Object VALUE_CHANGE_TYPE

AdfValueChangeEvent

public AdfValueChangeEvent(Object source,
                           Object oldValue,
                           Object newValue,
                           Object autoSubmit)

Parameters:

source
oldValue
newValue
autoSubmit

AddMarshalledProperties

protected Object AddMarshalledProperties(Object properties)

Parameters:

properties

Return:

Object

Overrides:

AdfBaseEvent.AddMarshalledProperties(Object)

getClearMessages

public Object getClearMessages()

Always clear messages.

Return:

Object

Overrides:

AdfBaseEvent.getClearMessages()

getMaxTimeBeforePropagation

public Number 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:

Number - maximum delay

See also:

propagatesToServer()

Overrides:

AdfBaseEvent.getMaxTimeBeforePropagation()

getNewValue

public Object getNewValue()

Return:

Object

getOldValue

public Object getOldValue()

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

Overrides:

AdfBaseEvent.getShowMessages()

Init

protected Object Init(Object source,
                      Object oldValue,
                      Object newValue,
                      Object autoSubmit)

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

Parameters:

source
oldValue
newValue
autoSubmit

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()

isValidationNeeded

public Object isValidationNeeded()

Returns true if this event should trigger validation.

Return:

Object

Overrides:

AdfBaseEvent.isValidationNeeded()

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(Object component,
                           Object oldValue,
                           Object newValue,
                           Object autoSubmit)

Convenience function for queueing an ValueChangeEvent

Parameters:

component
oldValue
newValue
autoSubmit

Return:

Object

Overrides:

AdfComponentEvent.queue(Boolean)

toDebugString

public Object toDebugString()

Return:

Object

Overrides:

AdfObject.toDebugString()