|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectjavax.faces.component.UIComponent
org.apache.myfaces.trinidad.component.UIXComponent
org.apache.myfaces.trinidad.component.UIXComponentBase
org.apache.myfaces.trinidad.component.UIXComponentRef
public class UIXComponentRef
This component inserts a component (defined by a separate page that starts with <tr:componentDef>) into the current page. The "id" attribute is required on this component, which implements NamingContainer. This component may have a value, custom attributes, or both. The value will be made available to within component definition using the "binding" EL attribute. Custom attributes, defined with <f:attribute> or <tr:attribute>, will also be made available within the component definition - see the <tr:componentDef> tag documentation for more information. This component may also have facets. Each facet may be referenced exactly once from within a <tr:componentDef> tag by using a <tr:facetRef> - see the <tr:componentRef> tag documentation for more information.
| 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 String |
COMPONENT_FAMILY
|
static String |
COMPONENT_TYPE
|
static PropertyKey |
COMPONENT_TYPE_KEY
|
static FacesBean.Type |
TYPE
|
static PropertyKey |
VALUE_KEY
|
static 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 |
|---|
bindings |
| Fields inherited from interface javax.faces.component.NamingContainer |
|---|
SEPARATOR_CHAR |
| Constructor Summary | |
|---|---|
|
UIXComponentRef()
Construct an instance of the UIXComponentRef. |
protected |
UIXComponentRef(String rendererType)
Construct an instance of the UIXComponentRef. |
| Method Summary | |
|---|---|
void |
broadcast(FacesEvent event)
|
void |
encodeBegin(FacesContext context)
|
void |
encodeEnd(FacesContext context)
|
protected FacesBean.Type |
getBeanType()
|
String |
getComponentType()
Gets which componnet to use. |
String |
getFamily()
|
Object |
getValue()
Gets the value of the component. |
String |
getVar()
Gets The name of the EL variable that will be set when encoding the component. |
boolean |
invokeOnComponent(FacesContext context,
String clientId,
ContextCallback callback)
Override to calls the hooks for setting up and tearing down the context before the children are visited. |
void |
processDecodes(FacesContext context)
|
void |
processUpdates(FacesContext context)
|
void |
processValidators(FacesContext context)
|
void |
queueEvent(FacesEvent event)
|
void |
setComponentType(String componentType)
Sets which componnet to use. |
void |
setValue(Object value)
Sets the value of the component. |
void |
setVar(String var)
Sets The name of the EL variable that will be set when encoding the component. |
| 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 |
|---|
public static final FacesBean.Type TYPE
public static final PropertyKey VALUE_KEY
public static final PropertyKey COMPONENT_TYPE_KEY
public static final PropertyKey VAR_KEY
public static final String COMPONENT_FAMILY
public static final String COMPONENT_TYPE
| Constructor Detail |
|---|
public UIXComponentRef()
protected UIXComponentRef(String rendererType)
| Method Detail |
|---|
public boolean invokeOnComponent(FacesContext context,
String clientId,
ContextCallback callback)
throws FacesException
UIXComponentBase
invokeOnComponent in class UIXComponentBaseFacesExceptionUIXComponent.setupVisitingContext(javax.faces.context.FacesContext),
UIXComponent.tearDownVisitingContext(javax.faces.context.FacesContext)public void queueEvent(FacesEvent event)
queueEvent in class UIXComponentBase
public void broadcast(FacesEvent event)
throws AbortProcessingException
broadcast in class UIXComponentBaseAbortProcessingExceptionpublic void processDecodes(FacesContext context)
processDecodes in class UIXComponentBasepublic void processValidators(FacesContext context)
processValidators in class UIXComponentBasepublic void processUpdates(FacesContext context)
processUpdates in class UIXComponentBase
public void encodeBegin(FacesContext context)
throws IOException
encodeBegin in class UIXComponentBaseIOException
public void encodeEnd(FacesContext context)
throws IOException
encodeEnd in class UIXComponentBaseIOExceptionpublic final Object getValue()
public final void setValue(Object value)
value - the new value valuepublic final String getComponentType()
public final void setComponentType(String componentType)
componentType - the new componentType valuepublic final String getVar()
#{attrs.bar}.
public final void setVar(String var)
#{attrs.bar}.
var - the new var valuepublic String getFamily()
getFamily in class UIXComponentBaseprotected FacesBean.Type getBeanType()
getBeanType in class UIXComponentBase
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||