JavaScript API Reference for Oracle ADF Faces

oracle.adf.view.js.event
Class AdfDisplayChangeEvent

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

public class AdfDisplayChangeEvent
extends AdfComponentEvent

EVENT_TYPE

public static Object EVENT_TYPE

NAVIGATE_DIRECTION_BACKWARD

public static Object NAVIGATE_DIRECTION_BACKWARD

NAVIGATE_DIRECTION_FORWARD

public static Object NAVIGATE_DIRECTION_FORWARD

Constants to determine whether the next or previous sibling of current displayed child is to be displayed. These constants are LTR/RTL oblivious and indicate the sibling selection per natural ordering.

_navigateDirection

private Object _navigateDirection

AdfDisplayChangeEvent

public AdfDisplayChangeEvent(AdfUIComponent source,
                             String navigateDirection)

Event class to support display child change. This event is currently used by af:deck component and can be used for similar usecases by other components in future.

Parameters:

source	-	the component on which the event is to be queued
navigateDirection	-	Either AdfDisplayChangeEvent.NAVIGATE_DIRECTION_FORWARD or AdfDisplayChangeEvent.NAVIGATE_DIRECTION_BACKWARD to indicate the user action to load the next or previous child respectively

AddMarshalledProperties

protected Object AddMarshalledProperties(Object properties)

Parameters:

properties

Return:

Object

Overrides:

AdfBaseEvent.AddMarshalledProperties(Object)

getClearMessages

public boolean getClearMessages()

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

getNavigateDirection

public Object getNavigateDirection()

Gets the direction of navigation to load the next/previous child of the source component

Return:

Object

Init

protected Object Init(Object source,
                      Object navigateDirection)

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

Parameters:

source
navigateDirection

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 AdfDisplayChangeEvent queue(Object component,
                                          String navigateDirection,
                                          Boolean isPartial)

Convenience function for queueing an AdfDisplayChangeEvent from a component.

Parameters:

component
navigateDirection	-	Either AdfDisplayChangeEvent.NAVIGATE_DIRECTION_FORWARD or AdfDisplayChangeEvent.NAVIGATE_DIRECTION_BACKWARD to indicate the user action to load the next or previous child respectively
isPartial	-	true if the event needs to result in partial submit

Return:

AdfDisplayChangeEvent - the event instance that was queued

Overrides:

AdfComponentEvent.queue(Boolean)