Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle ADF Faces
12c Release 1 (12.1.2.0.0)
E23185-01


oracle.adf.view.rich.component.fragment
Class PartialUIXInclude

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.ContextSwitchingComponent
                  extended by oracle.adf.view.rich.component.fragment.PartialUIXInclude

All Implemented Interfaces:
EventListener, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, org.apache.myfaces.trinidad.component.FlattenedComponent
Direct Known Subclasses:
UIXInclude

public abstract class PartialUIXInclude
extends ContextSwitchingComponent

Events:

Type Phases Description
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 event might include the width of a column that supported client-side resizing.

Field Summary
static String COMPONENT_FAMILY
           
static String COMPONENT_TYPE
           
static org.apache.myfaces.trinidad.bean.PropertyKey COMPONENT_VAR_KEY
           
static org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE
           
static org.apache.myfaces.trinidad.bean.PropertyKey VAR_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
protected PartialUIXInclude(String rendererType)
          Construct an instance of the PartialUIXInclude.

 

Method Summary
protected  org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
           
 String getComponentVar()
          Gets The EL variable name used to access the component.
 String getFamily()
           
 String getVar()
          Gets The EL variable name to used to access the attributes of the component.
 void setComponentVar(String componentVar)
          Sets The EL variable name used to access the component.
 void setVar(String var)
          Sets The EL variable name to used to access the attributes of the component.

 

Methods inherited from class oracle.adf.view.rich.component.fragment.ContextSwitchingComponent
broadcast, finishComponentEncoding, invokeOnComponent, isFlatteningChildren, processDecodes, processFlattenedChildren, processUpdates, processValidators, queueEvent, restoreContext, setupContext

 

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase
adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addClientBehavior, addComponentChange, addComponentChange, addComponentChangeFilter, addFacesListener, broadcastToMethodBinding, broadcastToMethodExpression, clearInitialState, createFacesBean, decode, decodeChildren, decodeChildrenImpl, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientBehaviors, getClientId, getComponentChangeFilters, getContainerClientId, getDefaultEventName, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getListenersForEventClass, getParent, getProperty, getPropertyKey, getRenderedFacetsAndChildren, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, initialStateMarked, invokeOnChildrenComponents, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processRestoreState, processSaveState, 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, setupVisitingContext, tearDownChildrenEncodingContext, tearDownChildrenVisitingContext, tearDownEncodingContext, tearDownVisitingContext, 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, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView

 

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

VAR_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey VAR_KEY

COMPONENT_VAR_KEY

public static final org.apache.myfaces.trinidad.bean.PropertyKey COMPONENT_VAR_KEY

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY
See Also:
Constant Field Values

COMPONENT_TYPE

public static final String COMPONENT_TYPE
See Also:
Constant Field Values

Constructor Detail

PartialUIXInclude

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

Method Detail

getVar

public final String getVar()
Gets The EL variable name to used to access the attributes of the component. This is an internal attribute and should not be used. It is automatically managed by the definition tag in the included view.
Returns:
the new var value

setVar

public final void setVar(String var)
Sets The EL variable name to used to access the attributes of the component. This is an internal attribute and should not be used. It is automatically managed by the definition tag in the included view.
Parameters:
var - the new var value

getComponentVar

public final String getComponentVar()
Gets The EL variable name used to access the component. This is an internal attribute and should not be used. It is automatically managed by the definition tag in the included view.
Returns:
the new componentVar value

setComponentVar

public final void setComponentVar(String componentVar)
Sets The EL variable name used to access the component. This is an internal attribute and should not be used. It is automatically managed by the definition tag in the included view.
Parameters:
componentVar - the new componentVar value

getFamily

public String getFamily()
Specified by:
getFamily in class org.apache.myfaces.trinidad.component.UIXComponentBase

getBeanType

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

Skip navigation links

Oracle Fusion Middleware Java API Reference for Oracle ADF Faces
12c Release 1 (12.1.2.0.0)
E23185-01


Copyright © 2013 Oracle Corporation. All Rights Reserved.