javax.faces.component
Class UIColumn

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by javax.faces.component.UIColumn
All Implemented Interfaces:
StateHolder
Direct Known Subclasses:
HtmlColumn

public class UIColumn
extends UIComponentBase

UIColumn is a UIComponent that represents a single column of data within a parent UIData component.


Field Summary
static java.lang.String COMPONENT_FAMILY
          The standard component family for this component.
static java.lang.String COMPONENT_TYPE
          The standard component type for this component.
 
Constructor Summary
UIColumn()
          Create a new UIColumn instance with default property values.
 
Method Summary
 java.lang.String getFamily()
          Return the identifier of the component family to which this component belongs.
 UIComponent getFooter()
          Return the footer facet of the column (if any).
 UIComponent getHeader()
          Return the header facet of the column (if any).
 void setFooter(UIComponent footer)
          Set the footer facet of the column.
 void setHeader(UIComponent header)
          Set the header facet of the column.
 
Methods inherited from class javax.faces.component.UIComponentBase
addFacesListener, broadcast, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, getValueExpression, invokeOnComponent, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, setValueExpression
 
Methods inherited from class javax.faces.component.UIComponent
encodeAll, getContainerClientId
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

The standard component type for this component.

See Also:
Constant Field Values

COMPONENT_FAMILY

public static final java.lang.String COMPONENT_FAMILY

The standard component family for this component.

See Also:
Constant Field Values
Constructor Detail

UIColumn

public UIColumn()

Create a new UIColumn instance with default property values.

Method Detail

getFamily

public java.lang.String getFamily()
Description copied from class: UIComponent

Return the identifier of the component family to which this component belongs. This identifier, in conjunction with the value of the rendererType property, may be used to select the appropriate Renderer for this component instance.

Specified by:
getFamily in class UIComponent

getFooter

public UIComponent getFooter()

Return the footer facet of the column (if any). A convenience method for getFacet("footer").


setFooter

public void setFooter(UIComponent footer)

Set the footer facet of the column. A convenience method for getFacets().put("footer", footer).

Parameters:
footer - the new footer facet
Throws:
java.lang.NullPointerException - if footer is null

getHeader

public UIComponent getHeader()

Return the header facet of the column (if any). A convenience method for getFacet("header").


setHeader

public void setHeader(UIComponent header)

Set the header facet of the column. A convenience method for getFacets().put("header", header).

Parameters:
header - the new header facet
Throws:
java.lang.NullPointerException - if header is null


Copyright 2002-2006 Sun Microsystems, Inc. All Rights Reserved.