JavaScript API Reference for Oracle ADF Faces

oracle.adfinternal.view.js.event
Class AdfDialogServicePopupContainerRemoveEvent

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.adfinternal.view.js.event.AdfDialogServicePopupContainerRemoveEvent

public class AdfDialogServicePopupContainerRemoveEvent
extends AdfComponentEvent

_contentHeight

private Object _contentHeight

_contentWidth

private Object _contentWidth

_launchId

private Object _launchId

_popupId

private Object _popupId

REMOVE_EVENT_TYPE

public static Object REMOVE_EVENT_TYPE

Constant used to identify the event type of popupRemove.

setRoot

public Object setRoot

AdfDialogServicePopupContainerRemoveEvent

public AdfDialogServicePopupContainerRemoveEvent(Object source,
                                                 String popupId,
                                                 Number contentWidth,
                                                 Number contentHeight,
                                                 String launchId)

This event is invoked by the AdfDhtmlDialogServicePopupContainerPeer when a child AdfRichPopup is closed and should be removed from the component tree. The event will propagate to the server with discrete delivery. The event root will be set to the source, an instance of AdfDialogServicePopupContainer and will not clear all faces messages on return.

Parameters:

source
popupId	-	client id of a child popup that was dismissed.
contentWidth	-	width of the panelWindow content if manually resized Default value = null
contentHeight	-	height of the panelWindow content if manually resized Default value = null
launchId	-	command family component that launched the dialog

AddMarshalledProperties

protected void AddMarshalledProperties(Object properties)

Adds the popupId as a property that will be delivered to the server.

Parameters:

properties

-

a map to be sent to the server

Return:

void - null

Overrides:

AdfBaseEvent.AddMarshalledProperties(Object)

getClearMessages

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

getPopupId

public String getPopupId()

Return:

String - client id of the AdfRichPopup closed and getting removed from the component tree.

Init

protected void Init(AdfDialogServicePopupContainer source,
                    Object popupId,
                    Number contentWidth,
                    Number contentHeight,
                    String launchId)

Tucks-away the popupId before delegating on to the super.

Parameters:

source	-	internal private component
popupId
contentWidth	-	width of the panelWindow content if manually resized
contentHeight	-	height of the panelWindow content if manually resized
launchId	-	command family component that launched the inline dialog

Return:

void - null

Overrides:

AdfObject.Init()

isCancelable

public Boolean isCancelable()

Returns true if the calling cancel() on the event will prevent the event's default action from being performed.

Return:

Boolean - null false indicating this event can not be cancled on the client.

Overrides:

AdfBaseEvent.isCancelable()

IsDeleveryDiscrete

protected Boolean IsDeleveryDiscrete()

Return:

Boolean - null true indicating that the event will be sent to the server after all other events with greater priority are processed.

Overrides:

AdfBaseEvent.IsDeleveryDiscrete()

propagatesToServer

public Boolean propagatesToServer()

Returns true if the this event should propagate to the server.

Return:

Boolean - null true indicating this event will be sent to the server.

Overrides:

AdfBaseEvent.propagatesToServer()

queue

public static void queue(AdfDialogServicePopupContainer component,
                         String popupId,
                         Number contentWidth,
                         Number contentHeight,
                         String launchId)

Instantiates this event and queues it to be delivered to the corresponding server side component.

Parameters:

component	-	internal popup container
popupId	-	client id of the AdfRichPopup that should be removed from the component tree.
contentWidth	-	width of the panelWindow content if manually resized Default value = null
contentHeight	-	height of the panelWindow content if manually resized Default value = null
launchId	-	command family components id that launched the inline popup dialog

Return:

void - null

Overrides:

AdfComponentEvent.queue(Boolean)