|
Oracle Fusion Middleware Java API Reference for Oracle ADF Faces 11g Release 1 (11.1.1) E10684-03 |
|||||||||
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 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.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 |
---|
bindings |
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) Deprecated. This function should not be relied upon and will be removed in a future release. |
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 |
resumeVisitingContext(javax.faces.context.FacesContext facesContext) Resume the suspended context |
protected java.lang.Object |
setAttribute(java.lang.Object key, java.lang.Object value) Deprecated. This function should not be relied upon and will be removed in a future release. |
void |
setComponentVar(java.lang.String componentVar) Sets The EL variable name used to access the component. |
protected void |
setupVisitingContext(javax.faces.context.FacesContext facesContext) Setups EL variables including the attribute map for use by the children of this page templete. |
void |
setVar(java.lang.String var) Sets The EL variable name to used to access the attributes of the component. |
void |
suspendVisitingContext(javax.faces.context.FacesContext facesContext) Suspends the current visiting context of the include component. |
protected void |
tearDownVisitingContext(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 |
---|
encodeBegin, encodeEnd, finishComponentEncoding, isFlatteningChildren, processDecodes, processFlattenedChildren, processUpdates, processValidators, restoreContext, setupContext |
Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase |
---|
adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addFacesListener, broadcastToMethodBinding, broadcastToMethodExpression, decode, decodeChildren, decodeChildrenImpl, encodeAll, encodeChildren, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getContainerClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getParent, getProperty, getPropertyKey, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, invokeOnChildrenComponents, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processRestoreState, processSaveState, removeAttributeChangeListener, removeFacesListener, restoreState, saveState, setAttributeChangeListener, setAttributeChangeListener, setBooleanProperty, setId, setIntProperty, setParent, setProperty, setRendered, setRendererType, setTransient, setValueBinding, setValueExpression, toString, updateChildren, updateChildrenImpl, validateChildren, validateChildrenImpl |
Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponent |
---|
addPartialTarget, encodeFlattenedChild, encodeFlattenedChildren, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setUpEncodingContext, tearDownEncodingContext, visitTree, visitTree |
Methods inherited from class javax.faces.component.UIComponent |
---|
getContainerClientId |
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)
public void suspendVisitingContext(javax.faces.context.FacesContext facesContext)
This method is intended to be called from the include JSP tag's FacetWrapper.
resumeVisitingContext(FacesContext)
public void resumeVisitingContext(javax.faces.context.FacesContext facesContext)
suspendVisitingContext(FacesContext)
protected void setupVisitingContext(javax.faces.context.FacesContext facesContext)
setupVisitingContext
in class org.apache.myfaces.trinidad.component.UIXComponent
protected void tearDownVisitingContext(javax.faces.context.FacesContext facesContext)
tearDownVisitingContext
in class org.apache.myfaces.trinidad.component.UIXComponent
public java.lang.String getViewId()
@Deprecated
protected java.lang.Object getAttribute(java.lang.Object key)
@Deprecated
protected java.lang.Object setAttribute(java.lang.Object key,
java.lang.Object value)
protected 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 1 (11.1.1) E10684-03 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |