org.butterfaces.component.html.table

Class HtmlTable

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

javax.faces.component.UIData

org.butterfaces.component.html.table.HtmlTable

All Implemented Interfaces:

EventListener, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.NamingContainer, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.component.UniqueIdVendor, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder

public class HtmlTable
extends javax.faces.component.UIData
implements javax.faces.component.behavior.ClientBehaviorHolder

Author:

Lars Michaelis

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPONENT_FAMILY
static String	COMPONENT_TYPE
protected static String	PROPERTY_AJAX_DISABLE_RENDER_REGION_ON_REQUEST
protected static String	PROPERTY_MODEL
protected static String	PROPERTY_SINGLE_SELECTION_LISTENER
protected static String	PROPERTY_STYLE
protected static String	PROPERTY_STYLE_CLASS
protected static String	PROPERTY_TABLE_BORDERED
protected static String	PROPERTY_TABLE_CONDENSED
protected static String	PROPERTY_TABLE_ROW_CLASS
protected static String	PROPERTY_TABLE_STRIPED
protected static String	PROPERTY_UNIQUE_IDENTIFIER
static String	RENDERER_TYPE

Fields inherited from class javax.faces.component.UIComponent

ATTRS_WITH_DECLARED_DEFAULT_VALUES, BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, HONOR_CURRENT_COMPONENT_ATTRIBUTES_PARAM_NAME, VIEW_LOCATION_KEY

Fields inherited from interface javax.faces.component.NamingContainer

SEPARATOR_CHAR

Constructor Summary

Constructors

Constructor and Description
HtmlTable()

Method Summary

Modifier and Type	Method and Description
void	clearMetaInfo(javax.faces.context.FacesContext context, javax.faces.component.UIComponent table) Removes the cached TableColumnCache from the specified component.
String	getDefaultEventName()
Collection<String>	getEventNames()
String	getFamily()
TableModel	getModel()
String	getModelUniqueIdentifier()
String	getRowClass()
TableSingleSelectionListener	getSingleSelectionListener()
String	getStyle()
String	getStyleClass()
TableColumnCache	getTableColumnCache(javax.faces.context.FacesContext context) Returns a TableColumnCache object containing details such as row and column classes, cachedColumns, and a mechanism for scrolling through the row/column classes.
TableColumnVisibilityModel	getTableColumnVisibilityModel()
TableColumnOrderingModel	getTableOrderingModel()
TableRowSortingModel	getTableSortModel()
String	getUniqueIdentifier()
boolean	invokeOnComponent(javax.faces.context.FacesContext context, String clientId, javax.faces.component.ContextCallback callback)
boolean	isAjaxDisableRenderRegionsOnRequest()
boolean	isHideColumn(HtmlColumn column)
boolean	isTableBordered()
boolean	isTableCondensed()
boolean	isTableStriped()
void	setAjaxDisableRenderRegionsOnRequest(boolean ajaxDisableRenderRegionsOnRequest)
void	setModel(TableModel tableModel)
void	setRowClass(String rowClass)
void	setSingleSelectionListener(TableSingleSelectionListener singleSelectionListener)
void	setStyle(String style)
void	setStyleClass(String styleClass)
void	setTableBordered(boolean tableBordered)
void	setTableCondensed(boolean tableCondensed)
void	setTableStriped(boolean tableStriped)
void	setUniqueIdentifier(String uniqueIdentifier)

Methods inherited from class javax.faces.component.UIData

broadcast, createUniqueId, encodeBegin, getClientId, getDataModel, getFirst, getFooter, getHeader, getRowCount, getRowData, getRowIndex, getRows, getValue, getVar, isRowAvailable, isRowStatePreserved, markInitialState, processDecodes, processUpdates, processValidators, queueEvent, restoreState, saveState, setDataModel, setFirst, setFooter, setHeader, setRowIndex, setRows, setRowStatePreserved, setValue, setValueBinding, setValueExpression, setVar, visitTree

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, addFacesListener, clearInitialState, decode, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView

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.behavior.ClientBehaviorHolder

addClientBehavior, getClientBehaviors

Field Detail

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

RENDERER_TYPE

public static final String RENDERER_TYPE

See Also:

Constant Field Values

PROPERTY_UNIQUE_IDENTIFIER

protected static final String PROPERTY_UNIQUE_IDENTIFIER

See Also:

Constant Field Values

PROPERTY_TABLE_CONDENSED

protected static final String PROPERTY_TABLE_CONDENSED

See Also:

