Skip navigation links

Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
Oracle© Fusion Middleware Java API Reference for Oracle ADF Faces
11g Release 1 (11.1.1.7.3)
E10684-11
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

oracle.adf.view.rich.component.remote
Class RootRemoteRegion

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by org.apache.myfaces.trinidad.component.UIXComponent
          extended by org.apache.myfaces.trinidad.component.UIXComponentBase
              extended by oracle.adf.view.rich.component.fragment.UIXRegion
                  extended by oracle.adf.view.rich.component.rich.fragment.RichRegion
                      extended by oracle.adf.view.rich.component.remote.RootRemoteRegion

All Implemented Interfaces:
javax.faces.component.NamingContainer, javax.faces.component.StateHolder, PageResourceContainer, org.apache.myfaces.trinidad.webapp.ChangeManagerRoot
public class RootRemoteRegion
extends RichRegion
implements org.apache.myfaces.trinidad.webapp.ChangeManagerRoot, PageResourceContainer

<html:p> The RootRemoteRegion is an internal component designed to act as the root component of the RemoteRegion Bootstrap. For remote regions to work, a JSP page containing a RootRemoteRegion component on the producer must be added so that the remote taskflow may be able to run inside of it. The RootRemoteRegion is designed to replace some of the functionality of RichRegion and RichDocument, only for remote regions.</html:p>

Events:

Type Phases Description
oracle.adf.view.rich.event.RegionRemoteRefreshEvent Invoke Application This event is triggered when a remote region needs to be visited during the invoke application phase. This is needed for event handling and some PPR actions.
oracle.adf.view.rich.event.RegionNavigationEvent Invoke Application This event is triggered when the fragment that a region is displaying changes.
org.apache.myfaces.trinidad.event.DisclosureEvent Apply Request Values
Invoke Application		 The disclosure event is delivered when a node is disclosed.
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.FacesBean.Type TYPE
           

 

Fields inherited from class oracle.adf.view.rich.component.rich.fragment.RichRegion
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, HELP_TOPIC_ID_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, UNSECURE_KEY, VISIBLE_KEY

 

Fields inherited from class oracle.adf.view.rich.component.fragment.UIXRegion
DISCLOSED_KEY, DISCLOSURE_LISTENER_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
bindings

 

Fields inherited from interface javax.faces.component.NamingContainer
SEPARATOR_CHAR

 

Constructor Summary
  RootRemoteRegion()
          Construct an instance of the RootRemoteRegion.
protected RootRemoteRegion(java.lang.String rendererType)
          Construct an instance of the RootRemoteRegion.

 

Method Summary
 void addResource(PageResource resource)
          Adds a resource to be rendered inside the <head> element of the HTML page.
 java.util.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.
protected  org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
           
 java.lang.String getFamily()
           
 boolean invokeOnComponent(javax.faces.context.FacesContext context, java.lang.String clientId, javax.faces.component.ContextCallback callback)
           
 java.lang.Object processSaveState(javax.faces.context.FacesContext context)
           
 void queueEvent(javax.faces.event.FacesEvent event)
           
 boolean visitTree(org.apache.myfaces.trinidad.component.visit.VisitContext visitContext, org.apache.myfaces.trinidad.component.visit.VisitCallback callback)
           

 

Methods inherited from class oracle.adf.view.rich.component.rich.fragment.RichRegion
getClientAttributes, getClientListeners, getContentDelivery, getCustomizationId, getDontPersist, getHelpTopicId, getInlineStyle, getMaximizeListener, getPartialTriggers, getPersist, getShortDesc, getShowHeader, getShowMaximize, getStyleClass, getText, getUnsecure, isClientComponent, isMaximized, isShowDisclosure, isVisible, queueActionEventInRegion, setClientAttributes, setClientComponent, setClientListeners, setContentDelivery, setCustomizationId, setDontPersist, setHelpTopicId, setInlineStyle, setMaximized, setMaximizeListener, setPartialTriggers, setPersist, setShortDesc, setShowDisclosure, setShowHeader, setShowMaximize, setStyleClass, setText, setUnsecure, setVisible

 

Methods inherited from class oracle.adf.view.rich.component.fragment.UIXRegion
addDisclosureListener, addRegionNavigationListener, addRegionRemoteRefreshListener, broadcast, decodeChildrenImpl, encodeBegin, encodeEnd, getContainerClientId, getDisclosureListener, getDisclosureListeners, getRegionModel, getRegionNavigationListener, getRegionNavigationListeners, getRegionRemoteRefreshListeners, getUpdatedRegionEvent, getValue, isDisclosed, isImmediate, isRemoteRegionModel, isRendered, processRegion, refresh, removeDisclosureListener, removeRegionNavigationListener, removeRegionRemoteRefreshListener, setDisclosed, setDisclosureListener, setImmediate, setRegionModel, setRegionNavigationListener, setupVisitingContext, setValue, tearDownVisitingContext, updateChildrenImpl, validateChildrenImpl

 

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase
adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addComponentChange, addComponentChange, addComponentChangeFilter, addFacesListener, broadcastToMethodBinding, broadcastToMethodExpression, createFacesBean, decode, decodeChildren, encodeChildren, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getComponentChangeFilters, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getParent, getProperty, getPropertyKey, getRenderedFacetsAndChildren, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, invokeOnChildrenComponents, invokeOnNamingContainerComponent, isTransient, markInitialState, processDecodes, processRestoreState, processUpdates, processValidators, removeAttributeChangeListener, removeComponentChangeFilter, removeFacesListener, restoreState, satisfiesPartialTrigger, saveState, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setValueBinding, setValueExpression, toString, updateChildren, validateChildren

 

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponent
addPartialTarget, defaultGetRenderedFacetsAndChildren, encodeFlattenedChild, encodeFlattenedChildren, getLogicalParent, getLogicalParent, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setUpEncodingContext, tearDownEncodingContext, 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

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

RootRemoteRegion

public RootRemoteRegion()
Construct an instance of the RootRemoteRegion.

RootRemoteRegion

protected RootRemoteRegion(java.lang.String rendererType)
Construct an instance of the 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 java.util.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,
                                 java.lang.String clientId,
                                 javax.faces.component.ContextCallback callback)
                          throws javax.faces.FacesException
Overrides:
invokeOnComponent in class UIXRegion
Throws:
javax.faces.FacesException

visitTree

public boolean visitTree(org.apache.myfaces.trinidad.component.visit.VisitContext visitContext,
                         org.apache.myfaces.trinidad.component.visit.VisitCallback callback)
Overrides:
visitTree in class org.apache.myfaces.trinidad.component.UIXComponent

processSaveState

public java.lang.Object processSaveState(javax.faces.context.FacesContext context)
Overrides:
processSaveState in class org.apache.myfaces.trinidad.component.UIXComponentBase

getFamily

public java.lang.String getFamily()
Overrides:
getFamily in class RichRegion

getBeanType

protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
Overrides:
getBeanType in class RichRegion

Skip navigation links

Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
Oracle© Fusion Middleware Java API Reference for Oracle ADF Faces
11g Release 1 (11.1.1.7.3)
E10684-11
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

Copyright (c) 1998, 2014, Oracle and/or its affiliates. All rights reserved.