Package org.primefaces.component.treetable

Class TreeTableBase

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

org.primefaces.component.api.UITree

org.primefaces.component.treetable.TreeTableBase

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

Direct Known Subclasses:

TreeTable

public abstract class TreeTableBase
extends UITree
implements Widget, javax.faces.component.behavior.ClientBehaviorHolder, PrimeClientBehaviorHolder, Pageable, UITable<TreeTableState>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static class	TreeTableBase.InternalPropertyKeys
static class	TreeTableBase.PropertyKeys

Field Summary

Fields

Modifier and Type	Field	Description
static String	COMPONENT_FAMILY
static String	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
TreeTableBase()

Method Summary

Modifier and Type	Method	Description
String	getCellEditMode()
String	getCellSeparator()
String	getCurrentPageReportTemplate()
Object	getDataLocale()
String	getEditInitEvent()
String	getEditMode()
String	getEmptyMessage()
String	getExpandMode()
String	getFamily()
Object	getFilterBy()
int	getFilterDelay()
Object	getFilteredValue()
String	getFilterEvent()
int	getFirst()
String	getGlobalFilter()
javax.el.MethodExpression	getGlobalFilterFunction()
int	getPageLinks()
String	getPaginatorPosition()
String	getPaginatorTemplate()
int	getRows()
String	getRowsPerPageLabel()
String	getRowsPerPageTemplate()
String	getRowStyleClass()
String	getScrollHeight()
String	getScrollWidth()
String	getSize()
Object	getSortBy()
String	getSortMode()
String	getStyle()
String	getStyleClass()
String	getTableStyle()
String	getTableStyleClass()
String	getWidgetVar()
boolean	isAllowUnsorting()
boolean	isCloneOnFilter()
boolean	isDisabledTextSelection()
boolean	isEditable()
boolean	isEditingRow()
boolean	isLiveResize()
boolean	isMultiViewState()
boolean	isNativeElements()
boolean	isPaginator()
boolean	isPaginatorAlwaysVisible()
boolean	isResizableColumns()
boolean	isSaveOnCellBlur()
boolean	isScrollable()
boolean	isShowGridlines()
boolean	isStickyHeader()
void	setAllowUnsorting(boolean allowUnsorting)
void	setCellEditMode(String cellEditMode)
void	setCellSeparator(String cellSeparator)
void	setCloneOnFilter(boolean cloneOnFilter)
void	setCurrentPageReportTemplate(String currentPageReportTemplate)
void	setDataLocale(Object dataLocale)
void	setDisabledTextSelection(boolean disabledTextSelection)
void	setEditable(boolean editable)
void	setEditingRow(boolean editingRow)
void	setEditInitEvent(String editInitEvent)
void	setEditMode(String editMode)
void	setEmptyMessage(String emptyMessage)
void	setExpandMode(String expandMode)
void	setFilterBy(Object filterBy)
void	setFilterDelay(int filterDelay)
void	setFilteredValue(Object filteredValue)
void	setFilterEvent(String filterEvent)
void	setFirst(int first)
void	setGlobalFilter(String globalFilter)
void	setGlobalFilterFunction(javax.el.MethodExpression globalFilterFunction)
void	setLiveResize(boolean liveResize)
void	setMultiViewState(boolean multiViewState)
void	setNativeElements(boolean nativeElements)
void	setPageLinks(int pageLinks)
void	setPaginator(boolean paginator)
void	setPaginatorAlwaysVisible(boolean paginatorAlwaysVisible)
void	setPaginatorPosition(String paginatorPosition)
void	setPaginatorTemplate(String paginatorTemplate)
void	setResizableColumns(boolean resizableColumns)
void	setRows(int rows)
void	setRowsPerPageLabel(String rowsPerPageLabel)
void	setRowsPerPageTemplate(String rowsPerPageTemplate)
void	setRowStyleClass(String rowStyleClass)
void	setSaveOnCellBlur(boolean saveOnCellBlur)
void	setScrollable(boolean scrollable)
void	setScrollHeight(String scrollHeight)
void	setScrollWidth(String scrollWidth)
void	setShowGridlines(boolean showGridlines)
void	setSize(String size)
void	setSortBy(Object sortBy)
void	setSortMode(String sortMode)
void	setStickyHeader(boolean stickyHeader)
void	setStyle(String style)
void	setStyleClass(String styleClass)
void	setTableStyle(String tableStyle)
void	setTableStyleClass(String tableStyleClass)
void	setWidgetVar(String widgetVar)

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, preDecode, preEncode, preUpdate, preValidate, processColumnChildren, processColumnFacets, processComponent, processDecodes, processFacets, processNode, processNodes, processUpdates, processValidators, queueEvent, refreshSelectedNodeKeys, requiresColumns, setNodeVar, setPropagateSelectionDown, setPropagateSelectionUp, setRequired, setRequiredMessage, setRowKey, setRowKey, setRTLRendering, setSelection, setSelectionMode, setShowUnselectableCheckbox, setSkipChildren, setValue, setVar, shouldVisitNode, updateRowKeys, updateSelection, validateSelection, 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, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, markInitialState, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, 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, getEventNames

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

