Package org.primefaces.component.columns

Class ColumnsBase

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

javax.faces.component.UIData

org.primefaces.component.api.UIData

org.primefaces.component.columns.ColumnsBase

All Implemented Interfaces:

EventListener, 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, UIColumn

Direct Known Subclasses:

Columns

public abstract class ColumnsBase
extends UIData
implements UIColumn

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ColumnsBase.PropertyKeys

Field Summary

Fields

Modifier and Type	Field	Description
static final String	COMPONENT_FAMILY

Fields inherited from class javax.faces.component.UIData

COMPONENT_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

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

DEFAULT_FILTER_MATCH_MODE, DYNAMIC_FIELD_VE_LEGACY_PATTERN, STATIC_FIELD_VE_LEGACY_PATTERN

Constructor Summary

Constructors

Constructor	Description
ColumnsBase()

Method Summary

Modifier and Type	Method	Description
String	getAriaHeaderText()
int	getColspan()
Object	getConverter()
int	getDisplayPriority()
int	getExportColspan()
Object	getExportFooterValue()
javax.el.MethodExpression	getExportFunction()
Object	getExportHeaderValue()
int	getExportRowspan()
String	getExportTag()
Object	getExportValue()
String	getFamily()
String	getField()
Object	getFilterBy()
javax.el.MethodExpression	getFilterFunction()
String	getFilterMatchMode()
int	getFilterMaxLength()
String	getFilterPlaceholder()
String	getFilterPosition()
String	getFilterStyle()
String	getFilterStyleClass()
Object	getFilterValue()
String	getFooterText()
String	getHeaderText()
int	getNullSortOrder()
int	getResponsivePriority()
int	getRowspan()
Object	getSortBy()
javax.el.MethodExpression	getSortFunction()
String	getSortOrder()
int	getSortPriority()
String	getStyle()
String	getStyleClass()
String	getTitle()
String	getWidth()
boolean	isCaseSensitiveSort()
boolean	isDraggable()
boolean	isExportable()
boolean	isFilterable()
boolean	isGroupRow()
boolean	isResizable()
boolean	isSelectionBox()
boolean	isSelectRow()
boolean	isSortable()
boolean	isToggleable()
boolean	isVisible()
void	setAriaHeaderText(String ariaHeaderText)
void	setCaseSensitiveSort(boolean caseSensitiveSort)
void	setColspan(int colspan)
void	setConverter(Object converter)
void	setDisplayPriority(int displayPriority)
void	setDraggable(boolean draggable)
void	setExportable(boolean exportable)
void	setExportColspan(int exportColspan)
void	setExportFooterValue(Object exportFooterValue)
void	setExportFunction(javax.el.MethodExpression exportFunction)
void	setExportHeaderValue(Object exportHeaderValue)
void	setExportRowspan(int exportRowspan)
void	setExportTag(String exportTag)
void	setExportValue(Object exportValue)
void	setField(String field)
void	setFilterable(boolean filterable)
void	setFilterBy(Object filterBy)
void	setFilterFunction(javax.el.MethodExpression filterFunction)
void	setFilterMatchMode(String filterMatchMode)
void	setFilterMaxLength(int filterMaxLength)
void	setFilterPlaceholder(String filterPlaceholder)
void	setFilterPosition(String filterPosition)
void	setFilterStyle(String filterStyle)
void	setFilterStyleClass(String filterStyleClass)
void	setFilterValue(Object filterValue)
void	setFooterText(String footerText)
void	setGroupRow(boolean groupRow)
void	setHeaderText(String headerText)
void	setNullSortOrder(int nullSortOrder)
void	setResizable(boolean resizable)
void	setResponsivePriority(int responsivePriority)
void	setRowspan(int rowspan)
void	setSelectionBox(boolean selectionBox)
void	setSelectRow(boolean selectRow)
void	setSortable(boolean sortable)
void	setSortBy(Object sortBy)
void	setSortFunction(javax.el.MethodExpression sortFunction)
void	setSortOrder(String order)
void	setSortPriority(int sortPriority)
void	setStyle(String style)
void	setStyleClass(String styleClass)
void	setTitle(String title)
void	setToggleable(boolean toggleable)
void	setVisible(boolean visible)
void	setWidth(String width)

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

