Skip navigation links

oracle.adf.view.rich.component.rich
Class RichPopup

java.lang.Object
javax.faces.component.UIComponent
org.apache.myfaces.trinidad.component.UIXComponent
org.apache.myfaces.trinidad.component.UIXComponentBase
oracle.adf.view.rich.component.PartialUIXPopup
oracle.adf.view.rich.component.UIXPopup
oracle.adf.view.rich.component.rich.PartialRichPopup
oracle.adf.view.rich.component.rich.RichPopup

All Implemented Interfaces:

EventListener, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder

public class RichPopup

extends PartialRichPopup

Popup component.

Version:

$Name: $ ($Revision: /main/3 $) $Date: 2013/03/29 13:10:48 $

Author:

The Oracle ADF Faces Team

Nested Class Summary

static interface	RichPopup.PopupContextCallback Marker interface applied to the ContextCallabck for invokeOnComponent.
static class	RichPopup.PopupHints Server-side representation of popup hints passed to the RichPopup's show method.

Field Summary

static org.apache.myfaces.trinidad.bean.FacesBean.Type

TYPE

Fields inherited from class oracle.adf.view.rich.component.rich.PartialRichPopup

ANIMATE_DEFAULT, ANIMATE_FALSE, ANIMATE_KEY, AUTO_CANCEL_DISABLED, AUTO_CANCEL_ENABLED, AUTO_CANCEL_KEY, CHILD_CREATION_DEFERRED, CHILD_CREATION_IMMEDIATE, CHILD_CREATION_KEY, CLIENT_ATTRIBUTES_KEY, CLIENT_COMPONENT_KEY, CLIENT_LISTENERS_KEY, COMPONENT_FAMILY, COMPONENT_TYPE, CONTENT_DELIVERY_IMMEDIATE, CONTENT_DELIVERY_KEY, CONTENT_DELIVERY_LAZY, CONTENT_DELIVERY_LAZY_UNCACHED, CUSTOMIZATION_ID_KEY, EVENT_CONTEXT_KEY, EVENT_CONTEXT_LAUNCHER, EVENT_CONTEXT_SELF, LAUNCHER_VAR_KEY, PARTIAL_TRIGGERS_KEY, POPUP_CANCELED_LISTENER_KEY, POPUP_FETCH_LISTENER_KEY, RESET_EDITABLE_VALUES_KEY, RESET_EDITABLE_VALUES_NEVER, RESET_EDITABLE_VALUES_WHEN_CANCELED, VISIBLE_KEY

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

ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY

Constructor Summary

	RichPopup() Construct an instance of the RichPopup.
protected	RichPopup(String rendererType) Construct an instance of the RichPopup.

Method Summary

void	broadcast(javax.faces.event.FacesEvent event)
void	cancel() Hides the popup component and queues the (@link oracle.adf.view.rich.event.PopupCanceledEvent} pending completion of the JSF lifecycle.
static boolean	captureFetchRequest(javax.faces.context.FacesContext context, RichPopup popup) Called at JSP tag and Facelets handler execution time to save the client id as a scope indicator.
protected org.apache.myfaces.trinidad.bean.FacesBean.Type	getBeanType()
javax.faces.component.UIComponent	getParent()
void	hide() Hides the popup component pending completion of the JSF lifecycle.
static boolean	isFetchRequest(javax.faces.context.FacesContext context, org.apache.myfaces.trinidad.bean.FacesBean bean, String clientId) Called form the render phase of the popup to determine if the popup has queued a fetch event for a stamped instance during this request/reponse.
static void	markFetchRequest(javax.faces.context.FacesContext context, RichPopup popup) Called immediately after queuing a popup fetch event to mark a stamped instance of a popup as having queued a popup event.
void	queueEvent(javax.faces.event.FacesEvent event)
void	show(RichPopup.PopupHints hints) Causes the popup to be shown on the client pending completion of the JSF lifecycle.

Methods inherited from class oracle.adf.view.rich.component.rich.PartialRichPopup

addClientBehavior, addPopupCanceledListener, addPopupFetchListener, getAnimate, getAutoCancel, getChildCreation, getClientAttributes, getClientBehaviors, getClientListeners, getContentDelivery, getCustomizationId, getDefaultEventName, getEventContext, getEventNames, getFamily, getLauncherVar, getPartialTriggers, getPopupCanceledListener, getPopupCanceledListeners, getPopupFetchListener, getPopupFetchListeners, getResetEditableValues, isClientComponent, isVisible, removePopupCanceledListener, removePopupFetchListener, setAnimate, setAutoCancel, setChildCreation, setClientAttributes, setClientComponent, setClientListeners, setContentDelivery, setCustomizationId, setEventContext, setLauncherVar, setPartialTriggers, setPopupCanceledListener, setPopupFetchListener, setResetEditableValues, setVisible

