oracle.adf.view.rich.component.rich.fragment

Class RichRegion

java.lang.Object

javax.faces.component.UIComponent

org.apache.myfaces.trinidad.component.UIXComponent

org.apache.myfaces.trinidad.component.UIXComponentBase

oracle.adf.view.rich.component.fragment.PartialUIXRegion

oracle.adf.view.rich.component.fragment.UIXRegion

oracle.adf.view.rich.component.rich.fragment.PartialRichRegion

oracle.adf.view.rich.component.rich.fragment.RichRegion

All Implemented Interfaces:

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

Direct Known Subclasses:

PartialRootRemoteRegion

public class RichRegion
extends PartialRichRegion

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase

org.apache.myfaces.trinidad.component.UIXComponentBase.ComponentSystemEventListenerWrapper

Field Summary

Fields inherited from class oracle.adf.view.rich.component.rich.fragment.PartialRichRegion

CLIENT_ATTRIBUTES_KEY, CLIENT_COMPONENT_KEY, CLIENT_LISTENERS_KEY, COMPONENT_FAMILY, COMPONENT_TYPE, CONTENT_DELIVERY_IMMEDIATE, CONTENT_DELIVERY_KEY, CONTENT_DELIVERY_LAZY_UNCACHED, CUSTOMIZATION_ID_KEY, DONT_PERSIST_KEY, INLINE_STYLE_KEY, MAXIMIZE_LISTENER_KEY, MAXIMIZED_KEY, PARTIAL_TRIGGERS_KEY, PERSIST_KEY, SHORT_DESC_KEY, SHOW_DISCLOSURE_KEY, SHOW_HEADER_ALWAYS, SHOW_HEADER_IF_NEEDED, SHOW_HEADER_KEY, SHOW_HEADER_NEVER, SHOW_MAXIMIZE_ALWAYS, SHOW_MAXIMIZE_AUTO, SHOW_MAXIMIZE_KEY, SHOW_MAXIMIZE_NEVER, STYLE_CLASS_KEY, TEXT_KEY, TYPE, UNCOMMITTED_DATA_WARNING_KEY, UNCOMMITTED_DATA_WARNING_OFF, UNCOMMITTED_DATA_WARNING_ON, UNSECURE_KEY, VISIBLE_KEY

Fields inherited from class oracle.adf.view.rich.component.fragment.PartialUIXRegion

DISCLOSED_KEY, DISCLOSURE_LISTENER_KEY, HELP_TOPIC_ID_KEY, IMMEDIATE_KEY, REGION_NAVIGATION_LISTENER_KEY, VALUE_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

Fields inherited from interface javax.faces.component.NamingContainer

SEPARATOR_CHAR

Constructor Summary

Constructors

Modifier	Constructor and Description
	RichRegion() Construct an instance of the RichRegion.
protected	RichRegion(String rendererType) Construct an instance of the RichRegion.

Method Summary

Modifier and Type	Method and Description
javax.faces.component.UIComponent	createMenuFacet() Creates a RichMenuBar component that is the top level component in the 'menu' facet, if the showHeader property is set to be anything other than 'never'.
void	createMenuFacetChildren(javax.faces.context.FacesContext context, javax.faces.component.UIComponent menuBar) Adds the RichMenu containing the Region actions.
void	queueActionEventInRegion(javax.el.MethodExpression actionExpression, javax.el.MethodExpression launchListenerMethodExpression, javax.el.MethodExpression returnListenerMethodExpression, Boolean useWindow, Integer windowWidth, Integer windowHeight, javax.faces.event.PhaseId phaseId) Queues an ActionEvent so that it behaves as if you queued it on a UIXCommand component that exists inside of the region where that UIXCommand had all of these action-related settings assigned.
protected void	setupFacetsAndChildren(javax.faces.context.FacesContext context) Sets up the menu facet that renders a menu of RegionAction commands.

Methods inherited from class oracle.adf.view.rich.component.rich.fragment.PartialRichRegion

addClientBehavior, getBeanType, getClientAttributes, getClientBehaviors, getClientListeners, getContentDelivery, getCustomizationId, getDefaultEventName, getDontPersist, getEventNames, getFamily, getInlineStyle, getMaximizeListener, getPartialTriggers, getPersist, getShortDesc, getShowHeader, getShowMaximize, getStyleClass, getText, getUncommittedDataWarning, getUnsecure, isClientComponent, isMaximized, isShowDisclosure, isVisible, setClientAttributes, setClientComponent, setClientListeners, setContentDelivery, setCustomizationId, setDontPersist, setInlineStyle, setMaximized, setMaximizeListener, setPartialTriggers, setPersist, setShortDesc, setShowDisclosure, setShowHeader, setShowMaximize, setStyleClass, setText, setUncommittedDataWarning, setUnsecure, setVisible

