com.sun.rave.web.ui.component
Class TableFooter

java.lang.Object
  extended by javax.faces.component.UIComponent
      extended by javax.faces.component.UIComponentBase
          extended by com.sun.rave.web.ui.component.TableFooterBase
              extended by com.sun.rave.web.ui.component.TableFooter
All Implemented Interfaces:
javax.faces.component.NamingContainer, javax.faces.component.StateHolder

public class TableFooter
extends TableFooterBase
implements javax.faces.component.NamingContainer

Component that represents a table footer.

Note: Column headers and footers are rendered by TableRowGroupRenderer. Table column footers are rendered by TableRenderer.

Note: To see the messages logged by this class, set the following global defaults in your JDK's "jre/lib/logging.properties" file.

 java.util.logging.ConsoleHandler.level = FINE
 com.sun.rave.web.ui.component.TableFooter.level = FINE
 


Field Summary
 
Fields inherited from class javax.faces.component.UIComponent
bindings
 
Fields inherited from interface javax.faces.component.NamingContainer
SEPARATOR_CHAR
 
Constructor Summary
TableFooter()
          Default constructor
 
Method Summary
 void encodeBegin(javax.faces.context.FacesContext context)
          If the rendered property is true, render the begining of the current state of this UIComponent to the response contained in the specified FacesContext.
 int getSortLevel()
          Helper method to get sort level for this component.
 Table getTableAncestor()
          Get the closest Table ancestor that encloses this component.
 TableColumn getTableColumnAncestor()
          Get the closest TableColumn ancestor that encloses this component.
 TableRowGroup getTableRowGroupAncestor()
          Get the closest TableRowGroup ancestor that encloses this component.
 
Methods inherited from class com.sun.rave.web.ui.component.TableFooterBase
getAbbr, getAlign, getAxis, getBgColor, getChar, getCharOff, getColSpan, getExtraHtml, getFamily, getHeaders, getHeight, getOnClick, getOnDblClick, getOnKeyDown, getOnKeyPress, getOnKeyUp, getOnMouseDown, getOnMouseMove, getOnMouseOut, getOnMouseOver, getOnMouseUp, getRowSpan, getScope, getStyle, getStyleClass, getToolTip, getValign, getWidth, isGroupFooter, isNoWrap, isTableColumnFooter, isTableFooter, isVisible, restoreState, saveState, setAbbr, setAlign, setAxis, setBgColor, setChar, setCharOff, setColSpan, setExtraHtml, setGroupFooter, setHeaders, setHeight, setNoWrap, setOnClick, setOnDblClick, setOnKeyDown, setOnKeyPress, setOnKeyUp, setOnMouseDown, setOnMouseMove, setOnMouseOut, setOnMouseOver, setOnMouseUp, setRowSpan, setScope, setStyle, setStyleClass, setTableColumnFooter, setTableFooter, setToolTip, setValign, setVisible, setWidth
 
Methods inherited from class javax.faces.component.UIComponentBase
addFacesListener, broadcast, decode, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, 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
 

Constructor Detail

TableFooter

public TableFooter()
Default constructor

Method Detail

getSortLevel

public int getSortLevel()
Helper method to get sort level for this component.

Returns:
The sort level or 0 if sort does not apply.

getTableAncestor

public Table getTableAncestor()
Get the closest Table ancestor that encloses this component.

Returns:
The Table ancestor.

getTableColumnAncestor

public TableColumn getTableColumnAncestor()
Get the closest TableColumn ancestor that encloses this component.

Returns:
The TableColumn ancestor.

getTableRowGroupAncestor

public TableRowGroup getTableRowGroupAncestor()
Get the closest TableRowGroup ancestor that encloses this component.

Returns:
The TableRowGroup ancestor.

encodeBegin

public void encodeBegin(javax.faces.context.FacesContext context)
                 throws java.io.IOException
If the rendered property is true, render the begining of the current state of this UIComponent to the response contained in the specified FacesContext. If a Renderer is associated with this UIComponent, the actual encoding will be delegated to Renderer.encodeBegin(FacesContext, UIComponent).

Overrides:
encodeBegin in class javax.faces.component.UIComponentBase
Parameters:
context - FacesContext for the current request.
Throws:
java.io.IOException - if an input/output error occurs while rendering.
java.lang.NullPointerException - if FacesContext is null.