encodeBegin, getClientId, getContainerClientId, getIterableChildren, getRowIndex, getRowIndexVar, invokeOnComponent, isLazy, isNestedWithinIterator, isRowStatePreserved, markInitialState, preDecode, preEncode, preUpdate, preValidate, process, processChildren, processColumnFacets, processDecodes, processFacets, processPhase, processUpdates, processValidators, requiresColumns, restoreDescendantState, restoreDescendantState, restoreState, saveDescendantState, saveDescendantState, saveState, setId, setLazy, setRowIndex, setRowIndexVar, setRowModel, setRowStatePreserved, shouldProcessChild, shouldSkipChildren, shouldVisitChildren, visitColumnContent, visitColumnFacets, visitColumnGroup, visitColumnsAndColumnFacets, visitFacets, visitRows, visitTree

Methods inherited from class javax.faces.component.UIData

broadcast, createUniqueId, getDataModel, getFirst, getFooter, getHeader, getRowCount, getRowData, getRows, getValue, getVar, isRowAvailable, queueEvent, setDataModel, setFirst, setFooter, setHeader, setRows, setValue, setValueBinding, setValueExpression, setVar

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, addFacesListener, clearInitialState, decode, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setParent, setRendered, setRendererType, setTransient, 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

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.UIColumn

asUIComponent, encodeAll, getCellEditor, getChildren, getClientId, getClientId, getColumnKey, getColumnKey, getColumnKey, getContainerClientId, getFacet, getFilterValueFromValueHolder, getValueExpression, isDynamic, isRendered, renderChildren, resolveField, setFilterValueToValueHolder

Field Details

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY

See Also:

• Constant Field Values

Constructor Details

ColumnsBase

public ColumnsBase()

Method Details

getFamily

public String getFamily()

Overrides:

getFamily in class javax.faces.component.UIData

getSortBy

public Object getSortBy()

Specified by:

getSortBy in interface UIColumn

setSortBy

public void setSortBy(Object sortBy)

getStyle

public String getStyle()

Specified by:

getStyle in interface UIColumn

setStyle

public void setStyle(String style)

getStyleClass

public String getStyleClass()

Specified by:

getStyleClass in interface UIColumn

setStyleClass

public void setStyleClass(String styleClass)

getSortFunction

public javax.el.MethodExpression getSortFunction()

Specified by:

getSortFunction in interface UIColumn

setSortFunction

public void setSortFunction(javax.el.MethodExpression sortFunction)

getFilterBy

public Object getFilterBy()

Specified by:

getFilterBy in interface UIColumn

setFilterBy

public void setFilterBy(Object filterBy)

getFilterStyle

public String getFilterStyle()

Specified by:

getFilterStyle in interface UIColumn

setFilterStyle

public void setFilterStyle(String filterStyle)

getFilterStyleClass

public String getFilterStyleClass()

Specified by:

getFilterStyleClass in interface UIColumn

setFilterStyleClass

public void setFilterStyleClass(String filterStyleClass)

getFilterMatchMode

public String getFilterMatchMode()

Specified by:

getFilterMatchMode in interface UIColumn

setFilterMatchMode

public void setFilterMatchMode(String filterMatchMode)

getFilterPosition

public String getFilterPosition()

Specified by:

getFilterPosition in interface UIColumn

setFilterPosition

public void setFilterPosition(String filterPosition)

getFilterPlaceholder

public String getFilterPlaceholder()

Specified by:

getFilterPlaceholder in interface UIColumn

setFilterPlaceholder

public void setFilterPlaceholder(String filterPlaceholder)

getFilterValue

public Object getFilterValue()

Specified by:

getFilterValue in interface UIColumn

setFilterValue

public void setFilterValue(Object filterValue)

getRowspan

public int getRowspan()

Specified by:

getRowspan in interface UIColumn

setRowspan

public void setRowspan(int rowspan)

getColspan

public int getColspan()

Specified by:

getColspan in interface UIColumn

setColspan

public void setColspan(int colspan)

getHeaderText

public String getHeaderText()

Specified by:

getHeaderText in interface UIColumn

setHeaderText

public void setHeaderText(String headerText)

getFooterText

public String getFooterText()

Specified by:

getFooterText in interface UIColumn

setFooterText

public void setFooterText(String footerText)

getFilterMaxLength

public int getFilterMaxLength()

Specified by:

getFilterMaxLength in interface UIColumn

setFilterMaxLength

public void setFilterMaxLength(int filterMaxLength)

isResizable

public boolean isResizable()

Specified by:

isResizable in interface UIColumn

setResizable

public void setResizable(boolean resizable)

isExportable

public boolean isExportable()

Specified by:

isExportable in interface UIColumn

