org.primefaces.component.treetable

Class TreeTable

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

org.primefaces.component.api.UITree

org.primefaces.component.treetable.TreeTableBase

org.primefaces.component.treetable.TreeTable

All Implemented Interfaces:

EventListener, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.NamingContainer, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, Pageable, PrimeClientBehaviorHolder, Widget

public class TreeTable
extends TreeTableBase

Nested Class Summary

Nested classes/interfaces inherited from class org.primefaces.component.treetable.TreeTableBase

TreeTableBase.PropertyKeys

Field Summary

Fields

Modifier and Type	Field and Description
static String	COLLAPSE_ICON
static String	COLUMN_CONTENT_WRAPPER
static String	COLUMN_CUSTOM_FILTER_CLASS
static String	COLUMN_HEADER_CLASS
static String	COLUMN_INPUT_FILTER_CLASS
static String	COMPONENT_TYPE
static String	CONTAINER_CLASS
static String	DATA_CLASS
static String	EDITABLE_COLUMN_CLASS
static String	EDITING_ROW_CLASS
static String	EMPTY_MESSAGE_ROW_CLASS
static String	EXPAND_ICON
static String	FILTER_COLUMN_CLASS
static String	FOOTER_CLASS
static String	HEADER_CLASS
static String	HIDDEN_COLUMN_CLASS
static String	INDENT_CLASS
static String	PARTIAL_SELECTED_CLASS
static String	REFLOW_CLASS
static String	RESIZABLE_COLUMN_CLASS
static String	RESIZABLE_CONTAINER_CLASS
static String	ROW_CLASS
static String	SCROLLABLE_BODY_CLASS
static String	SCROLLABLE_CONTAINER_CLASS
static String	SCROLLABLE_FOOTER_BOX_CLASS
static String	SCROLLABLE_FOOTER_CLASS
static String	SCROLLABLE_HEADER_BOX_CLASS
static String	SCROLLABLE_HEADER_CLASS
static String	SELECTABLE_NODE_CLASS
static String	SELECTED_ROW_CLASS
static String	SORTABLE_COLUMN_ASCENDING_ICON_CLASS
static String	SORTABLE_COLUMN_DESCENDING_ICON_CLASS
static String	SORTABLE_COLUMN_HEADER_CLASS
static String	SORTABLE_COLUMN_ICON_CLASS
static String	STATIC_COLUMN_CLASS

Fields inherited from class org.primefaces.component.treetable.TreeTableBase

COMPONENT_FAMILY, DEFAULT_RENDERER

Fields inherited from class org.primefaces.component.api.UITree

CHECKBOX_CLASS, REQUIRED_MESSAGE_ID, ROOT_ROW_KEY, SEPARATOR

Fields inherited from class javax.faces.component.UIComponent

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

Fields inherited from interface javax.faces.component.NamingContainer

SEPARATOR_CHAR

Constructor Summary

Constructors

Constructor and Description
TreeTable()

Method Summary

Modifier and Type	Method and Description
void	calculateFirst()
void	clearDefaultSorted()
void	enableFiltering()
UIColumn	findColumn(String columnKey)
Map<String,Class<? extends javax.faces.event.BehaviorEvent>>	getBehaviorEventMapping()
ColumnGroup	getColumnGroup(String target)
List<UIColumn>	getColumns()
int	getColumnsCount()
Columns	getDynamicColumns()
Collection<String>	getEventNames()
List<String>	getFilteredRowKeys()
List<FilterMeta>	getFilterMetadata()
javax.faces.component.UIComponent	getFooter()
javax.faces.component.UIComponent	getHeader()
int	getPage()
int	getPageCount()
int	getRowCount()
int	getRowsToRender()
String	getScrollState()
UIColumn	getSortColumn()
boolean	hasFooterColumn()
boolean	isCellEditCancelRequest(javax.faces.context.FacesContext context)
boolean	isCellEditInitRequest(javax.faces.context.FacesContext context)
boolean	isCellEditRequest(javax.faces.context.FacesContext context)
boolean	isCheckboxSelection()
boolean	isDefaultSorted()
boolean	isFilteringEnabled()
boolean	isFilterRequest(javax.faces.context.FacesContext context)
boolean	isPaginationRequest(javax.faces.context.FacesContext context)
boolean	isResizeRequest(javax.faces.context.FacesContext context)
boolean	isRowEditRequest(javax.faces.context.FacesContext context)
boolean	isSelectionRequest(javax.faces.context.FacesContext context)
boolean	isSortRequest(javax.faces.context.FacesContext context)
List<FilterMeta>	populateFilterBy(javax.faces.context.FacesContext context, TreeTable tt)
protected void	preDecode(javax.faces.context.FacesContext context)
protected void	preEncode(javax.faces.context.FacesContext context)
protected void	preUpdate(javax.faces.context.FacesContext context)
protected void	preValidate(javax.faces.context.FacesContext context)
void	processDecodes(javax.faces.context.FacesContext context)
void	processValidators(javax.faces.context.FacesContext context)
void	queueEvent(javax.faces.event.FacesEvent event)
Locale	resolveDataLocale()
Object	saveState(javax.faces.context.FacesContext context)
void	setColumns(List<UIColumn> columns)
void	setDefaultSorted()
void	setDynamicColumns(Columns value)
void	setFilteredRowKeys(List<String> filteredRowKeys)
void	setFilterMetadata(List<FilterMeta> filterMetadata)
void	setSortColumn(UIColumn column)
void	updateColumnsVisibility(javax.faces.context.FacesContext context)
void	updateFilteredNode(javax.faces.context.FacesContext context, TreeNode node)
void	updatePaginationData(javax.faces.context.FacesContext context)
protected void	validateSelection(javax.faces.context.FacesContext context)

