|
Oracle Fusion Middleware Java API Reference for Oracle ADF Faces 11g Release 2 (11.1.2.0.0) E17488-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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.ContextSwitchingComponent
oracle.adf.view.rich.component.fragment.UIXInclude
public class UIXInclude
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 java.lang.String |
COMPONENT_FAMILY |
static java.lang.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 |
static org.apache.myfaces.trinidad.bean.PropertyKey |
VIEW_ID_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 |
---|
BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, VIEW_LOCATION_KEY |
Fields inherited from interface javax.faces.component.NamingContainer |
---|
SEPARATOR_CHAR |
Constructor Summary | |
---|---|
|
UIXInclude() Construct an instance of the UIXInclude. |
protected |
UIXInclude(java.lang.String rendererType) Construct an instance of the UIXInclude. |
Method Summary | |
---|---|
void |
broadcast(javax.faces.event.FacesEvent event) |
protected org.apache.myfaces.trinidad.bean.FacesBean |
createFacesBean(java.lang.String rendererType) |
protected java.lang.Object |
getAttribute(java.lang.Object key) |
protected org.apache.myfaces.trinidad.bean.FacesBean.Type |
getBeanType() |
java.lang.String |
getComponentVar() Gets The EL variable name used to access the component. |
java.lang.String |
getFamily() |
java.lang.String |
getVar() Gets The EL variable name to used to access the attributes of the component. |
java.lang.String |
getViewId() Gets the view ID. |
boolean |
invokeOnComponent(javax.faces.context.FacesContext context, java.lang.String clientId, javax.faces.component.ContextCallback callback) Override to always setup the visiting context before invoking the callback, or our children |
void |
queueEvent(javax.faces.event.FacesEvent evt) |
void |
resumeContext(javax.faces.context.FacesContext facesContext) Resume the include's context that has been suspended. |
protected java.lang.Object |
setAttribute(java.lang.Object key, java.lang.Object value) Sets the attribute of a component via the value expression. |
void |
setComponentVar(java.lang.String componentVar) Sets The EL variable name used to access the component. |
protected void |
setupChildrenVisitingContext(javax.faces.context.FacesContext facesContext) Sets up EL variables including the attribute map for use by the children of this include. |
void |
setVar(java.lang.String var) Sets The EL variable name to used to access the attributes of the component. |
protected org.apache.myfaces.trinidad.context.SuspendCallback.SuspendResult |
suspendChange(org.apache.myfaces.trinidad.context.ComponentContextChange contextChange) Called by the suspendContext(FacesContext) method to determine how far back to suspend the application context changes. |
void |
suspendContext(javax.faces.context.FacesContext facesContext) Suspend the include component that is currently in context. |
protected void |
tearDownChildrenVisitingContext(javax.faces.context.FacesContext facesContext) Restores the previous values of all the EL variables maintained by this component. |
Methods inherited from class oracle.adf.view.rich.component.fragment.ContextSwitchingComponent |
---|
finishComponentEncoding, isFlatteningChildren, processDecodes, processFlattenedChildren, processUpdates, processValidators, restoreContext, setupContext |
Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase |
---|
adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addClientBehavior, addFacesListener, broadcastToMethodBinding, broadcastToMethodExpression, clearInitialState, decode, decodeChildren, decodeChildrenImpl, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientBehaviors, getClientId, getContainerClientId, getDefaultEventName, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getListenersForEventClass, getParent, getProperty, getPropertyKey, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, initialStateMarked, invokeOnChildrenComponents, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processRestoreState, processSaveState, removeAttributeChangeListener, removeFacesListener, restoreState, satisfiesPartialTrigger, saveState, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setValueBinding, setValueExpression, subscribeToEvent, 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, setupEncodingContext, setUpEncodingContext, setupVisitingContext, tearDownChildrenEncodingContext, tearDownEncodingContext, tearDownVisitingContext, visitAllChildren, visitChildren, visitChildren, visitTree, visitTree |
Methods inherited from class javax.faces.component.UIComponent |
---|
encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getResourceBundleMap, isCompositeComponent, isInView, popComponentFromEL, processEvent, pushComponentToEL, setInView |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Field Detail |
---|
public static final org.apache.myfaces.trinidad.bean.FacesBean.Type TYPE
public static final org.apache.myfaces.trinidad.bean.PropertyKey VAR_KEY
public static final org.apache.myfaces.trinidad.bean.PropertyKey COMPONENT_VAR_KEY
public static final java.lang.String COMPONENT_FAMILY
public static final java.lang.String COMPONENT_TYPE
public static final org.apache.myfaces.trinidad.bean.PropertyKey VIEW_ID_KEY
Constructor Detail |
---|
public UIXInclude()
protected UIXInclude(java.lang.String rendererType)
Method Detail |
---|
public void queueEvent(javax.faces.event.FacesEvent evt)
queueEvent
in class ContextSwitchingComponent
public void broadcast(javax.faces.event.FacesEvent event) throws javax.faces.event.AbortProcessingException
broadcast
in class ContextSwitchingComponent
javax.faces.event.AbortProcessingException
public boolean invokeOnComponent(javax.faces.context.FacesContext context, java.lang.String clientId, javax.faces.component.ContextCallback callback) throws javax.faces.FacesException
ContextSwitchingComponent
invokeOnComponent
in class ContextSwitchingComponent
javax.faces.FacesException
UIXComponent.setupVisitingContext(javax.faces.context.FacesContext)
, UIXComponent.tearDownVisitingContext(javax.faces.context.FacesContext)
protected void setupChildrenVisitingContext(javax.faces.context.FacesContext facesContext)
setupChildrenVisitingContext
in class org.apache.myfaces.trinidad.component.UIXComponent
protected void tearDownChildrenVisitingContext(javax.faces.context.FacesContext facesContext)
tearDownChildrenVisitingContext
in class org.apache.myfaces.trinidad.component.UIXComponent
public void suspendContext(javax.faces.context.FacesContext facesContext) throws java.lang.IllegalStateException
facesContext
- the faces contextjava.lang.IllegalStateException
- if the include is not currently in contextpublic void resumeContext(javax.faces.context.FacesContext facesContext) throws java.lang.IllegalStateException
facesContext
- the faces contextjava.lang.IllegalStateException
- if the include is not suspendedpublic java.lang.String getViewId()
protected org.apache.myfaces.trinidad.context.SuspendCallback.SuspendResult suspendChange(org.apache.myfaces.trinidad.context.ComponentContextChange contextChange)
suspendContext(FacesContext)
method to determine how far back to suspend the application context changes.contextChange
- The change to considerprotected java.lang.Object getAttribute(java.lang.Object key)
protected java.lang.Object setAttribute(java.lang.Object key, java.lang.Object value)
getAttributes().put(Object, Object)
is that this method will update the value expression rather than updating the component attribute if the key corresponds to a writable value expression.key
- The key of the attribute to set (should be a string)value
- The value to setprotected org.apache.myfaces.trinidad.bean.FacesBean createFacesBean(java.lang.String rendererType)
createFacesBean
in class org.apache.myfaces.trinidad.component.UIXComponentBase
public final java.lang.String getVar()
public final void setVar(java.lang.String var)
var
- the new var valuepublic final java.lang.String getComponentVar()
public final void setComponentVar(java.lang.String componentVar)
componentVar
- the new componentVar valuepublic java.lang.String getFamily()
getFamily
in class org.apache.myfaces.trinidad.component.UIXComponentBase
protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
getBeanType
in class org.apache.myfaces.trinidad.component.UIXComponentBase
|
Oracle Fusion Middleware Java API Reference for Oracle ADF Faces 11g Release 2 (11.1.2.0.0) E17488-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |