Skip navigation links

oracle.adf.view.rich.component
Class UIXDialog

java.lang.Object
javax.faces.component.UIComponent
org.apache.myfaces.trinidad.component.UIXComponent
org.apache.myfaces.trinidad.component.UIXComponentBase
oracle.adf.view.rich.component.UIXDialog

All Implemented Interfaces:

javax.faces.component.StateHolder

Direct Known Subclasses:

RichDialog

public class UIXDialog

extends org.apache.myfaces.trinidad.component.UIXComponentBase

A UIXDialog component is an abstraction for a container component that can deliver DialogEvents, which indicate that an action has occurred in the dialog.

Events:

Type	Phases	Description
oracle.adf.view.rich.event.DialogEvent	Invoke Application	The dialog event is delivered when a dialog is triggered.
org.apache.myfaces.trinidad.event.AttributeChangeEvent	Invoke Application Apply Request Values	Event delivered to describe an attribute change. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.

Field Summary

static java.lang.String	COMPONENT_FAMILY
static java.lang.String	COMPONENT_TYPE
static org.apache.myfaces.trinidad.bean.PropertyKey	DIALOG_LISTENER_KEY
static org.apache.myfaces.trinidad.bean.FacesBean.Type	TYPE

Fields inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase

BINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY

Fields inherited from class javax.faces.component.UIComponent

bindings

Constructor Summary

	UIXDialog() Construct an instance of the UIXDialog.
protected	UIXDialog(java.lang.String rendererType) Construct an instance of the UIXDialog.

Method Summary

void	addDialogListener(DialogListener listener) Adds a dialog listener.
void	broadcast(javax.faces.event.FacesEvent event)
protected org.apache.myfaces.trinidad.bean.FacesBean.Type	getBeanType()
javax.el.MethodExpression	getDialogListener() Gets a method reference to a dialog listener method
DialogListener[]	getDialogListeners() Returns an array of attached dialog listeners.
java.lang.String	getFamily()
protected void	processDismissal(javax.faces.event.FacesEvent event) Handles auto-dismissal of the pre-configured dialog buttons.
void	queueEvent(javax.faces.event.FacesEvent e)
void	removeDialogListener(DialogListener listener) Removes a dialog listener.
void	setDialogListener(javax.faces.el.MethodBinding binding) Deprecated.
void	setDialogListener(javax.el.MethodExpression dialogListener) Sets a method reference to a dialog listener method

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase

adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addFacesListener, broadcastToMethodBinding, broadcastToMethodExpression, createFacesBean, decode, decodeChildren, decodeChildrenImpl, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getContainerClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getParent, getProperty, getPropertyKey, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, invokeOnChildrenComponents, invokeOnComponent, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, removeAttributeChangeListener, removeFacesListener, restoreState, satisfiesPartialTrigger, saveState, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setValueBinding, setValueExpression, toString, updateChildren, updateChildrenImpl, validateChildren, validateChildrenImpl

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponent

addPartialTarget, encodeFlattenedChild, encodeFlattenedChildren, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setUpEncodingContext, setupVisitingContext, tearDownEncodingContext, tearDownVisitingContext, visitTree, visitTree

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getContainerClientId

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

TYPE

public static final org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE

DIALOG_LISTENER_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey DIALOG_LISTENER_KEY

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY

See Also:

Constant Field Values

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

Constructor Detail

UIXDialog

public UIXDialog()

Construct an instance of the UIXDialog.

UIXDialog

protected UIXDialog(java.lang.String rendererType)

Construct an instance of the UIXDialog.

Method Detail

setDialogListener

@Deprecated
public void setDialogListener(javax.faces.el.MethodBinding binding)

Deprecated.

broadcast

public void broadcast(javax.faces.event.FacesEvent event)
               throws javax.faces.event.AbortProcessingException

Overrides:

broadcast in class org.apache.myfaces.trinidad.component.UIXComponentBase

Throws:

javax.faces.event.AbortProcessingException

queueEvent

public void queueEvent(javax.faces.event.FacesEvent e)

Overrides:

queueEvent in class org.apache.myfaces.trinidad.component.UIXComponentBase

processDismissal

protected void processDismissal(javax.faces.event.FacesEvent event)

Handles auto-dismissal of the pre-configured dialog buttons. If the immediate parent of the dialog is a popup with autoCancel "disabled", handle dismissal server side. This direct dismissal will distinguish handling a dialog event over a PPR dom replacement that causes the popup to be restored.

Parameters:

event - dialog event

getDialogListener

public final javax.el.MethodExpression getDialogListener()

Gets a method reference to a dialog listener method

Returns:

the new dialogListener value

setDialogListener

public final void setDialogListener(javax.el.MethodExpression dialogListener)

Sets a method reference to a dialog listener method

Parameters:

dialogListener - the new dialogListener value

addDialogListener

public final void addDialogListener(DialogListener listener)

Adds a dialog listener.

Parameters:

listener - the dialog listener to add

removeDialogListener

public final void removeDialogListener(DialogListener listener)

Removes a dialog listener.

Parameters:

listener - the dialog listener to remove

getDialogListeners

public final DialogListener[] getDialogListeners()

Returns an array of attached dialog listeners.

Returns:

an array of attached dialog listeners.

getFamily

public java.lang.String getFamily()

Specified by:

getFamily in class org.apache.myfaces.trinidad.component.UIXComponentBase

getBeanType

protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()

Overrides:

getBeanType in class org.apache.myfaces.trinidad.component.UIXComponentBase

Skip navigation links