|
||||||||||
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.UIXSwitcher
public class UIXSwitcher
The switcher component dynamically decides which facet component should be rendered. It has two properties. The switcher will render the facet matching "facetName"; however, if no such facet exists (or "facetName" is null), and "defaultFacet" has been set, then that facet will be used instead. (It's possible to achieve this same functionality by using a panelGroup and binding the "rendered" property of each child, but this component can be simpler. Ordinary children of the switcher component are not rendered at all.)
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 |
DEFAULT_FACET_KEY
|
static PropertyKey |
FACET_NAME_KEY
|
static FacesBean.Type |
TYPE
|
Fields inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase |
---|
BINDING_KEY, ID_KEY, RENDERED_KEY, RENDERER_TYPE_KEY, TRANSIENT_KEY |
Constructor Summary | |
---|---|
|
UIXSwitcher()
Construct an instance of the UIXSwitcher. |
protected |
UIXSwitcher(java.lang.String rendererType)
Construct an instance of the UIXSwitcher. |
Method Summary | |
---|---|
void |
encodeChildren(javax.faces.context.FacesContext context)
Only render the currently active facet. |
protected FacesBean.Type |
getBeanType()
|
java.lang.String |
getDefaultFacet()
Gets the name of the facet to render and process if "facetName" is null or otherwise does not refer to an existing facet. |
java.lang.String |
getFacetName()
Gets the name of the facet to render and process. |
java.lang.String |
getFamily()
|
boolean |
getRendersChildren()
Override to return true. |
void |
processDecodes(javax.faces.context.FacesContext context)
Only decode the currently active facet. |
void |
processUpdates(javax.faces.context.FacesContext context)
Only process updates on the currently active facet. |
void |
processValidators(javax.faces.context.FacesContext context)
Only process validations on the currently active facet. |
void |
setDefaultFacet(java.lang.String defaultFacet)
Sets the name of the facet to render and process if "facetName" is null or otherwise does not refer to an existing facet. |
void |
setFacetName(java.lang.String facetName)
Sets the name of the facet to render and process. |
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 FACET_NAME_KEY
public static final PropertyKey DEFAULT_FACET_KEY
public static final java.lang.String COMPONENT_FAMILY
public static final java.lang.String COMPONENT_TYPE
Constructor Detail |
---|
public UIXSwitcher()
protected UIXSwitcher(java.lang.String rendererType)
Method Detail |
---|
public void processDecodes(javax.faces.context.FacesContext context)
processDecodes
in class UIXComponentBase
public void processValidators(javax.faces.context.FacesContext context)
processValidators
in class UIXComponentBase
public void processUpdates(javax.faces.context.FacesContext context)
processUpdates
in class UIXComponentBase
public void encodeChildren(javax.faces.context.FacesContext context) throws java.io.IOException
encodeChildren
in class UIXComponentBase
java.io.IOException
public boolean getRendersChildren()
getRendersChildren
in class UIXComponentBase
public final java.lang.String getFacetName()
public final void setFacetName(java.lang.String facetName)
facetName
- the new facetName valuepublic final java.lang.String getDefaultFacet()
public final void setDefaultFacet(java.lang.String defaultFacet)
defaultFacet
- the new defaultFacet valuepublic java.lang.String getFamily()
getFamily
in class UIXComponentBase
protected FacesBean.Type getBeanType()
getBeanType
in class UIXComponentBase
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |