org.apache.myfaces.trinidad.component
Class UIXDecorateCollection

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by org.apache.myfaces.trinidad.component.UIXComponent
          extended by org.apache.myfaces.trinidad.component.UIXComponentBase
              extended by org.apache.myfaces.trinidad.component.UIXDecorateCollection
All Implemented Interfaces:
javax.faces.component.NamingContainer, javax.faces.component.StateHolder

public class UIXDecorateCollection
extends UIXComponentBase
implements javax.faces.component.NamingContainer

Events:

Type Phases Description
org.apache.myfaces.trinidad.event.AttributeChangeEvent 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 FacesBean.Type TYPE
           
 
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
  UIXDecorateCollection()
          Construct an instance of the UIXDecorateCollection.
protected UIXDecorateCollection(java.lang.String rendererType)
          Construct an instance of the UIXDecorateCollection.
 
Method Summary
protected  FacesBean.Type getBeanType()
           
 java.lang.String getContainerClientId(javax.faces.context.FacesContext context)
          Gets the client-id of this component, without any NamingContainers.
 java.lang.String getCurrencyString()
          Gets the currency String for this decorate collection.
 java.lang.String getFamily()
           
 void setCurrencyString(java.lang.String currency)
          Sets the currency String for this decorate collection.
 
Methods inherited from class org.apache.myfaces.trinidad.component.UIXComponentBase
adaptMethodBinding, addAttributeChange, addAttributeChangeListener, addFacesListener, broadcast, broadcastToMethodBinding, broadcastToMethodExpression, createFacesBean, decode, decodeChildren, decodeChildrenImpl, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributeChangeListener, getAttributeChangeListeners, getAttributes, getBooleanProperty, getChildCount, getChildren, getClientId, getFacesBean, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacetNames, getFacets, getFacetsAndChildren, getId, getIntProperty, getLifecycleRenderer, getParent, getProperty, getPropertyKey, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, 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 javax.faces.component.UIComponent
invokeOnComponent
 
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

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

UIXDecorateCollection

public UIXDecorateCollection()
Construct an instance of the UIXDecorateCollection.


UIXDecorateCollection

protected UIXDecorateCollection(java.lang.String rendererType)
Construct an instance of the UIXDecorateCollection.

Method Detail

getCurrencyString

public java.lang.String getCurrencyString()
Gets the currency String for this decorate collection.

Returns:
the current established currency
See Also:
setCurrencyString(java.lang.String)

setCurrencyString

public void setCurrencyString(java.lang.String currency)
Sets the currency String for this decorate collection. The decorator renders aggregated components that are not in the component tree. If any of the aggregated component is a naming container (for e.g. menubar), this method allows the currency to be set to that naming container so that it can successfully decode its children.

Parameters:
currency - the currency to be established
See Also:
getCurrencyString()

getContainerClientId

public final java.lang.String getContainerClientId(javax.faces.context.FacesContext context)
Gets the client-id of this component, without any NamingContainers. This id changes depending on the currency Object. Because this implementation uses currency strings, the local client ID is not stable for very long. Its lifetime is the same as that of a currency string.

Overrides:
getContainerClientId in class javax.faces.component.UIComponent
Returns:
the local clientId
See Also:
getCurrencyString()

getFamily

public java.lang.String getFamily()
Specified by:
getFamily in class UIXComponentBase

getBeanType

protected FacesBean.Type getBeanType()
Overrides:
getBeanType in class UIXComponentBase


Copyright © 2001-2007 Apache Software Foundation. All Rights Reserved.