org.apache.myfaces.custom.aliasbean
Class AliasBean
java.lang.Object
   javax.faces.component.UIComponent
javax.faces.component.UIComponent
       javax.faces.component.UIComponentBase
javax.faces.component.UIComponentBase
           org.apache.myfaces.custom.aliasbean.AliasBean
org.apache.myfaces.custom.aliasbean.AliasBean
- All Implemented Interfaces: 
- javax.faces.component.StateHolder, BindingAware
- @JSFComponent(name="t:aliasBean",
              tagClass="org.apache.myfaces.custom.aliasbean.AliasBeanTag",
              tagHandler="org.apache.myfaces.custom.aliasbean.AliasBeanTagHandler")
@JSFJspProperties(properties={@JSFJspProperty(name="rendered",returnType="boolean",tagExcluded=true),@JSFJspProperty(name="binding",returnType="java.lang.String",tagExcluded=true)})
public class AliasBean
- extends javax.faces.component.UIComponentBase- implements BindingAware
The aliasBean tag allows you to create a temporary name for a real bean.
 The temporary name exists (is visible) only to the children of the aliasBean.
 
 One use of this feature is to pass "parameters" from an including page to an
 included one. The included page can use any name it desires for beans it needs to
 reference, and the including page can then use aliasBean to make those names
 refer to the beans it wishes to "pass" as parameters.
 
 
 Suppose you have a block of components you use often but with different beans. You
 can create a separate JSP page (or equivalent) containing these beans, where the
 value-bindings refer to some fictive bean name. Document these names as the required
 "parameters" for this JSP page. Wherever you wish to use this block you then declare
 an alias component mapping each of these "parameters" to whatever beans (or literal
 values) you really want to apply the block to, then use jsp:include (or equivalent)
 to include the reusable block of components.
 
 
 Note, however, that AliasBean does not work for component bindings; JSF1.1
 just has no mechanism available to set up the alias during the "restore view"
 phase while the bindings of its children are being re-established, and then
 remove the alias after the child bindings are done.
 
 
 As a special case, if this component's direct parent is an AliasBeansScope
 then the alias (temporary name) is active until the end of the parent
 component, rather than the end of this component.
 
- Version:
- $Revision: 1082663 $ $Date: 2011-03-17 14:47:10 -0500 (Thu, 17 Mar 2011) $
- Author:
- Sylvain Vieujot (latest modification by $Author: lu4242 $)
 
| Fields inherited from class javax.faces.component.UIComponent | 
| bindings | 
 
 
 
| Methods inherited from class javax.faces.component.UIComponentBase | 
| addFacesListener, decode, encodeChildren, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendersChildren, getValueBinding, isRendered, isTransient, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding | 
 
| Methods inherited from class javax.faces.component.UIComponent | 
| encodeAll, getContainerClientId, getValueExpression, setValueExpression | 
 
| Methods inherited from class java.lang.Object | 
| clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait | 
 
COMPONENT_TYPE
public static final String COMPONENT_TYPE
- See Also:
- Constant Field Values
COMPONENT_FAMILY
public static final String COMPONENT_FAMILY
- See Also:
- Constant Field Values
AliasBean
public AliasBean()
getFamily
public String getFamily()
- 
- Specified by:
- getFamilyin class- javax.faces.component.UIComponent
 
- 
 
getRendererType
public String getRendererType()
- 
- Overrides:
- getRendererTypein class- javax.faces.component.UIComponentBase
 
- 
 
setAlias
@JSFProperty
public void setAlias(String aliasBeanExpression)
- Define the "fictive" name which will be visible to the children
 of this component as an alias to the "real" object specified
 by the value attribute of this component.
 
- 
 
- 
- Parameters:
- aliasBeanExpression-
 
getValue
@JSFProperty
public String getValue()
- The existing value that the alias can be set to. This can be 
 a literal string (like "toto") or a reference to an existing 
 bean (like "#{myBean.member1}").
 
- 
 
- 
 
setValue
public void setValue(String valueExpression)
- 
 
- 
 
saveState
public Object saveState(javax.faces.context.FacesContext context)
- 
- Specified by:
- saveStatein interface- javax.faces.component.StateHolder
- Overrides:
- saveStatein class- javax.faces.component.UIComponentBase
 
- 
 
restoreState
public void restoreState(javax.faces.context.FacesContext context,
                         Object state)
- 
- Specified by:
- restoreStatein interface- javax.faces.component.StateHolder
- Overrides:
- restoreStatein class- javax.faces.component.UIComponentBase
 
- 
 
processSaveState
public Object processSaveState(javax.faces.context.FacesContext context)
- 
- Overrides:
- processSaveStatein class- javax.faces.component.UIComponentBase
 
- 
 
processRestoreState
public void processRestoreState(javax.faces.context.FacesContext context,
                                Object state)
- 
- Overrides:
- processRestoreStatein class- javax.faces.component.UIComponentBase
 
- 
 
processValidators
public void processValidators(javax.faces.context.FacesContext context)
- 
- Overrides:
- processValidatorsin class- javax.faces.component.UIComponentBase
 
- 
 
processDecodes
public void processDecodes(javax.faces.context.FacesContext context)
- 
- Overrides:
- processDecodesin class- javax.faces.component.UIComponentBase
 
- 
 
processUpdates
public void processUpdates(javax.faces.context.FacesContext context)
- 
- Overrides:
- processUpdatesin class- javax.faces.component.UIComponentBase
 
- 
 
encodeBegin
public void encodeBegin(javax.faces.context.FacesContext context)
                 throws IOException
- 
- Overrides:
- encodeBeginin class- javax.faces.component.UIComponentBase
 
- 
- Throws:
- IOException
 
encodeEnd
public void encodeEnd(javax.faces.context.FacesContext context)
               throws IOException
- 
- Overrides:
- encodeEndin class- javax.faces.component.UIComponentBase
 
- 
- Throws:
- IOException
 
queueEvent
public void queueEvent(javax.faces.event.FacesEvent event)
- 
- Overrides:
- queueEventin class- javax.faces.component.UIComponentBase
 
- 
 
broadcast
public void broadcast(javax.faces.event.FacesEvent event)
               throws javax.faces.event.AbortProcessingException
- 
- Overrides:
- broadcastin class- javax.faces.component.UIComponentBase
 
- 
- Throws:
- javax.faces.event.AbortProcessingException
 
handleBindings
public void handleBindings()
- 
- Specified by:
- handleBindingsin interface- BindingAware
 
- 
 
invokeOnComponent
public boolean invokeOnComponent(javax.faces.context.FacesContext context,
                                 String clientId,
                                 javax.faces.component.ContextCallback callback)
                          throws javax.faces.FacesException
- 
- Overrides:
- invokeOnComponentin class- javax.faces.component.UIComponentBase
 
- 
- Throws:
- javax.faces.FacesException
 
Copyright © 2012 The Apache Software Foundation. All Rights Reserved.