Methods inherited from class org.primefaces.component.treetable.TreeTableBase

getCellEditMode, getCellSeparator, getCurrentPageReportTemplate, getDataLocale, getEditMode, getEmptyMessage, getExpandMode, getFamily, getFilterDelay, getFilteredNode, getFilterEvent, getFirst, getPageLinks, getPaginatorPosition, getPaginatorTemplate, getRows, getRowsPerPageLabel, getRowsPerPageTemplate, getRowStyleClass, getScrollHeight, getScrollWidth, getSortBy, getSortFunction, getSortOrder, getStyle, getStyleClass, getTableStyle, getTableStyleClass, getWidgetVar, isCaseSensitiveSort, isDisabledTextSelection, isEditable, isEditingRow, isLiveResize, isNativeElements, isPaginator, isPaginatorAlwaysVisible, isResizableColumns, isScrollable, isStickyHeader, setCaseSensitiveSort, setCellEditMode, setCellSeparator, setCurrentPageReportTemplate, setDataLocale, setDisabledTextSelection, setEditable, setEditingRow, setEditMode, setEmptyMessage, setExpandMode, setFilterDelay, setFilteredNode, setFilterEvent, setFirst, setLiveResize, setNativeElements, setPageLinks, setPaginator, setPaginatorAlwaysVisible, setPaginatorPosition, setPaginatorTemplate, setResizableColumns, setRows, setRowsPerPageLabel, setRowsPerPageTemplate, setRowStyleClass, setScrollable, setScrollHeight, setScrollWidth, setSortBy, setSortFunction, setSortOrder, setStickyHeader, setStyle, setStyleClass, setTableStyle, setTableStyleClass, setWidgetVar

Methods inherited from class org.primefaces.component.api.UITree

broadcast, buildRowKeys, doVisitChildren, encodeBegin, findTreeNode, getContainerClientId, getLocalSelectedNodes, getNodeVar, getRequiredMessage, getRowKey, getRowNode, getSelectedRowKeysAsString, getSelection, getSelectionMode, getValue, getVar, initPreselection, invokeOnComponent, isNestedWithinIterator, isPropagateSelectionDown, isPropagateSelectionUp, isRequired, isRTLRendering, isShowUnselectableCheckbox, isSkipChildren, populateRowKeys, processColumnChildren, processColumnFacets, processComponent, processFacets, processNode, processNodes, processUpdates, refreshSelectedNodeKeys, requiresIteration, setNodeVar, setPropagateSelectionDown, setPropagateSelectionUp, setRequired, setRequiredMessage, setRowKey, setRTLRendering, setSelection, setSelectionMode, setShowUnselectableCheckbox, setSkipChildren, setValue, setVar, shouldVisitNode, updateRowKeys, updateSelection, visitColumnContent, visitFacets, visitNode, visitNodes, visitTree

Methods inherited from class javax.faces.component.UIComponentBase

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

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, setInView, setValueExpression, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.primefaces.component.api.Widget

resolveWidgetVar, resolveWidgetVar

Methods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder

addClientBehavior, getClientBehaviors, getDefaultEventName

Methods inherited from interface org.primefaces.component.api.Pageable

getClientId, getFacet

