org.apache.myfaces.trinidad.component
Class UIXComponent

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by org.apache.myfaces.trinidad.component.UIXComponent
All Implemented Interfaces:
javax.faces.component.StateHolder
Direct Known Subclasses:
UIXComponentBase

public abstract class UIXComponent
extends javax.faces.component.UIComponent

Pure abstract base class for all UIX components.


Field Summary
 
Fields inherited from class javax.faces.component.UIComponent
bindings
 
Constructor Summary
UIXComponent()
           
 
Method Summary
abstract  void addAttributeChangeListener(AttributeChangeListener acl)
          Adds an AttributeChangeListener.
abstract  javax.el.MethodExpression getAttributeChangeListener()
          Gets the method binding to an AttributeChangeListener.
abstract  AttributeChangeListener[] getAttributeChangeListeners()
          Gets the registered AttributeChangeListeners.
abstract  java.lang.String getContainerClientId(javax.faces.context.FacesContext context, javax.faces.component.UIComponent child)
          Provides additional context (the target child component for which the container client ID is requested) to a naming container for constructing a client ID.
abstract  FacesBean getFacesBean()
          Returns the FacesBean used for storing the component's state.
abstract  void markInitialState()
           
static
<S> boolean
processFlattenedChildren(javax.faces.context.FacesContext context, ComponentProcessingContext cpContext, ComponentProcessor<S> childProcessor, java.lang.Iterable<javax.faces.component.UIComponent> children, S callbackContext)
          Helper function called by FlattenedComponents to iterate over a flattened view of their children, potentially themselves FlattenedComponents, invoking the childProcessor with its callbackContext on each renderable instance.
static
<S> boolean
processFlattenedChildren(javax.faces.context.FacesContext context, ComponentProcessingContext cpContext, ComponentProcessor<S> childProcessor, javax.faces.component.UIComponent child, S callbackContext)
          Helper function called by FlattenedComponent to iterate over a flattened view of a group of potentially FlattenedComponent instances rooted at a single child of the FlattenedComponent, invoking the childProcessor with its callbackContext on each renderable instance.
static
<S> boolean
processFlattenedChildren(javax.faces.context.FacesContext context, ComponentProcessor<S> childProcessor, java.lang.Iterable<javax.faces.component.UIComponent> children, S callbackContext)
          Helper function called by Renderers to iterate over a flattened view of the children, potentially containing FlattenedComponents, of the component the Renderer is encoding, invoking the childProcessor with its callbackContext on each renderable instance.
static
<S> boolean
processFlattenedChildren(javax.faces.context.FacesContext context, ComponentProcessor<S> childProcessor, javax.faces.component.UIComponent child, S callbackContext)
          Helper function called by Renderers to iterate over a flattened view of a group of potentially FlattenedComponent instances rooted at a single child of the component that the Renderer is encoding, invoking the childProcessor with its callbackContext on each renderable instance.
abstract  void removeAttributeChangeListener(AttributeChangeListener acl)
          Removes an AttributeChangeListener.
abstract  void setAttributeChangeListener(javax.el.MethodExpression me)
          Sets a method binding to an AttributeChangeListener.
 
Methods inherited from class javax.faces.component.UIComponent
addFacesListener, broadcast, decode, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getContainerClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getFamily, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, invokeOnComponent, isRendered, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, setId, setParent, setRendered, setRendererType, setValueBinding, setValueExpression
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface javax.faces.component.StateHolder
isTransient, restoreState, saveState, setTransient
 

Constructor Detail

UIXComponent

public UIXComponent()
Method Detail

processFlattenedChildren

public static <S> boolean processFlattenedChildren(javax.faces.context.FacesContext context,
                                                   ComponentProcessor<S> childProcessor,
                                                   javax.faces.component.UIComponent child,
                                                   S callbackContext)
                                        throws java.io.IOException
Helper function called by Renderers to iterate over a flattened view of a group of potentially FlattenedComponent instances rooted at a single child of the component that the Renderer is encoding, invoking the childProcessor with its callbackContext on each renderable instance.

If the child is a FlattenedComponent, the childProcessor will be called on each of that FlattenedComponent's children, recursing if those children are themselves FlattenedComponents, otherwise, the childProcessor will be called on the child itself.

This method is typically used to flatten the contents of a facet on the FlattenedComponent to be encoded. If the Renderer accidentally passes in the component to be encoded instead of one of its children, the result will almost certainly be an infinite recursion and stack overflow.

Throws:
java.io.IOException
See Also:
processFlattenedChildren(FacesContext, ComponentProcessor, Iterable, Object), processFlattenedChildren(FacesContext, ComponentProcessingContext, ComponentProcessor, UIComponent, Object), processFlattenedChildren(FacesContext, ComponentProcessingContext, ComponentProcessor, Iterable, Object), FlattenedComponent

processFlattenedChildren

