org.primefaces.component.columns

Class Columns

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

javax.faces.component.UIData

org.primefaces.component.api.UIData

org.primefaces.component.columns.Columns

All Implemented Interfaces:

EventListener, javax.faces.component.NamingContainer, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.UniqueIdVendor, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, UIColumn

public class Columns
extends UIData
implements UIColumn

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Columns.PropertyKeys

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPONENT_FAMILY
static String	COMPONENT_TYPE

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

ARIA_FIRST_PAGE_LABEL, ARIA_HEADER_LABEL, ARIA_LAST_PAGE_LABEL, ARIA_NEXT_PAGE_LABEL, ARIA_PREVIOUS_PAGE_LABEL, PAGINATOR_ACTIVE_PAGE_CLASS, PAGINATOR_BOTTOM_CONTAINER_CLASS, PAGINATOR_BOTTOM_LEFT_CONTENT_CLASS, PAGINATOR_BOTTOM_RIGHT_CONTENT_CLASS, PAGINATOR_CURRENT_CLASS, PAGINATOR_FIRST_PAGE_ICON_CLASS, PAGINATOR_FIRST_PAGE_LINK_CLASS, PAGINATOR_JTP_CLASS, PAGINATOR_LAST_PAGE_ICON_CLASS, PAGINATOR_LAST_PAGE_LINK_CLASS, PAGINATOR_NEXT_PAGE_ICON_CLASS, PAGINATOR_NEXT_PAGE_LINK_CLASS, PAGINATOR_PAGE_CLASS, PAGINATOR_PAGES_CLASS, PAGINATOR_PREV_PAGE_ICON_CLASS, PAGINATOR_PREV_PAGE_LINK_CLASS, PAGINATOR_RPP_LABEL_CLASS, PAGINATOR_RPP_OPTIONS_CLASS, PAGINATOR_TOP_CONTAINER_CLASS, PAGINATOR_TOP_LEFT_CONTENT_CLASS, PAGINATOR_TOP_RIGHT_CONTENT_CLASS, ROWS_PER_PAGE_LABEL

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

Method Summary

Modifier and Type	Method and Description
String	getAriaHeaderText()
CellEditor	getCellEditor()
int	getColspan()
String	getColumnIndexVar()
String	getColumnKey()
List<DynamicColumn>	getDynamicColumns()
String	getExportFooterValue()
javax.el.MethodExpression	getExportFunction()
String	getExportHeaderValue()
String	getFamily()
String	getField()
Object	getFilterBy()
javax.el.MethodExpression	getFilterFunction()
String	getFilterMatchMode()
int	getFilterMaxLength()
Object	getFilterOptions()
String	getFilterPosition()
String	getFilterStyle()
String	getFilterStyleClass()
Object	getFilterValue()
String	getFooterText()
String	getHeaderText()
int	getPriority()
int	getRowspan()
String	getSelectionMode()
Object	getSortBy()
javax.el.MethodExpression	getSortFunction()
String	getStyle()
String	getStyleClass()
String	getWidth()
boolean	isDynamic()
boolean	isExportable()
boolean	isFilterable()
boolean	isGroupRow()
boolean	isResizable()
boolean	isSelectRow()
boolean	isSortable()
boolean	isToggleable()
boolean	isVisible()
void	renderChildren(javax.faces.context.FacesContext context)
void	setAriaHeaderText(String _ariaHeaderText)
void	setColspan(int _colspan)
void	setColumnIndexVar(String _columnIndexVar)
void	setDynamicColumns(List<DynamicColumn> dynamicColumns)
void	setExportable(boolean _exportable)
void	setExportFooterValue(String _exportFooterValue)
void	setExportFunction(javax.el.MethodExpression _exportFunction)
void	setExportHeaderValue(String _exportHeaderValue)
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	setFilterOptions(Object _filterOptions)
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	setPriority(int _priority)
void	setResizable(boolean _resizable)
void	setRowspan(int _rowspan)
void	setSelectRow(boolean _selectRow)
void	setSortable(boolean _sortable)
void	setSortBy(Object _sortBy)
void	setSortFunction(javax.el.MethodExpression _sortFunction)
void	setStyle(String _style)
void	setStyleClass(String _styleClass)
void	setToggleable(boolean _toggleable)
void	setVisible(boolean _visible)
void	setWidth(String _width)

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