collectColumns, findColumn, findColumnInGroup, forEachColumn, forEachColumn, forEachColumn, getColumnGroup, getColumnMeta, getColumns, getColumnsCount, getColumnsCount, getColumnsCountWithSpan, getColumnsCountWithSpan, getFrozenColumnsCount, getOrderedColumnKeys, invokeOnColumn, invokeOnColumn, resetDynamicColumns, setColumnMeta, setColumns

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

getMultiViewState, resetMultiViewState, restoreMultiViewState

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

getClientId, getFacet, getFooter, getHeader, getPage, getPageCount, getRowCount, getRowsToRender

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

getBehaviorEventMapping

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

decodeColumnDisplayOrderState, decodeColumnResizeState, decodeColumnTogglerState, getActiveFilterMeta, getActiveSortMeta, getClientId, getColumnsWidthForClientSide, getFilterByAsMap, getFilterValue, getHeaderRow, getHighestPriorityActiveSortMeta, getSortByAsMap, getSortMetaAsString, getVar, getWidth, initFilterBy, initSortBy, isColumnFilterable, isColumnSortable, isDefaultFilter, isDefaultSort, isFilterByAsMapDefined, isFilteringEnabled, isSortingCurrentlyActive, isSortingEnabled, setDefaultFilter, setDefaultSort, setFilterByAsMap, setSortByAsMap, setWidth, updateFilterByValuesWithFilterRequest, updateFilterByWithGlobalFilter, updateFilterByWithMVS, updateFilterByWithUserFilterBy, updateSortByWithMVS, updateSortByWithUserSortBy

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

resolveWidgetVar, resolveWidgetVar

Field Detail

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY

See Also:

Constant Field Values

DEFAULT_RENDERER

public static final String DEFAULT_RENDERER

See Also:

Constant Field Values

Constructor Detail

TreeTableBase

public TreeTableBase()

Method Detail

getFamily

public String getFamily()

Specified by:

getFamily in class javax.faces.component.UIComponent

getWidgetVar

public String getWidgetVar()

setWidgetVar

public void setWidgetVar(String widgetVar)

getStyle

public String getStyle()

setStyle

public void setStyle(String style)

getStyleClass

public String getStyleClass()

setStyleClass

public void setStyleClass(String styleClass)

isScrollable

public boolean isScrollable()

setScrollable

public void setScrollable(boolean scrollable)

getScrollHeight

public String getScrollHeight()

setScrollHeight

public void setScrollHeight(String scrollHeight)

getScrollWidth

public String getScrollWidth()

setScrollWidth

public void setScrollWidth(String scrollWidth)

getTableStyle

public String getTableStyle()

setTableStyle

public void setTableStyle(String tableStyle)

getTableStyleClass

public String getTableStyleClass()

setTableStyleClass

public void setTableStyleClass(String tableStyleClass)

getEmptyMessage

public String getEmptyMessage()

setEmptyMessage

public void setEmptyMessage(String emptyMessage)

isResizableColumns

public boolean isResizableColumns()

setResizableColumns

public void setResizableColumns(boolean resizableColumns)

getRowStyleClass

public String getRowStyleClass()

setRowStyleClass

public void setRowStyleClass(String rowStyleClass)

isLiveResize

public boolean isLiveResize()

setLiveResize

public void setLiveResize(boolean liveResize)

getSortBy

public Object getSortBy()

Specified by:

getSortBy in interface UITable<TreeTableState>

setSortBy

public void setSortBy(Object sortBy)

Specified by:

setSortBy in interface UITable<TreeTableState>

isNativeElements

public boolean isNativeElements()

setNativeElements

public void setNativeElements(boolean nativeElements)

getDataLocale

public Object getDataLocale()

setDataLocale

public void setDataLocale(Object dataLocale)

getExpandMode

public String getExpandMode()

setExpandMode

public void setExpandMode(String expandMode)

isStickyHeader

public boolean isStickyHeader()

setStickyHeader

public void setStickyHeader(boolean stickyHeader)

isEditable

public boolean isEditable()

setEditable

public void setEditable(boolean editable)

getEditMode

public String getEditMode()

setEditMode

public void setEditMode(String editMode)

isEditingRow

