Skip navigation links

org.apache.myfaces.trinidad.component
Class UIXComponentRef

java.lang.Object
javax.faces.component.UIComponent
org.apache.myfaces.trinidad.component.UIXComponent
org.apache.myfaces.trinidad.component.UIXComponentBase
org.apache.myfaces.trinidad.component.UIXComponentRef

All Implemented Interfaces:

javax.faces.component.NamingContainer, javax.faces.component.StateHolder

public class UIXComponentRef

extends UIXComponentBase

implements javax.faces.component.NamingContainer

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.

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 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 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(java.lang.String rendererType) Construct an instance of the UIXComponentRef.

Method Summary

void	broadcast(javax.faces.event.FacesEvent event)
void	encodeBegin(javax.faces.context.FacesContext context)
void	encodeEnd(javax.faces.context.FacesContext context)
protected FacesBean.Type	getBeanType()
java.lang.String	getComponentType() Gets which componnet to use.
java.lang.String	getFamily()
java.lang.Object	getValue() Gets the value of the component.
java.lang.String	getVar() Gets The name of the EL variable that will be set when encoding the component.
boolean	invokeOnComponent(javax.faces.context.FacesContext context, java.lang.String clientId, javax.faces.component.ContextCallback callback) Override to calls the hooks for setting up and tearing down the context before the children are visited.
void	processDecodes(javax.faces.context.FacesContext context)
void	processUpdates(javax.faces.context.FacesContext context)
void	processValidators(javax.faces.context.FacesContext context)
void	queueEvent(javax.faces.event.FacesEvent event)
void	setComponentType(java.lang.String componentType) Sets which componnet to use.
void	setValue(java.lang.Object value) Sets the value of the component.
void	setVar(java.lang.String var) Sets The name of the EL variable that will be set when encoding the component.

Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase

adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addComponentChange, addComponentChange, addComponentChangeFilter, addFacesListener, broadcastToMethodBinding, broadcastToMethodExpression, createFacesBean, decode, decodeChildren, decodeChildrenImpl, encodeChildren, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getComponentChangeFilters, getContainerClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getParent, getProperty, getPropertyKey, getRenderedFacetsAndChildren, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, invokeOnChildrenComponents, invokeOnNamingContainerComponent, isRendered, isTransient, markInitialState, processRestoreState, processSaveState, removeAttributeChangeListener, removeComponentChangeFilter, removeFacesListener, restoreState, satisfiesPartialTrigger, 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, getLogicalParent, getLogicalParent, isVisitable, partialEncodeVisit, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, processFlattenedChildren, setPartialTarget, setUpEncodingContext, setupVisitingContext, tearDownEncodingContext, tearDownVisitingContext, visitTree, visitTree

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

TYPE

public static final FacesBean.Type TYPE

VALUE_KEY

public static final PropertyKey VALUE_KEY

COMPONENT_TYPE_KEY

public static final PropertyKey COMPONENT_TYPE_KEY

VAR_KEY

public static final PropertyKey VAR_KEY

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY

See Also:

Constant Field Values

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

Constructor Detail

UIXComponentRef

public UIXComponentRef()

Construct an instance of the UIXComponentRef.

UIXComponentRef

protected UIXComponentRef(java.lang.String rendererType)

Construct an instance of the UIXComponentRef.

Method Detail

invokeOnComponent

public boolean invokeOnComponent(javax.faces.context.FacesContext context,
                                 java.lang.String clientId,
                                 javax.faces.component.ContextCallback callback)
                          throws javax.faces.FacesException

Description copied from class: UIXComponentBase

Override to calls the hooks for setting up and tearing down the context before the children are visited.

Overrides:

invokeOnComponent in class UIXComponentBase

Throws:

javax.faces.FacesException

See Also:

UIXComponent.setupVisitingContext(javax.faces.context.FacesContext), UIXComponent.tearDownVisitingContext(javax.faces.context.FacesContext)

queueEvent

public void queueEvent(javax.faces.event.FacesEvent event)

Overrides:

queueEvent in class UIXComponentBase

broadcast

public void broadcast(javax.faces.event.FacesEvent event)
               throws javax.faces.event.AbortProcessingException

Overrides:

broadcast in class UIXComponentBase

Throws:

javax.faces.event.AbortProcessingException

processDecodes

public void processDecodes(javax.faces.context.FacesContext context)

Overrides:

processDecodes in class UIXComponentBase

processValidators

public void processValidators(javax.faces.context.FacesContext context)

Overrides:

processValidators in class UIXComponentBase

processUpdates

public void processUpdates(javax.faces.context.FacesContext context)

Overrides:

processUpdates in class UIXComponentBase

encodeBegin

public void encodeBegin(javax.faces.context.FacesContext context)
                 throws java.io.IOException

Overrides:

encodeBegin in class UIXComponentBase

Throws:

java.io.IOException

encodeEnd

public void encodeEnd(javax.faces.context.FacesContext context)
               throws java.io.IOException

Overrides:

encodeEnd in class UIXComponentBase

Throws:

java.io.IOException

getValue

public final java.lang.Object getValue()

Gets the value of the component. This value be evaluated during all lifecycle processing and made available to the componentDef as an EL variable named "bindings".

Returns:

the new value value

setValue

public final void setValue(java.lang.Object value)

Sets the value of the component. This value be evaluated during all lifecycle processing and made available to the componentDef as an EL variable named "bindings".

Parameters:

value - the new value value

getComponentType

public final java.lang.String getComponentType()

Gets which componnet to use. This should match a <component-type> string in a region metadata file. An example might look like "org.apache.myfaces.trinidaddemo.region.stock". This attribute can be bound to an EL expression or manually set, which will change the region definition used the next time the page renders.

Returns:

the new componentType value

setComponentType

public final void setComponentType(java.lang.String componentType)

Sets which componnet to use. This should match a <component-type> string in a region metadata file. An example might look like "org.apache.myfaces.trinidaddemo.region.stock". This attribute can be bound to an EL expression or manually set, which will change the region definition used the next time the page renders.

Parameters:

componentType - the new componentType value

getVar

public final java.lang.String getVar()

Gets The name of the EL variable that will be set when encoding the component. This attribute is set by the tr:componentDef on behalf of the UIXComponentRef, and not the tr:componentRef. For example, let's say this "var" attribute is set to the value "attrs"; if the <tr:componentRef> tag has an attribute called "bar", The value of "bar" can be referenced from a child within <tr:componentDef> using the expression #{attrs.bar}.

Returns:

the new var value

setVar

public final void setVar(java.lang.String var)

Sets The name of the EL variable that will be set when encoding the component. This attribute is set by the tr:componentDef on behalf of the UIXComponentRef, and not the tr:componentRef. For example, let's say this "var" attribute is set to the value "attrs"; if the <tr:componentRef> tag has an attribute called "bar", The value of "bar" can be referenced from a child within <tr:componentDef> using the expression #{attrs.bar}.

Parameters:

var - the new var value

getFamily

public java.lang.String getFamily()

Specified by:

getFamily in class UIXComponentBase

getBeanType

protected FacesBean.Type getBeanType()

Overrides:

getBeanType in class UIXComponentBase

Skip navigation links