JavaScript API Reference for Oracle ADF Faces
oracle.adf.view.js.event
Class AdfPopupCanceledEvent
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.AdfPopupCanceledEvent
public class AdfPopupCanceledEvent
extends AdfComponentEvent
This event is queued when a popup is unexpectedly closed or by invoking the cancel method on the AdfRichPopup component. This event has optimized delivery and will only propragate to the server if there are server-side listeners registered with the popup component. The event is also marked for discrete delivery. This event has an event root of the popup and will not clear any client messages.
Constructor Summary
|
public |
AdfPopupCanceledEvent(AdfRichPopup source, boolean resetEditableValues)
-
This event is queued when a popup is unexpectedly closed or by invoking the cancel method on the AdfRichPopup component.
|
Methods inherited from oracle.adf.view.js.event.AdfBaseEvent
|
cancel, forceFullSubmit, getMaxTimeBeforePropagation, getProperties, getRoot, getShowMessages, getSource, getType, isBubblingStopped, isCanceled, isDeliveryDiscrete, isFullSubmitForced, 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 |
private static Object _OPTIMIZED_PROPAGATION_PROPERTY
public static Object POPUP_CANCELED_EVENT_TYPE
private Object _resetEditableValues
public Object setRoot
public AdfPopupCanceledEvent(AdfRichPopup source,
boolean resetEditableValues)
This event is queued when a popup is unexpectedly closed or by invoking the cancel method on the AdfRichPopup component. This event has optimized delivery and will only propragate to the server if there are server-side listeners registered with the popup component. The event is also marked for discrete delivery. This event has an event root of the popup and will not clear any client messages.
- Parameters:
-
source |
- |
popup component |
resetEditableValues |
- |
true if the canceled event should reset input values within the popup's content |
protected Object AddMarshalledProperties(map properties)
Adds the resetEditableValues
if activated as a property sent to the server.
- Parameters:
-
properties |
- |
marshalled to the server |
- Return:
Object
- Overrides:
AdfBaseEvent.AddMarshalledProperties(Object)
public boolean getClearMessages()
By default page level messages are cleared (before new messages added) when returning from the server. Subclasses should return false
from this method if page level messages should not be cleared. This method returns true
if the property propagatesToServer
is true else returns false
. Messages will still be cleared unless all the queued client events return false from this method.
- Return:
boolean
- prevents all faces messages from gettting cleared after processing this event server-side
- Overrides:
AdfBaseEvent.getClearMessages()
protected Object Init(AdfRichPopup source,
boolean resetEditableValues)
Initializes the instance. Subclasses of AdfObject must call their superclass' Init
- Parameters:
-
source |
- |
popup component |
resetEditableValues |
- |
true if the canceled event should reset input values within the popup's content |
- Return:
Object
- Overrides:
AdfObject.Init()
protected Boolean IsDeleveryDiscrete()
- Return:
Boolean
- null true
indicating event should be delivered to the server by itself after all other events have been processed.
- Overrides:
AdfBaseEvent.IsDeleveryDiscrete()
public Boolean isImmediate()
Returns true
if this event should only trigger validation of immediate fields.
- Return:
Boolean
- null true
indicating this event should be handled in the apply request values phase.
- Overrides:
AdfBaseEvent.isImmediate()
public boolean isResetEditableValues()
- Return:
boolean
- null true
if processing this event server-side should result in resetting input components within the popup's content.
public Boolean propagatesToServer()
Returns true
if the this event should propagate to the server.
- Return:
Boolean
- null true
if the this event should propagate to the server. The return value depends on if there are server-side listeners registered for this event type or, if the event should result in resetting input component's values.
- See also:
- "#isResetInputValues"
- Overrides:
AdfBaseEvent.propagatesToServer()
Generated on 2014.03.27 12:59 UTC
Copyright (c) 1998, 2014, Oracle and/or its affiliates. All rights reserved.