public static <S> boolean processFlattenedChildren(javax.faces.context.FacesContext context,
                                                   ComponentProcessingContext cpContext,
                                                   ComponentProcessor<S> childProcessor,
                                                   javax.faces.component.UIComponent child,
                                                   S callbackContext)
                                        throws java.io.IOException
Helper function called by FlattenedComponent to iterate over a flattened view of a group of potentially FlattenedComponent instances rooted at a single child of the FlattenedComponent, invoking the childProcessor with its callbackContext on each renderable instance.

If the child is a FlattenedComponent, the childProcessor will be called on each of that FlattenedComponent's children, recursing if those children are themselves FlattenedComponents, otherwise, the childProcessor will be called on the child itself.

This method is typically used to flatten the contents of a facet of the FlattenedComponent. If the FlattenedComponent accidentally passes in itself instead of one of its children, the result will almost certainly be an infinite recursion and stack overflow.

Throws:
java.io.IOException
See Also:
processFlattenedChildren(FacesContext, ComponentProcessor, UIComponent, Object), processFlattenedChildren(FacesContext, ComponentProcessor, Iterable, Object), processFlattenedChildren(FacesContext, ComponentProcessingContext, ComponentProcessor, Iterable, Object), FlattenedComponent

processFlattenedChildren

public static <S> boolean processFlattenedChildren(javax.faces.context.FacesContext context,
                                                   ComponentProcessor<S> childProcessor,
                                                   java.lang.Iterable<javax.faces.component.UIComponent> children,
                                                   S callbackContext)
                                        throws java.io.IOException
Helper function called by Renderers to iterate over a flattened view of the children, potentially containing FlattenedComponents, of the component the Renderer is encoding, invoking the childProcessor with its callbackContext on each renderable instance.

For each FlattenedComponent child, the childProcessor will be called on each of that FlattenedComponent's children, recursing if those children are themselves FlattenedComponents, otherwise, the childProcessor will be called on the child itself.

This method is typically used to flatten the children of the FlattenedComponent to be encoded.

Throws:
java.io.IOException
See Also:
processFlattenedChildren(FacesContext, ComponentProcessor, UIComponent, Object), processFlattenedChildren(FacesContext, ComponentProcessingContext, ComponentProcessor, UIComponent, Object), processFlattenedChildren(FacesContext, ComponentProcessingContext, ComponentProcessor, Iterable, Object), FlattenedComponent

processFlattenedChildren

public static <S> boolean processFlattenedChildren(javax.faces.context.FacesContext context,
                                                   ComponentProcessingContext cpContext,
                                                   ComponentProcessor<S> childProcessor,
                                                   java.lang.Iterable<javax.faces.component.UIComponent> children,
                                                   S callbackContext)
                                        throws java.io.IOException
Helper function called by FlattenedComponents to iterate over a flattened view of their children, potentially themselves FlattenedComponents, invoking the childProcessor with its callbackContext on each renderable instance.

For each FlattenedComponent child, the childProcessor will be called on each of that FlattenedComponent's children, recursing if those children are themselves FlattenedComponents, otherwise, the childProcessor will be called on the child itself.

Throws:
java.io.IOException
See Also:
processFlattenedChildren(FacesContext, ComponentProcessor, UIComponent, Object), processFlattenedChildren(FacesContext, ComponentProcessor, Iterable, Object), processFlattenedChildren(FacesContext, ComponentProcessingContext, ComponentProcessor, UIComponent, Object), FlattenedComponent

getFacesBean

public abstract FacesBean getFacesBean()
Returns the FacesBean used for storing the component's state.


addAttributeChangeListener

public abstract void addAttributeChangeListener(AttributeChangeListener acl)
Adds an AttributeChangeListener. 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.


removeAttributeChangeListener

public abstract void removeAttributeChangeListener(AttributeChangeListener acl)
Removes an AttributeChangeListener. 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.


getAttributeChangeListeners

public abstract AttributeChangeListener[] getAttributeChangeListeners()
Gets the registered AttributeChangeListeners.


setAttributeChangeListener

public abstract void setAttributeChangeListener(javax.el.MethodExpression me)
Sets a method binding to an AttributeChangeListener. 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.


getAttributeChangeListener

public abstract javax.el.MethodExpression getAttributeChangeListener()
Gets the method binding to an AttributeChangeListener. 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.


markInitialState

public abstract void markInitialState()

getContainerClientId

public abstract java.lang.String getContainerClientId(javax.faces.context.FacesContext context,
                                                      javax.faces.component.UIComponent child)
Provides additional context (the target child component for which the container client ID is requested) to a naming container for constructing a client ID. This is useful for components such as @link UIXTable and @link UIXTreeTable which need to return different container client IDs for stamped and non-stamped child components.

See Also:
UIXComponentBase.getClientId(FacesContext context)


Copyright © 2001-2008 The Apache Software Foundation. All Rights Reserved.