setExportable

public void setExportable(boolean exportable)

getWidth

public String getWidth()

Specified by:

getWidth in interface UIColumn

setWidth

public void setWidth(String width)

isToggleable

public boolean isToggleable()

Specified by:

isToggleable in interface UIColumn

setToggleable

public void setToggleable(boolean toggleable)

isDraggable

public boolean isDraggable()

Specified by:

isDraggable in interface UIColumn

setDraggable

public void setDraggable(boolean draggable)

getFilterFunction

public javax.el.MethodExpression getFilterFunction()

Specified by:

getFilterFunction in interface UIColumn

setFilterFunction

public void setFilterFunction(javax.el.MethodExpression filterFunction)

getField

public String getField()

Specified by:

getField in interface UIColumn

setField

public void setField(String field)

getResponsivePriority

public int getResponsivePriority()

Specified by:

getResponsivePriority in interface UIColumn

setResponsivePriority

public void setResponsivePriority(int responsivePriority)

isSortable

public boolean isSortable()

Specified by:

isSortable in interface UIColumn

setSortable

public void setSortable(boolean sortable)

isFilterable

public boolean isFilterable()

Specified by:

isFilterable in interface UIColumn

setFilterable

public void setFilterable(boolean filterable)

isVisible

public boolean isVisible()

Specified by:

isVisible in interface UIColumn

setVisible

public void setVisible(boolean visible)

isSelectRow

public boolean isSelectRow()

Specified by:

isSelectRow in interface UIColumn

setSelectRow

public void setSelectRow(boolean selectRow)

getAriaHeaderText

public String getAriaHeaderText()

Specified by:

getAriaHeaderText in interface UIColumn

setAriaHeaderText

public void setAriaHeaderText(String ariaHeaderText)

getExportFunction

public javax.el.MethodExpression getExportFunction()

Specified by:

getExportFunction in interface UIColumn

setExportFunction

public void setExportFunction(javax.el.MethodExpression exportFunction)

isGroupRow

public boolean isGroupRow()

Specified by:

isGroupRow in interface UIColumn

setGroupRow

public void setGroupRow(boolean groupRow)

getExportValue

public Object getExportValue()

Specified by:

getExportValue in interface UIColumn

setExportValue

public void setExportValue(Object exportValue)

getExportTag

public String getExportTag()

Specified by:

getExportTag in interface UIColumn

setExportTag

public void setExportTag(String exportTag)

getExportRowspan

public int getExportRowspan()

Specified by:

getExportRowspan in interface UIColumn

setExportRowspan

public void setExportRowspan(int exportRowspan)

getExportColspan

public int getExportColspan()

Specified by:

getExportColspan in interface UIColumn

setExportColspan

public void setExportColspan(int exportColspan)

getExportHeaderValue

public Object getExportHeaderValue()

Specified by:

getExportHeaderValue in interface UIColumn

setExportHeaderValue

public void setExportHeaderValue(Object exportHeaderValue)

getExportFooterValue

public Object getExportFooterValue()

Specified by:

getExportFooterValue in interface UIColumn

setExportFooterValue

public void setExportFooterValue(Object exportFooterValue)

getSortOrder

public String getSortOrder()

Specified by:

getSortOrder in interface UIColumn

setSortOrder

public void setSortOrder(String order)

getSortPriority

public int getSortPriority()

Specified by:

getSortPriority in interface UIColumn

setSortPriority

public void setSortPriority(int sortPriority)

getNullSortOrder

public int getNullSortOrder()

Specified by:

getNullSortOrder in interface UIColumn

setNullSortOrder

public void setNullSortOrder(int nullSortOrder)

isCaseSensitiveSort

public boolean isCaseSensitiveSort()

Specified by:

isCaseSensitiveSort in interface UIColumn

setCaseSensitiveSort

public void setCaseSensitiveSort(boolean caseSensitiveSort)

getDisplayPriority

public int getDisplayPriority()

Specified by:

getDisplayPriority in interface UIColumn

setDisplayPriority

public void setDisplayPriority(int displayPriority)

getTitle

public String getTitle()

Specified by:

getTitle in interface UIColumn

setTitle

public void setTitle(String title)

isSelectionBox

public boolean isSelectionBox()

Specified by:

isSelectionBox in interface UIColumn

setSelectionBox

public void setSelectionBox(boolean selectionBox)

getConverter

public Object getConverter()

Specified by:

getConverter in interface UIColumn

setConverter

public void setConverter(Object converter)