Field Detail

COMPONENT_TYPE

public static final String COMPONENT_TYPE

See Also:

Constant Field Values

CONTAINER_CLASS

public static final String CONTAINER_CLASS

See Also:

Constant Field Values

RESIZABLE_CONTAINER_CLASS

public static final String RESIZABLE_CONTAINER_CLASS

See Also:

Constant Field Values

HEADER_CLASS

public static final String HEADER_CLASS

See Also:

Constant Field Values

DATA_CLASS

public static final String DATA_CLASS

See Also:

Constant Field Values

FOOTER_CLASS

public static final String FOOTER_CLASS

See Also:

Constant Field Values

COLUMN_HEADER_CLASS

public static final String COLUMN_HEADER_CLASS

See Also:

Constant Field Values

SORTABLE_COLUMN_HEADER_CLASS

public static final String SORTABLE_COLUMN_HEADER_CLASS

See Also:

Constant Field Values

ROW_CLASS

public static final String ROW_CLASS

See Also:

Constant Field Values

SELECTED_ROW_CLASS

public static final String SELECTED_ROW_CLASS

See Also:

Constant Field Values

COLUMN_CONTENT_WRAPPER

public static final String COLUMN_CONTENT_WRAPPER

See Also:

Constant Field Values

EXPAND_ICON

public static final String EXPAND_ICON

See Also:

Constant Field Values

COLLAPSE_ICON

public static final String COLLAPSE_ICON

See Also:

Constant Field Values

SCROLLABLE_CONTAINER_CLASS

public static final String SCROLLABLE_CONTAINER_CLASS

See Also:

Constant Field Values

SCROLLABLE_HEADER_CLASS

public static final String SCROLLABLE_HEADER_CLASS

See Also:

Constant Field Values

SCROLLABLE_HEADER_BOX_CLASS

public static final String SCROLLABLE_HEADER_BOX_CLASS

See Also:

Constant Field Values

SCROLLABLE_BODY_CLASS

public static final String SCROLLABLE_BODY_CLASS

See Also:

Constant Field Values

SCROLLABLE_FOOTER_CLASS

public static final String SCROLLABLE_FOOTER_CLASS

See Also:

Constant Field Values

SCROLLABLE_FOOTER_BOX_CLASS

public static final String SCROLLABLE_FOOTER_BOX_CLASS

See Also:

Constant Field Values

SELECTABLE_NODE_CLASS

public static final String SELECTABLE_NODE_CLASS

See Also:

Constant Field Values

RESIZABLE_COLUMN_CLASS

public static final String RESIZABLE_COLUMN_CLASS

See Also:

Constant Field Values

INDENT_CLASS

public static final String INDENT_CLASS

See Also:

Constant Field Values

EMPTY_MESSAGE_ROW_CLASS

public static final String EMPTY_MESSAGE_ROW_CLASS

See Also:

Constant Field Values

PARTIAL_SELECTED_CLASS

public static final String PARTIAL_SELECTED_CLASS

See Also:

Constant Field Values

SORTABLE_COLUMN_ICON_CLASS

public static final String SORTABLE_COLUMN_ICON_CLASS

See Also:

Constant Field Values

SORTABLE_COLUMN_ASCENDING_ICON_CLASS

public static final String SORTABLE_COLUMN_ASCENDING_ICON_CLASS

See Also:

Constant Field Values

SORTABLE_COLUMN_DESCENDING_ICON_CLASS

public static final String SORTABLE_COLUMN_DESCENDING_ICON_CLASS

See Also:

Constant Field Values

REFLOW_CLASS

public static final String REFLOW_CLASS

See Also:

Constant Field Values

FILTER_COLUMN_CLASS

public static final String FILTER_COLUMN_CLASS

See Also:

Constant Field Values

COLUMN_INPUT_FILTER_CLASS

public static final String COLUMN_INPUT_FILTER_CLASS

See Also:

Constant Field Values

COLUMN_CUSTOM_FILTER_CLASS

public static final String COLUMN_CUSTOM_FILTER_CLASS

See Also:

Constant Field Values

HIDDEN_COLUMN_CLASS

public static final String HIDDEN_COLUMN_CLASS

See Also:

Constant Field Values

STATIC_COLUMN_CLASS

public static final String STATIC_COLUMN_CLASS

See Also:

Constant Field Values

EDITABLE_COLUMN_CLASS

public static final String EDITABLE_COLUMN_CLASS

See Also:

Constant Field Values

