public class RichPopup extends PartialRichPopup
Modifier and Type | Class and Description |
---|---|
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. |
Modifier and Type | Field and Description |
---|---|
static String |
POPUP_REMOTE_FLAG_KEY |
static org.apache.myfaces.trinidad.bean.FacesBean.Type |
TYPE |
ANIMATE_DEFAULT, ANIMATE_FALSE, ANIMATE_KEY, ANIMATE_TRUE, 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
Modifier | Constructor and Description |
---|---|
|
RichPopup()
Construct an instance of the RichPopup.
|
protected |
RichPopup(String rendererType)
Construct an instance of the RichPopup.
|
Modifier and Type | Method and Description |
---|---|
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.
|
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
processDecodes
adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addComponentChange, addComponentChange, addComponentChangeFilter, addFacesListener, broadcastToMethodBinding, broadcastToMethodExpression, clearCachedClientIds, 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
addPartialTarget, broadcastInContext, clearCachedClientIds, defaultGetRenderedFacetsAndChildren, 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
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getPassThroughAttributes, getResourceBundleMap, getTransientStateHelper, getTransientStateHelper, isCompositeComponent, isInView, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView
public static final org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE
public static final String POPUP_REMOTE_FLAG_KEY
public RichPopup()
protected RichPopup(String rendererType)
protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
getBeanType
in class PartialRichPopup
public void broadcast(javax.faces.event.FacesEvent event) throws javax.faces.event.AbortProcessingException
broadcast
in class org.apache.myfaces.trinidad.component.UIXComponentBase
javax.faces.event.AbortProcessingException
public void queueEvent(javax.faces.event.FacesEvent event)
queueEvent
in class org.apache.myfaces.trinidad.component.UIXComponentBase
public void show(RichPopup.PopupHints hints)
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); }
hints
- defines characteristics about how the popup is shownpublic void cancel()
public void hide()
public javax.faces.component.UIComponent getParent()
getParent
in class org.apache.myfaces.trinidad.component.UIXComponentBase
public static boolean captureFetchRequest(javax.faces.context.FacesContext context, RichPopup popup)
PopupFetchEvent
was queued during this request/response (applies to a postback).context
- faces contextpopup
- not in stamped context but at tag execution timetrue
if PopupFetchEvent
was queued during this requestpublic static void markFetchRequest(javax.faces.context.FacesContext context, RichPopup popup)
context
- faces contextpopup
- instance of the popup in (stamped) contextpublic static boolean isFetchRequest(javax.faces.context.FacesContext context, org.apache.myfaces.trinidad.bean.FacesBean bean, String clientId)
context
- faces contextbean
- popup state holderclientId
- id in (stamped) contexttrue
if the popup has queued a fetch event.