public boolean isEditingRow()

setEditingRow

public void setEditingRow(boolean editingRow)

getCellSeparator

public String getCellSeparator()

setCellSeparator

public void setCellSeparator(String cellSeparator)

isDisabledTextSelection

public boolean isDisabledTextSelection()

setDisabledTextSelection

public void setDisabledTextSelection(boolean disabledTextSelection)

isPaginator

public boolean isPaginator()

setPaginator

public void setPaginator(boolean paginator)

getPaginatorTemplate

public String getPaginatorTemplate()

Specified by:

getPaginatorTemplate in interface Pageable

setPaginatorTemplate

public void setPaginatorTemplate(String paginatorTemplate)

getRowsPerPageTemplate

public String getRowsPerPageTemplate()

Specified by:

getRowsPerPageTemplate in interface Pageable

setRowsPerPageTemplate

public void setRowsPerPageTemplate(String rowsPerPageTemplate)

getRowsPerPageLabel

public String getRowsPerPageLabel()

Specified by:

getRowsPerPageLabel in interface Pageable

setRowsPerPageLabel

public void setRowsPerPageLabel(String rowsPerPageLabel)

getCurrentPageReportTemplate

public String getCurrentPageReportTemplate()

Specified by:

getCurrentPageReportTemplate in interface Pageable

setCurrentPageReportTemplate

public void setCurrentPageReportTemplate(String currentPageReportTemplate)

getPageLinks

public int getPageLinks()

Specified by:

getPageLinks in interface Pageable

setPageLinks

public void setPageLinks(int pageLinks)

getPaginatorPosition

public String getPaginatorPosition()

Specified by:

getPaginatorPosition in interface Pageable

setPaginatorPosition

public void setPaginatorPosition(String paginatorPosition)

isPaginatorAlwaysVisible

public boolean isPaginatorAlwaysVisible()

Specified by:

isPaginatorAlwaysVisible in interface Pageable

setPaginatorAlwaysVisible

public void setPaginatorAlwaysVisible(boolean paginatorAlwaysVisible)

getRows

public int getRows()

Specified by:

getRows in interface Pageable

setRows

public void setRows(int rows)

getFirst

public int getFirst()

Specified by:

getFirst in interface Pageable

setFirst

public void setFirst(int first)

getFilteredValue

public Object getFilteredValue()

setFilteredValue

public void setFilteredValue(Object filteredValue)

getFilterEvent

public String getFilterEvent()

setFilterEvent

public void setFilterEvent(String filterEvent)

getFilterDelay

public int getFilterDelay()

setFilterDelay

public void setFilterDelay(int filterDelay)

getCellEditMode

public String getCellEditMode()

setCellEditMode

public void setCellEditMode(String cellEditMode)

getEditInitEvent

public String getEditInitEvent()

setEditInitEvent

public void setEditInitEvent(String editInitEvent)

isMultiViewState

public boolean isMultiViewState()

Specified by:

isMultiViewState in interface MultiViewStateAware<TreeTableState>

setMultiViewState

public void setMultiViewState(boolean multiViewState)

getFilterBy

public Object getFilterBy()

Specified by:

getFilterBy in interface UITable<TreeTableState>

setFilterBy

public void setFilterBy(Object filterBy)

Specified by:

setFilterBy in interface UITable<TreeTableState>

getGlobalFilter

public String getGlobalFilter()

Specified by:

getGlobalFilter in interface UITable<TreeTableState>

setGlobalFilter

public void setGlobalFilter(String globalFilter)

Specified by:

setGlobalFilter in interface UITable<TreeTableState>

getGlobalFilterFunction

public javax.el.MethodExpression getGlobalFilterFunction()

Specified by:

getGlobalFilterFunction in interface UITable<TreeTableState>

setGlobalFilterFunction

public void setGlobalFilterFunction(javax.el.MethodExpression globalFilterFunction)

Specified by:

setGlobalFilterFunction in interface UITable<TreeTableState>

isAllowUnsorting

public boolean isAllowUnsorting()

setAllowUnsorting

public void setAllowUnsorting(boolean allowUnsorting)

getSortMode

public String getSortMode()

setSortMode

public void setSortMode(String sortMode)

isCloneOnFilter

public boolean isCloneOnFilter()

setCloneOnFilter

public void setCloneOnFilter(boolean cloneOnFilter)

isSaveOnCellBlur

public boolean isSaveOnCellBlur()

setSaveOnCellBlur

public void setSaveOnCellBlur(boolean saveOnCellBlur)

isShowGridlines

public boolean isShowGridlines()

setShowGridlines

public void setShowGridlines(boolean showGridlines)

getSize

public String getSize()

setSize

public void setSize(String size)