Constant Field Values

PROPERTY_TABLE_BORDERED

protected static final String PROPERTY_TABLE_BORDERED

See Also:

Constant Field Values

PROPERTY_TABLE_STRIPED

protected static final String PROPERTY_TABLE_STRIPED

See Also:

Constant Field Values

PROPERTY_AJAX_DISABLE_RENDER_REGION_ON_REQUEST

protected static final String PROPERTY_AJAX_DISABLE_RENDER_REGION_ON_REQUEST

See Also:

Constant Field Values

PROPERTY_MODEL

protected static final String PROPERTY_MODEL

See Also:

Constant Field Values

PROPERTY_TABLE_ROW_CLASS

protected static final String PROPERTY_TABLE_ROW_CLASS

See Also:

Constant Field Values

PROPERTY_STYLE_CLASS

protected static final String PROPERTY_STYLE_CLASS

See Also:

Constant Field Values

PROPERTY_STYLE

protected static final String PROPERTY_STYLE

See Also:

Constant Field Values

PROPERTY_SINGLE_SELECTION_LISTENER

protected static final String PROPERTY_SINGLE_SELECTION_LISTENER

See Also:

Constant Field Values

Constructor Detail

HtmlTable

public HtmlTable()

Method Detail

getEventNames

public Collection<String> getEventNames()

Specified by:

getEventNames in interface javax.faces.component.behavior.ClientBehaviorHolder

Overrides:

getEventNames in class javax.faces.component.UIComponentBase

getDefaultEventName

public String getDefaultEventName()

Specified by:

getDefaultEventName in interface javax.faces.component.behavior.ClientBehaviorHolder

Overrides:

getDefaultEventName in class javax.faces.component.UIComponentBase

getFamily

public String getFamily()

Overrides:

getFamily in class javax.faces.component.UIData

getTableColumnCache

public TableColumnCache getTableColumnCache(javax.faces.context.FacesContext context)

Returns a TableColumnCache object containing details such as row and column classes, cachedColumns, and a mechanism for scrolling through the row/column classes.

Parameters:

context - the FacesContext for the current request

Returns:

the TableColumnCache for provided table

clearMetaInfo

public void clearMetaInfo(javax.faces.context.FacesContext context,
                          javax.faces.component.UIComponent table)

Removes the cached TableColumnCache from the specified component.

Parameters:

context - the FacesContext for the current request

table - the table from which the TableColumnCache will be removed

invokeOnComponent

public boolean invokeOnComponent(javax.faces.context.FacesContext context,
                                 String clientId,
                                 javax.faces.component.ContextCallback callback)
                          throws javax.faces.FacesException

Overrides:

invokeOnComponent in class javax.faces.component.UIData

Throws:

javax.faces.FacesException

isHideColumn

public boolean isHideColumn(HtmlColumn column)

getStyleClass

public String getStyleClass()

setStyleClass

public void setStyleClass(String styleClass)

getStyle

public String getStyle()

setStyle

public void setStyle(String style)

getModelUniqueIdentifier

public String getModelUniqueIdentifier()

getSingleSelectionListener

public TableSingleSelectionListener getSingleSelectionListener()

setSingleSelectionListener

public void setSingleSelectionListener(TableSingleSelectionListener singleSelectionListener)

getModel

public TableModel getModel()

getTableSortModel

public TableRowSortingModel getTableSortModel()

getTableOrderingModel

public TableColumnOrderingModel getTableOrderingModel()

getTableColumnVisibilityModel

public TableColumnVisibilityModel getTableColumnVisibilityModel()

setModel

public void setModel(TableModel tableModel)

getUniqueIdentifier

public String getUniqueIdentifier()

setUniqueIdentifier

public void setUniqueIdentifier(String uniqueIdentifier)

isTableCondensed

public boolean isTableCondensed()

setTableCondensed

public void setTableCondensed(boolean tableCondensed)

isTableBordered

public boolean isTableBordered()

setTableBordered

public void setTableBordered(boolean tableBordered)

isTableStriped

public boolean isTableStriped()

setTableStriped

public void setTableStriped(boolean tableStriped)

getRowClass

public String getRowClass()

setRowClass

public void setRowClass(String rowClass)

isAjaxDisableRenderRegionsOnRequest

public boolean isAjaxDisableRenderRegionsOnRequest()

setAjaxDisableRenderRegionsOnRequest

public void setAjaxDisableRenderRegionsOnRequest(boolean ajaxDisableRenderRegionsOnRequest)