JavaScript API Reference for Oracle ADF Faces

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

oracle.adfinternal.view.js.event
Class AdfDialogServicePopupContainerRemoveEvent

Warning:

• This is an unsupported, internal implementation class.
• Use an API class that might provide equivalent functionality instead.
• This class will change without notice.
• It is not recommended that you use anything in this class.

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

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.

Field Summary

private Object	_contentHeight
private Object	_contentWidth
private Object	_popupId
public static Object	REMOVE_EVENT_TYPE Constant used to identify the event type of popupRemove.
public Object	setRoot

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

BLUR_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

AdfDialogServicePopupContainerRemoveEvent(Object source, string popupId, int contentWidth, int contentHeight) This event is invoked by the {@link AdfDhtmlDialogServicePopupContainerPeer} when a child {@link AdfRichPopup} is closed and should be removed from the component tree.

Method Summary

protected void	AddMarshalledProperties(map properties) Adds the popupId as a property that will be delivered to the server.
public boolean	getClearMessages() By default page level messages are cleared (before new messages added) when returning from the server.
public string	getPopupId()
protected void	Init(AdfDialogServicePopupContainer source, Object popupId, int contentWidth, int contentHeight) Tucks-away the popupId before delegating on to the super.
public boolean	isCancelable() Returns true if the calling cancel() on the event will prevent the event's default action from being performed.
protected boolean	IsDeleveryDiscrete()
public boolean	propagatesToServer() Returns true if the this event should propagate to the server.
public static void	queue(AdfDialogServicePopupContainer component, string popupId, int contentWidth, int contentHeight) Instantiates this event and queues it to be delivered to the corresponding server side component.

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

getCurrentTarget, getDoesBubbles, getEventPhase, nextEventPhase, setCurrentTarget, toDebugString

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

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

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

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

Field Detail

_contentHeight

private Object _contentHeight

_contentWidth

private Object _contentWidth

_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

Constructor Detail

AdfDialogServicePopupContainerRemoveEvent

public AdfDialogServicePopupContainerRemoveEvent(Object source,
string popupId,
int contentWidth,
int contentHeight)

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

Method Detail

AddMarshalledProperties

protected void AddMarshalledProperties(map properties)

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

Parameters:

properties

-

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 returns false from this method if page level messages should not be cleared. This method returns true by default. 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,
int contentWidth,
int contentHeight)

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

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,
int contentWidth,
int contentHeight)

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

Return:

void - null

Overrides:

AdfComponentEvent.queue(Boolean)

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