Skip navigation links

Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
Oracle Fusion Middleware Java API Reference for Oracle ADF Faces
12c Release 1 (12.1.2.0.0)
E23185-01
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

oracle.adf.view.rich.component.rich
Class RichDocument

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 org.apache.myfaces.trinidad.component.UIXDocument
                  extended by oracle.adf.view.rich.component.rich.PartialRichDocument
                      extended by oracle.adf.view.rich.component.rich.RichDocument

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 RichDocument
extends PartialRichDocument

Field Summary

 

Fields inherited from class oracle.adf.view.rich.component.rich.PartialRichDocument
CLIENT_ATTRIBUTES_KEY, CLIENT_COMPONENT_KEY, CLIENT_LISTENERS_KEY, COMPONENT_FAMILY, COMPONENT_TYPE, CUSTOMIZATION_ID_KEY, FAILED_CONNECTION_TEXT_KEY, INITIAL_FOCUS_ID_KEY, INLINE_STYLE_KEY, LARGE_ICON_SOURCE_KEY, MAXIMIZED_KEY, META_CONTAINER_FACET, ONUNLOAD_KEY, PARTIAL_TRIGGERS_KEY, SHORT_DESC_KEY, SMALL_ICON_SOURCE_KEY, STATE_SAVING_CLIENT, STATE_SAVING_DEFAULT, STATE_SAVING_KEY, STATE_SAVING_SERVER, STYLE_CLASS_KEY, THEME_KEY, TITLE_KEY, TYPE, UNCOMMITTED_DATA_WARNING_KEY, UNCOMMITTED_DATA_WARNING_OFF, UNCOMMITTED_DATA_WARNING_ON, UNSECURE_KEY, 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
  RichDocument()
          Construct an instance of the RichDocument.
protected RichDocument(String rendererType)
          Construct an instance of the RichDocument.

 

Method Summary
 void addResource(PageResource resource)
          Adds a resource to the document component 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.
 List<PageResource> getPageResources()
          Obtains a read-only collection of all page resources associated with the document.
 void processEvent(javax.faces.event.ComponentSystemEvent event)
           
 void resourcesRendered()
          Called from the document renderer, this method notifies this component that the resources have been rendered.

 

Methods inherited from class oracle.adf.view.rich.component.rich.PartialRichDocument
addClientBehavior, getBeanType, getClientAttributes, getClientBehaviors, getClientListeners, getCustomizationId, getDefaultEventName, getEventNames, getFailedConnectionText, getFamily, getInitialFocusId, getInlineStyle, getLargeIconSource, getMetaContainer, getOnunload, getPartialTriggers, getShortDesc, getSmallIconSource, getStateSaving, getStyleClass, getTheme, getTitle, getUncommittedDataWarning, getUnsecure, isClientComponent, isMaximized, isVisible, setClientAttributes, setClientComponent, setClientListeners, setCustomizationId, setFailedConnectionText, setInitialFocusId, setInlineStyle, setLargeIconSource, setMaximized, setMetaContainer, setOnunload, setPartialTriggers, setShortDesc, setSmallIconSource, setStateSaving, setStyleClass, setTheme, setTitle, setUncommittedDataWarning, setUnsecure, setVisible

 

Methods inherited from class org.apache.myfaces.trinidad.component.UIXDocument
setupVisitingContext, tearDownVisitingContext

 

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase
adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addComponentChange, addComponentChange, addComponentChangeFilter, addFacesListener, broadcast, 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, getParent, getProperty, getPropertyKey, getRenderedFacetsAndChildren, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, initialStateMarked, invokeOnChildrenComponents, invokeOnComponent, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, 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, tearDownChildrenEncodingContext, tearDownChildrenVisitingContext, tearDownEncodingContext, 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, pushComponentToEL, restoreTransientState, saveTransientState, setInView

 

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

 

Constructor Detail

RichDocument

public RichDocument()
Construct an instance of the RichDocument.

RichDocument

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

Method Detail

addResource

public void addResource(PageResource resource)
Adds a resource to the document component to be rendered inside the <head> element of the HTML page. Should only be called during JSF component tree construction.
Parameters:
resource - The resource to add

resourcesRendered

public void resourcesRendered()
Called from the document renderer, this method notifies this component that the resources have been rendered. This method allows the component to know what resources have been rendered so that they are only rendered once.

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

getPageResources

public List<PageResource> getPageResources()
Obtains a read-only collection of all page resources associated with the document. The collection is ordered by the order in which addResource(PageResource) was called.
Returns:
a read-only collection of page resources

processEvent

public void processEvent(javax.faces.event.ComponentSystemEvent event)
                  throws javax.faces.event.AbortProcessingException
Specified by:
processEvent in interface javax.faces.event.ComponentSystemEventListener
Overrides:
processEvent in class javax.faces.component.UIComponent
Throws:
javax.faces.event.AbortProcessingException

Skip navigation links

Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
Oracle Fusion Middleware Java API Reference for Oracle ADF Faces
12c Release 1 (12.1.2.0.0)
E23185-01
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

Copyright © 2013 Oracle Corporation. All Rights Reserved.