Package 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.component.TransientStateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, ColumnAware, MultiViewStateAware<TreeTableState>, Pageable, PrimeClientBehaviorHolder, UITable<TreeTableState>, Widget

public class TreeTable
extends TreeTableBase

Nested Class Summary

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

TreeTableBase.InternalPropertyKeys, TreeTableBase.PropertyKeys

Field Summary

Fields

Modifier and Type	Field	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	GRIDLINES_CLASS
static String	HEADER_CLASS
static String	HIDDEN_COLUMN_CLASS
static String	INDENT_CLASS
static String	LARGE_SIZE_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	SMALL_SIZE_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	SORTABLE_PRIORITY_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

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

Fields inherited from interface org.primefaces.component.api.UITable

OLD_SYNTAX_COLUMN_PROPERTY_REGEX

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

ATTR_WIDGET_VAR_PATTERN, CALLBACK_POST_CONSTRUCT, CALLBACK_POST_REFRESH, CALLBACK_PRE_DESTROY

Constructor Summary

Constructors

Constructor	Description
TreeTable()

Method Summary

Modifier and Type	Method	Description
void	calculateFirst()
Map<String,Class<? extends javax.faces.event.BehaviorEvent>>	getBehaviorEventMapping()
Map<String,ColumnMeta>	getColumnMeta()
List<UIColumn>	getColumns()
Collection<String>	getEventNames()
Map<String,FilterMeta>	getFilterByAsMap()
List<String>	getFilteredRowKeys()
javax.faces.component.UIComponent	getFooter()
javax.faces.component.UIComponent	getHeader()
TreeTableState	getMultiViewState(boolean create)
int	getPage()
int	getPageCount()
int	getRowCount()
int	getRowsToRender()
String	getScrollState()
Map<String,SortMeta>	getSortByAsMap()
String	getWidth()
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	isCollapseRequest(javax.faces.context.FacesContext context)
boolean	isDefaultFilter()
boolean	isDefaultSort()
boolean	isExpandRequest(javax.faces.context.FacesContext context)
boolean	isFilterByAsMapDefined()
boolean	isFilteringEnabled()
boolean	isFilterRequest(javax.faces.context.FacesContext context)
boolean	isMultiSort()
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)
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)
protected boolean	requiresColumns()
void	reset()
void	resetMultiViewState()
Locale	resolveDataLocale()
void	restoreMultiViewState()
Object	saveState(javax.faces.context.FacesContext context)
void	setColumnMeta(Map<String,ColumnMeta> columnMeta)
void	setColumns(List<UIColumn> columns)
void	setDefaultFilter(boolean defaultFilter)
void	setDefaultSort(boolean defaultSort)
void	setFilterByAsMap(Map<String,FilterMeta> sortBy)
void	setFilteredRowKeys(List<String> filteredRowKeys)
void	setSortByAsMap(Map<String,SortMeta> sortBy)
void	setWidth(String width)
void	updateFilteredValue(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, getEditInitEvent, getEditMode, getEmptyMessage, getExpandMode, getFamily, getFilterBy, getFilterDelay, getFilteredValue, getFilterEvent, getFirst, getGlobalFilter, getGlobalFilterFunction, getPageLinks, getPaginatorPosition, getPaginatorTemplate, getRows, getRowsPerPageLabel, getRowsPerPageTemplate, getRowStyleClass, getScrollHeight, getScrollWidth, getSize, getSortBy, getSortMode, getStyle, getStyleClass, getTableStyle, getTableStyleClass, getWidgetVar, isAllowUnsorting, isCloneOnFilter, isDisabledTextSelection, isEditable, isEditingRow, isLiveResize, isMultiViewState, isNativeElements, isPaginator, isPaginatorAlwaysVisible, isResizableColumns, isSaveOnCellBlur, isScrollable, isShowGridlines, isStickyHeader, setAllowUnsorting, setCellEditMode, setCellSeparator, setCloneOnFilter, setCurrentPageReportTemplate, setDataLocale, setDisabledTextSelection, setEditable, setEditingRow, setEditInitEvent, setEditMode, setEmptyMessage, setExpandMode, setFilterBy, setFilterDelay, setFilteredValue, setFilterEvent, setFirst, setGlobalFilter, setGlobalFilterFunction, setLiveResize, setMultiViewState, setNativeElements, setPageLinks, setPaginator, setPaginatorAlwaysVisible, setPaginatorPosition, setPaginatorTemplate, setResizableColumns, setRows, setRowsPerPageLabel, setRowsPerPageTemplate, setRowStyleClass, setSaveOnCellBlur, setScrollable, setScrollHeight, setScrollWidth, setShowGridlines, setSize, setSortBy, setSortMode, 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, setNodeVar, setPropagateSelectionDown, setPropagateSelectionUp, setRequired, setRequiredMessage, setRowKey, setRowKey, setRTLRendering, setSelection, setSelectionMode, setShowUnselectableCheckbox, setSkipChildren, setValue, setVar, shouldVisitNode, updateRowKeys, updateSelection, visitColumnContent, visitColumnFacets, visitColumnGroup, visitColumnsAndColumnFacets, 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, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, markInitialState, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, 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.behavior.ClientBehaviorHolder

addClientBehavior, getClientBehaviors, getDefaultEventName

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

collectColumns, findColumn, findColumnInGroup, forEachColumn, forEachColumn, forEachColumn, getColumnGroup, getColumnsCount, getColumnsCount, getColumnsCountWithSpan, getColumnsCountWithSpan, getFrozenColumnsCount, getOrderedColumnKeys, invokeOnColumn, invokeOnColumn, resetDynamicColumns

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

getClientId, getFacet

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

decodeColumnDisplayOrderState, decodeColumnResizeState, decodeColumnTogglerState, getActiveFilterMeta, getActiveSortMeta, getClientId, getColumnsWidthForClientSide, getFilterValue, getHeaderRow, getHighestPriorityActiveSortMeta, getSortMetaAsString, getVar, initFilterBy, initSortBy, isColumnFilterable, isColumnSortable, isSortingCurrentlyActive, isSortingEnabled, updateFilterByValuesWithFilterRequest, updateFilterByWithGlobalFilter, updateFilterByWithMVS, updateFilterByWithUserFilterBy, updateSortByWithMVS, updateSortByWithUserSortBy

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

resolveWidgetVar, resolveWidgetVar

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

SORTABLE_PRIORITY_CLASS

public static final String SORTABLE_PRIORITY_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

GRIDLINES_CLASS

public static final String GRIDLINES_CLASS

See Also:

Constant Field Values

SMALL_SIZE_CLASS

public static final String SMALL_SIZE_CLASS

See Also:

Constant Field Values

LARGE_SIZE_CLASS

public static final String LARGE_SIZE_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

isExpandRequest

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

isCollapseRequest

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

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

hasFooterColumn

public boolean hasFooterColumn()

isResizeRequest

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

getScrollState

public String getScrollState()

isCheckboxSelection

public boolean isCheckboxSelection()

resolveDataLocale

public Locale resolveDataLocale()

getColumns

public List<UIColumn> getColumns()

setColumns

public void setColumns(List<UIColumn> columns)

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()

updateFilteredValue

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

getFilteredRowKeys

public List<String> getFilteredRowKeys()

setFilteredRowKeys

public void setFilteredRowKeys(List<String> filteredRowKeys)

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

requiresColumns

protected boolean requiresColumns()

Overrides:

requiresColumns in class UITree

restoreMultiViewState

public void restoreMultiViewState()

getMultiViewState

public TreeTableState getMultiViewState(boolean create)

resetMultiViewState

public void resetMultiViewState()

reset

public void reset()

getSortByAsMap

public Map<String,SortMeta> getSortByAsMap()

setSortByAsMap

public void setSortByAsMap(Map<String,SortMeta> sortBy)

getFilterByAsMap

public Map<String,FilterMeta> getFilterByAsMap()

setFilterByAsMap

public void setFilterByAsMap(Map<String,FilterMeta> sortBy)

isDefaultSort

public boolean isDefaultSort()

setDefaultSort

public void setDefaultSort(boolean defaultSort)

isDefaultFilter

public boolean isDefaultFilter()

setDefaultFilter

public void setDefaultFilter(boolean defaultFilter)

isFilterByAsMapDefined

public boolean isFilterByAsMapDefined()

isMultiSort

public boolean isMultiSort()

getColumnMeta

public Map<String,ColumnMeta> getColumnMeta()

setColumnMeta

public void setColumnMeta(Map<String,ColumnMeta> columnMeta)

getWidth

public String getWidth()

setWidth

public void setWidth(String width)