Methods inherited from class oracle.adf.view.rich.component.UIXPopup

processDecodes

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

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

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

addPartialTarget, clearCachedClientIds, clearCachedClientIds, encodeFlattenedChild, encodeFlattenedChildren, getLogicalParent, getLogicalParent, getStateHelper, getStateHelper, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setupChildrenEncodingContext, setupChildrenVisitingContext, setupEncodingContext, setUpEncodingContext, setupVisitingContext, tearDownChildrenEncodingContext, tearDownChildrenVisitingContext, tearDownEncodingContext, tearDownVisitingContext, visitAllChildren, visitChildren, visitChildren, visitTree, visitTree

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getResourceBundleMap, getTransientStateHelper, getTransientStateHelper, isCompositeComponent, isInView, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView

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

Constructor Detail

RichPopup

public RichPopup()

Construct an instance of the RichPopup.

RichPopup

protected RichPopup(String rendererType)

Construct an instance of the RichPopup.

Method Detail

getBeanType

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

Overrides:

getBeanType in class PartialRichPopup

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

Overrides:

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

show

public void show(RichPopup.PopupHints hints)

Causes the popup to be shown on the client pending completion of the JSF lifecycle. Use the RichPopup.PopupHints characteristics about how the popup is shown. The popup must also be in the right context when this method is invoked. Meaning that if the popup is within a UIData family component or another stamped component, the model must be positioned in order for this component's client id to be encoded with the correct context. If the show method is called before the render response phase, the popup's content will be delivered in the same request. Otherwise, the popup's content delivery will require a second trip to the server provided the content delivery is not immediate. Example:

 public void showPopup(ActionEvent event) 
 {
   UIComponent source = (UIComponent) event.getSource();
   RichPopup popup = this.getPopup();
   RichPopup.PopupHints hints = new RichPopup.PopupHints();
   hints.add(RichPopup.PopupHints.HintTypes.HINT_ALIGN_ID, source)
        .add(RichPopup.PopupHints.HintTypes.HINT_LAUNCH_ID, source)
        .add(RichPopup.PopupHints.HintTypes.HINT_ALIGN, RichPopup.PopupHints.AlignTypes.ALIGN_AFTER_END);
   popup.show(hints);  
 }
 

Parameters:

hints - defines characteristics about how the popup is shown

cancel

public void cancel()

Hides the popup component and queues the (@link oracle.adf.view.rich.event.PopupCanceledEvent} pending completion of the JSF lifecycle. The popup must also be in the right context when this method is invoked. Meaning that if the popup is within a UIData family component or another stamped component, the model must be positioned in order for this component's client id to be encoded with the correct context.

hide

public void hide()

Hides the popup component pending completion of the JSF lifecycle. The popup must also be in the right context when this method is invoked. Meaning that if the popup is within a UIData family component or another stamped component, the model must be positioned in order for this component's client id to be encoded with the correct context.

getParent

public javax.faces.component.UIComponent getParent()

Overrides:

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

captureFetchRequest

public static boolean captureFetchRequest(javax.faces.context.FacesContext context,
                                          RichPopup popup)

Called at JSP tag and Facelets handler execution time to save the client id as a scope indicator. This scope id is not stamped but is used similar the JSP tag's (JspIdConsumer interface) jspid. It is just a unique id used to create a request scope key. The function also tests to see if a PopupFetchEvent was queued during this request/response (applies to a postback).

Parameters:

context - faces context

popup - not in stamped context but at tag execution time

Returns:

true if PopupFetchEvent was queued during this request

markFetchRequest

public static void markFetchRequest(javax.faces.context.FacesContext context,
                                    RichPopup popup)

Called immediately after queuing a popup fetch event to mark a stamped instance of a popup as having queued a popup event. Normally the popup fetch client event is used to indicate during encoding but if the RichPopup.show method is called, there will not be a client event. Because the popup is not an editable value holder, its state is not saved per stamped instance.

Parameters:

context - faces context

popup - instance of the popup in (stamped) context

isFetchRequest

public static boolean isFetchRequest(javax.faces.context.FacesContext context,
                                     org.apache.myfaces.trinidad.bean.FacesBean bean,
                                     String clientId)

Called form the render phase of the popup to determine if the popup has queued a fetch event for a stamped instance during this request/reponse.

Parameters:

context - faces context

bean - popup state holder

clientId - id in (stamped) context

Returns:

true if the popup has queued a fetch event.

Skip navigation links