RootRemoteRegion (Java API Reference for Oracle ADF Faces)

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
        
        oracle.adf.view.rich.component.remote.PartialRootRemoteRegion
        
        oracle.adf.view.rich.component.remote.RootRemoteRegion

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, PageResourceContainer
```
public class RootRemoteRegion
extends PartialRootRemoteRegion
implements PageResourceContainer
```

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.remote.PartialRootRemoteRegion
  COMPONENT_FAMILY, COMPONENT_TYPE, TYPE
- Fields inherited from class oracle.adf.view.rich.component.rich.fragment.PartialRichRegion
  CLIENT_ATTRIBUTES_KEY, CLIENT_COMPONENT_KEY, CLIENT_LISTENERS_KEY, 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, 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
Constructor and Description

RootRemoteRegion()

Constructors
Constructor and Description
`RootRemoteRegion()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addResource(PageResource resource)` Adds a resource to be rendered inside the <head> element of the HTML page.
`List<PageResource>`	`getAddedPageResources()` Obtains a read-only collection of page resources that have been added to the document during this request if a partial request, or the full list of resources for a full-submit.
`boolean`	`invokeOnComponent(javax.faces.context.FacesContext context, String clientId, javax.faces.component.ContextCallback callback)`
`Object`	`processSaveState(javax.faces.context.FacesContext context)`
`void`	`queueEvent(javax.faces.event.FacesEvent event)`
`boolean`	`visitTree(javax.faces.component.visit.VisitContext visitContext, javax.faces.component.visit.VisitCallback callback)`

Methods inherited from class oracle.adf.view.rich.component.remote.PartialRootRemoteRegion
getBeanType, getFamily

Methods inherited from class oracle.adf.view.rich.component.rich.fragment.RichRegion
createMenuFacet, createMenuFacetChildren, queueActionEventInRegion, setupFacetsAndChildren

Methods inherited from class oracle.adf.view.rich.component.rich.fragment.PartialRichRegion
addClientBehavior, getClientAttributes, getClientBehaviors, getClientListeners, getContentDelivery, getCustomizationId, getDefaultEventName, getDontPersist, getEventNames, 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, getRegionModel, getUpdatedRegionEvent, isRemoteRegionModel, isRendered, processEvent, processRegion, 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, getProperty, getPropertyKey, getRenderedFacetsAndChildren, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, initialStateMarked, invokeOnChildrenComponents, invokeOnNamingContainerComponent, isTransient, markInitialState, processDecodes, processRestoreState, 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

Methods inherited from class javax.faces.component.UIComponent
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, 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
  - RootRemoteRegion
```
public RootRemoteRegion()
```
- Method Detail
  - addResource
```
public void addResource(PageResource resource)
```
    Adds a resource to be rendered inside the <head> element of the HTML page. Should only be called during JSF component tree construction.
    
    Specified by:
    
    addResource in interface PageResourceContainer
    
    Parameters:
    
    resource - The resource to add
  - getAddedPageResources
```
public List<PageResource> getAddedPageResources()
```
    Obtains a read-only collection of page resources that have been added to the document during this request if a partial request, or the full list of resources for a full-submit. The collection is ordered by the order in which addResource(PageResource) was called.
    
    Returns:
    
    a read-only collection of page resources
  - queueEvent
```
public void queueEvent(javax.faces.event.FacesEvent event)
```
    Overrides:
    
    queueEvent in class UIXRegion
  - invokeOnComponent
```
public boolean invokeOnComponent(javax.faces.context.FacesContext context,
                        String clientId,
                        javax.faces.component.ContextCallback callback)
                          throws javax.faces.FacesException
```
    Overrides:
    
    invokeOnComponent in class UIXRegion
    
    Throws:
    
    javax.faces.FacesException
  - visitTree
```
public boolean visitTree(javax.faces.component.visit.VisitContext visitContext,
                javax.faces.component.visit.VisitCallback callback)
```
    Overrides:
    
    visitTree in class org.apache.myfaces.trinidad.component.UIXComponent
  - processSaveState
```
public Object processSaveState(javax.faces.context.FacesContext context)
```
    Overrides:
    
    processSaveState in class org.apache.myfaces.trinidad.component.UIXComponentBase

Class RootRemoteRegion

Nested Class Summary

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

Field Summary

Fields inherited from class oracle.adf.view.rich.component.remote.PartialRootRemoteRegion

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

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

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

Fields inherited from class javax.faces.component.UIComponent

Fields inherited from interface javax.faces.component.NamingContainer

Constructor Summary

Method Summary

Methods inherited from class oracle.adf.view.rich.component.remote.PartialRootRemoteRegion

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

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

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

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

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

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

Methods inherited from class javax.faces.component.UIComponent

Methods inherited from class java.lang.Object

Constructor Detail

RootRemoteRegion

Method Detail

addResource

getAddedPageResources

queueEvent

invokeOnComponent

visitTree

processSaveState