JavaScript API Reference for Oracle ADF Faces

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

oracle.adf.view.js.event
Class AdfDialogEvent

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

public class AdfDialogEvent
extends AdfComponentEvent

The client event for the AdfRichDialog. This event is use to communicate actions on the pre-configured dialog buttons or actions that cancel the dialog such as the Esc key or close icon in the title bar. This event has an outcome property that will indicate the originator of the event. The outcome property will be one if the following values:

• OUTCOME_OK - OK button was selected. The AdfRichDialog type must be ok or okCancel for the OK button to be visible.
• OUTCOME_YES - Yes button was selected. The AdfRichDialog type must be yesNo or yesNoCancel for the Yes button to be visible.
• OUTCOME_NO - No button was selected. The AdfRichDialog type must be yesNo or yesNoCancel for the No button to be visible.
• OUTCOME_CANCEL - Cancel button, Esc key, or close icon selected. The Cancel button will only be visible when the type property of the AdfRichDialog is cancel, okCancel or yesNoCancel.

This event propagates to the server for all outcomes except OUTCOME_CANCEL. This event is also a partial submit.

Field Summary

public static Object	EVENT_TYPE Constant that represents the event type.
public Object	isValidationNeeded
private Object	_outcome
public static Object	OUTCOME_CANCEL Cancel button, Esc key, or close icon selected.
public static Object	OUTCOME_NO No button was selected.
public static Object	OUTCOME_OK OK button was selected.
public static Object	OUTCOME_YES Yes button was selected.
public Object	setPartial

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

BLUR_EVENT_TYPE, CONTEXT_MENU_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

AdfDialogEvent(AdfRichDialog source, String outcome) The client event for the {@link AdfRichDialog}.

Method Summary

protected Object	AddMarshalledProperties(Object properties) Adds the outcome event property to be sent to the server.
public String	getOutcome() The outcome property that will indicate the originator of the event.
protected void	Init(AdfRichDialog source, String outcome) Initializes the instance.
public boolean	propagatesToServer() By default, the event get propagated to the server, except when the outcome is {@link AdfDialogEvent#OUTCOME_CANCEL}.

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

queue

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

getCurrentTarget, getDoesBubbles, getEventPhase, isCancelable, nextEventPhase, setCurrentTarget, toDebugString

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

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

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

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

Field Detail

EVENT_TYPE

public static Object EVENT_TYPE

Constant that represents the event type.

isValidationNeeded

public Object isValidationNeeded

See also:

propagatesToServer()

_outcome

private Object _outcome

OUTCOME_CANCEL

public static Object OUTCOME_CANCEL

Cancel button, Esc key, or close icon selected. The Cancel button will only be visible when the type property of the AdfRichDialog is cancel, okCancel or yesNoCancel. This event will not propagates to the server for this outcome.

OUTCOME_NO

public static Object OUTCOME_NO

No button was selected. The AdfRichDialog type must be yesNo or yesNoCancel for the No button to be visible.

OUTCOME_OK

public static Object OUTCOME_OK

OK button was selected. The AdfRichDialog type must be ok or okCancel for the OK button to be visible.

OUTCOME_YES

public static Object OUTCOME_YES

Yes button was selected. The AdfRichDialog type must be yesNo or yesNoCancel for the Yes button to be visible.

setPartial

public Object setPartial

Constructor Detail

AdfDialogEvent

public AdfDialogEvent(AdfRichDialog source,
String outcome)

The client event for the AdfRichDialog. This event is use to communicate actions on the pre-configured dialog buttons or actions that cancel the dialog such as the Esc key or close icon in the title bar. This event has an outcome property that will indicate the originator of the event. The outcome property will be one if the following values:

• OUTCOME_OK - OK button was selected. The AdfRichDialog type must be ok or okCancel for the OK button to be visible.
• OUTCOME_YES - Yes button was selected. The AdfRichDialog type must be yesNo or yesNoCancel for the Yes button to be visible.
• OUTCOME_NO - No button was selected. The AdfRichDialog type must be yesNo or yesNoCancel for the No button to be visible.
• OUTCOME_CANCEL - Cancel button, Esc key, or close icon selected. The Cancel button will only be visible when the type property of the AdfRichDialog is cancel, okCancel or yesNoCancel.

This event propagates to the server for all outcomes except OUTCOME_CANCEL. This event is also a partial submit.

Parameters:

source	-	target dialog component
outcome	-	literal constant that indicates the originator of the event

Method Detail

AddMarshalledProperties

protected Object AddMarshalledProperties(Object properties)

Adds the outcome event property to be sent to the server.

Parameters:

properties

Return:

Object

Overrides:

AdfBaseEvent.AddMarshalledProperties(Object)

getOutcome

public String getOutcome()

The outcome property that will indicate the originator of the event. The outcome property will be one if the following values:

• OUTCOME_OK - OK button was selected. The AdfRichDialog type must be ok or okCancel for the OK button to be visible.
• OUTCOME_YES - Yes button was selected. The AdfRichDialog type must be yesNo or yesNoCancel for the Yes button to be visible.
• OUTCOME_NO - No button was selected. The AdfRichDialog type must be yesNo or yesNoCancel for the No button to be visible.
• OUTCOME_CANCEL - Cancel button, Esc key, or close icon selected. The Cancel button will only be visible when the type property of the AdfRichDialog is cancel, okCancel or yesNoCancel.

Return:

String - one of 4 possible enumerations.

Init

protected void Init(AdfRichDialog source,
String outcome)

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

Parameters:

source	-	target component
outcome	-	literal constant that indicates the originator of the event

Return:

void - null

Overrides:

AdfObject.Init()

propagatesToServer

public boolean propagatesToServer()

By default, the event get propagated to the server, except when the outcome is OUTCOME_CANCEL.

Return:

boolean - null false if the outcome is OUTCOME_CANCEL

Overrides:

AdfBaseEvent.propagatesToServer()

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