EDITING_ROW_CLASS

public static final String EDITING_ROW_CLASS

See Also:

Constant Field Values

Constructor Detail

TreeTable

public TreeTable()

Method Detail

getBehaviorEventMapping

public Map<String,Class<? extends javax.faces.event.BehaviorEvent>> getBehaviorEventMapping()

getEventNames

public Collection<String> getEventNames()

Specified by:

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

Overrides:

getEventNames in class javax.faces.component.UIComponentBase

isSelectionRequest

public boolean isSelectionRequest(javax.faces.context.FacesContext context)

isSortRequest

public boolean isSortRequest(javax.faces.context.FacesContext context)

isPaginationRequest

public boolean isPaginationRequest(javax.faces.context.FacesContext context)

isRowEditRequest

public boolean isRowEditRequest(javax.faces.context.FacesContext context)

isCellEditRequest

public boolean isCellEditRequest(javax.faces.context.FacesContext context)

isCellEditCancelRequest

public boolean isCellEditCancelRequest(javax.faces.context.FacesContext context)

isCellEditInitRequest

public boolean isCellEditInitRequest(javax.faces.context.FacesContext context)

isFilterRequest

public boolean isFilterRequest(javax.faces.context.FacesContext context)

queueEvent

public void queueEvent(javax.faces.event.FacesEvent event)

Overrides:

queueEvent in class UITree

processDecodes

public void processDecodes(javax.faces.context.FacesContext context)

Overrides:

processDecodes in class UITree

processValidators

public void processValidators(javax.faces.context.FacesContext context)

Overrides:

processValidators in class UITree

populateFilterBy

public List<FilterMeta> populateFilterBy(javax.faces.context.FacesContext context,
                                         TreeTable tt)

findColumn

public UIColumn findColumn(String columnKey)

hasFooterColumn

public boolean hasFooterColumn()

isResizeRequest

public boolean isResizeRequest(javax.faces.context.FacesContext context)

getColumnsCount

public int getColumnsCount()

getScrollState

public String getScrollState()

isCheckboxSelection

public boolean isCheckboxSelection()

getSortColumn

public UIColumn getSortColumn()

setSortColumn

public void setSortColumn(UIColumn column)

clearDefaultSorted

public void clearDefaultSorted()

setDefaultSorted

public void setDefaultSorted()

isDefaultSorted

public boolean isDefaultSorted()

resolveDataLocale

public Locale resolveDataLocale()

getColumnGroup

public ColumnGroup getColumnGroup(String target)

getColumns

public List<UIColumn> getColumns()

setColumns

public void setColumns(List<UIColumn> columns)

getDynamicColumns

public Columns getDynamicColumns()

setDynamicColumns

public void setDynamicColumns(Columns value)

saveState

public Object saveState(javax.faces.context.FacesContext context)

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class javax.faces.component.UIComponentBase

validateSelection

protected void validateSelection(javax.faces.context.FacesContext context)

Overrides:

validateSelection in class UITree

getRowCount

public int getRowCount()

getPage

public int getPage()

getRowsToRender

public int getRowsToRender()

getPageCount

public int getPageCount()

getHeader

public javax.faces.component.UIComponent getHeader()

getFooter

public javax.faces.component.UIComponent getFooter()

calculateFirst

public void calculateFirst()

updatePaginationData

public void updatePaginationData(javax.faces.context.FacesContext context)

isFilteringEnabled

public boolean isFilteringEnabled()

enableFiltering

public void enableFiltering()

updateFilteredNode

public void updateFilteredNode(javax.faces.context.FacesContext context,
                               TreeNode node)

getFilteredRowKeys

public List<String> getFilteredRowKeys()

setFilteredRowKeys

public void setFilteredRowKeys(List<String> filteredRowKeys)

getFilterMetadata

public List<FilterMeta> getFilterMetadata()

setFilterMetadata

public void setFilterMetadata(List<FilterMeta> filterMetadata)

preDecode

protected void preDecode(javax.faces.context.FacesContext context)

Overrides:

preDecode in class UITree

preValidate

protected void preValidate(javax.faces.context.FacesContext context)

Overrides:

preValidate in class UITree

preUpdate

protected void preUpdate(javax.faces.context.FacesContext context)

Overrides:

preUpdate in class UITree

preEncode

protected void preEncode(javax.faces.context.FacesContext context)

Overrides:

preEncode in class UITree

updateColumnsVisibility

public void updateColumnsVisibility(javax.faces.context.FacesContext context)