calculateFirst, encodeBegin, getClientId, getContainerClientId, getCurrentPageReportTemplate, getDataModel, getIterableChildren, getPage, getPageCount, getPageLinks, getPaginatorPosition, getPaginatorTemplate, getRowIndex, getRowIndexVar, getRowsPerPageLabel, getRowsPerPageTemplate, getRowsToRender, invokeOnComponent, isLazy, isNestedWithinIterator, isPaginationRequest, isPaginator, isPaginatorAlwaysVisible, isRowStatePreserved, markInitialState, preDecode, preEncode, preUpdate, preValidate, process, processChildren, processColumnFacets, processDecodes, processFacets, processPhase, processUpdates, processValidators, requiresColumns, restoreDescendantState, restoreDescendantState, restoreState, saveDescendantState, saveDescendantState, saveState, setCurrentPageReportTemplate, setDataModel, setId, setLazy, setPageLinks, setPaginator, setPaginatorAlwaysVisible, setPaginatorPosition, setPaginatorTemplate, setRowIndex, setRowIndexVar, setRowModel, setRowsPerPageLabel, setRowsPerPageTemplate, setRowStatePreserved, shouldSkipChildren, shouldVisitChildren, shouldVisitRows, updatePaginationData, visitColumnContent, visitColumnFacets, visitColumnGroup, visitColumnsAndColumnFacets, visitFacets, visitRows, visitTree

Methods inherited from class javax.faces.component.UIData

broadcast, createUniqueId, getFirst, getFooter, getHeader, getRowCount, getRowData, getRows, getValue, getVar, isRowAvailable, queueEvent, 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, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setParent, setRendered, setRendererType, setTransient

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

encodeAll, getChildren, getClientId, getClientId, getContainerClientId, getFacet, getValueExpression, isRendered

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

Constructor Detail

Columns

public Columns()

Method Detail

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)

getFilterOptions

public Object getFilterOptions()

Specified by:

getFilterOptions in interface UIColumn

setFilterOptions

public void setFilterOptions(Object _filterOptions)

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)

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)

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)

getPriority

public int getPriority()

Specified by:

getPriority in interface UIColumn

setPriority

public void setPriority(int _priority)

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)

getExportHeaderValue

public String getExportHeaderValue()

Specified by:

getExportHeaderValue in interface UIColumn

setExportHeaderValue

public void setExportHeaderValue(String _exportHeaderValue)

getExportFooterValue

public String getExportFooterValue()

Specified by:

getExportFooterValue in interface UIColumn

setExportFooterValue

public void setExportFooterValue(String _exportFooterValue)

getSelectionMode

public String getSelectionMode()

Specified by:

getSelectionMode in interface UIColumn

getCellEditor

public CellEditor getCellEditor()

Specified by:

getCellEditor in interface UIColumn

isDynamic

public boolean isDynamic()

Specified by:

isDynamic in interface UIColumn

getColumnIndexVar

public String getColumnIndexVar()

setColumnIndexVar

public void setColumnIndexVar(String _columnIndexVar)

getColumnKey

public String getColumnKey()

Specified by:

getColumnKey in interface UIColumn

renderChildren

public void renderChildren(javax.faces.context.FacesContext context)
                    throws IOException

Specified by:

renderChildren in interface UIColumn

Throws:

IOException

getDynamicColumns

public List<DynamicColumn> getDynamicColumns()

setDynamicColumns

public void setDynamicColumns(List<DynamicColumn> dynamicColumns)