Methods inherited from class oracle.adf.view.rich.component.fragment.UIXRegion

broadcast, decodeChildrenImpl, encodeBegin, encodeEnd, getContainerClientId, getContainerClientId, getRegionModel, getUpdatedRegionEvent, invokeOnComponent, isRemoteRegionModel, isRendered, processEvent, processRegion, queueEvent, refresh, setRegionModel, setupChildrenVisitingContext, tearDownChildrenVisitingContext, updateChildrenImpl, validateChildrenImpl, visitChildren

Methods inherited from class oracle.adf.view.rich.component.fragment.PartialUIXRegion

addDisclosureListener, addRegionNavigationListener, addRegionRemoteRefreshListener, getDisclosureListener, getDisclosureListeners, getHelpTopicId, getRegionNavigationListener, getRegionNavigationListeners, getRegionRemoteRefreshListeners, getValue, isDisclosed, isImmediate, removeDisclosureListener, removeRegionNavigationListener, removeRegionRemoteRefreshListener, setDisclosed, setDisclosureListener, setHelpTopicId, setImmediate, setRegionNavigationListener, setValue

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

adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addComponentChange, addComponentChange, addComponentChangeFilter, addFacesListener, broadcastToMethodBinding, broadcastToMethodExpression, clearCachedClientIds, clearInitialState, createFacesBean, decode, decodeChildren, encodeChildren, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getComponentChangeFilters, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getListenersForEventClass, getParent, getPassThroughAttributes, getProperty, getPropertyKey, getRenderedFacetsAndChildren, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, initialStateMarked, invokeOnChildrenComponents, invokeOnNamingContainerComponent, isTransient, markInitialState, processDecodes, 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, validateChildren

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

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

Methods inherited from class javax.faces.component.UIComponent

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

Methods inherited from class java.lang.Object

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

Constructor Detail

RichRegion

public RichRegion()

Construct an instance of the RichRegion.

RichRegion

protected RichRegion(String rendererType)

Construct an instance of the RichRegion.

Parameters:

rendererType - the renderer type.

Method Detail

queueActionEventInRegion

public void queueActionEventInRegion(javax.el.MethodExpression actionExpression,
                                     javax.el.MethodExpression launchListenerMethodExpression,
                                     javax.el.MethodExpression returnListenerMethodExpression,
                                     Boolean useWindow,
                                     Integer windowWidth,
                                     Integer windowHeight,
                                     javax.faces.event.PhaseId phaseId)

Queues an ActionEvent so that it behaves as if you queued it on a UIXCommand component that exists inside of the region where that UIXCommand had all of these action-related settings assigned.

Parameters:

actionExpression - a reference to an action method sent by the command component, or the static outcome of an action

launchListenerMethodExpression - the launch listener that will be used to create a method expression if the action corresponds to a dialog navigation

returnListenerMethodExpression - the return listener that will be used to create a method expression if the action corresponds to a dialog navigation

useWindow - whether processes launched by this command should be launched in a secondary dialog window. "useWindow" works only in the case of dialogs i.e, if the "action" starts with a "dialog:". Setting useWindow to "false" for the dialog to be opened in the existing window is not possible for regions since regions require fragment content when inline.

windowWidth - the width of the window, if this command is used to launch a window

windowHeight - the height of the window, if this command is used to launch a window

phaseId - the ID of the phase the action event should be executed

setupFacetsAndChildren

protected void setupFacetsAndChildren(javax.faces.context.FacesContext context)

Sets up the menu facet that renders a menu of RegionAction commands.

Overrides:

setupFacetsAndChildren in class UIXRegion

Parameters:

context - the current FacesContext

createMenuFacet

public javax.faces.component.UIComponent createMenuFacet()

Creates a RichMenuBar component that is the top level component in the 'menu' facet, if the showHeader property is set to be anything other than 'never'. This method does not create the facet's children. See createMenuFacetChildren(javax.faces.context.FacesContext, javax.faces.component.UIComponent).

Returns:

UIComponent a RichMenubar instance that is the 'menu' facet.

createMenuFacetChildren

public void createMenuFacetChildren(javax.faces.context.FacesContext context,
                                    javax.faces.component.UIComponent menuBar)

Adds the RichMenu containing the Region actions. When this method is called, the region component is expected to be in the right context for processing its children.

Parameters:

context - FacesContext object

menuBar - the component in the 'menu' facet