@Generated(value={"RichFaces CDK","4.5.0-SNAPSHOT"}) public class UIColumn extends AbstractColumn implements Column, ColumnProps, StyleClassProps, StyleProps
The <rich:column> component facilitates columns in a table. It supports merging columns and rows, sorting, filtering, and customized skinning.
Modifier and Type | Class and Description |
---|---|
protected static class |
UIColumn.Properties |
Modifier and Type | Field and Description |
---|---|
static String |
COMPONENT_FAMILY |
static String |
COMPONENT_TYPE |
Constructor and Description |
---|
UIColumn() |
Modifier and Type | Method and Description |
---|---|
int |
getColspan()
Corresponds to the HTML colspan attribute.
|
Comparator<?> |
getComparator()
Defines value binding to the comparator that is used to compare the values.
|
String |
getFamily() |
Filter<?> |
getFilter()
Provides Filter instance which determines if given row value will be displayed.
|
String |
getFilterConverterMessage()
The message to be displayed when the filter expression is not able to be evaluated using the provided filter value.
|
Object |
getFilterExpression()
Defines EL expression which returns true if given row should be displayed (EL expressions should use variable defined in
filterVar attribute of dataTable).
|
String |
getFilterType()
Defines current filter type.
|
Object |
getFilterValue()
Defines current filtering value.
|
String |
getFooterClass()
Space-separated list of CSS style class(es) that will be applied to any footer generated for this column.
|
String |
getHeaderClass()
Space-separated list of CSS style class(es) that will be applied to any header generated for this column.
|
String |
getName()
Allows customizing column name in column visibility control in rich:extendedDataTable (showColumnControl)
|
int |
getRowspan()
Corresponds to the HTML rowspan attribute.
|
Object |
getSortBy()
Defines a bean property which is used for sorting of a column.
|
SortOrder |
getSortOrder()
Defines order which will be used for sorting column: unsorted (default), ascending, descending.
|
String |
getSortType()
Defines current sorting type.
|
String |
getStyle()
CSS style(s) to be applied when this component is rendered.
|
String |
getStyleClass()
Space-separated list of CSS style class(es) to be applied when this element is rendered.
|
String |
getSubmittedFilterValue()
The submitted filter value.
|
String |
getWidth()
Attribute defines width of column.
|
boolean |
isBreakRowBefore()
If "true" next column begins from the first row.
|
void |
setBreakRowBefore(boolean breakRowBefore) |
void |
setColspan(int colspan) |
void |
setComparator(Comparator<?> comparator) |
void |
setFilter(Filter<?> filter) |
void |
setFilterConverterMessage(String filterConverterMessage) |
void |
setFilterExpression(Object filterExpression) |
void |
setFilterType(String filterType) |
void |
setFilterValue(Object filterValue) |
void |
setFooterClass(String footerClass) |
void |
setHeaderClass(String headerClass) |
void |
setName(String name) |
void |
setRowspan(int rowspan) |
void |
setSortBy(Object sortBy) |
void |
setSortOrder(SortOrder sortOrder) |
void |
setSortType(String sortType) |
void |
setStyle(String style) |
void |
setStyleClass(String styleClass) |
void |
setSubmittedFilterValue(String submittedFilterValue) |
void |
setWidth(String width) |
getFilterField, getSortField, isBuiltInFilterControlsEnabled, isBuiltInSortControlsEnabled, useBuiltInFilter, useBuiltInSort
getFooter, getHeader, getId, setFooter, setHeader
addClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeAll, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, markInitialState, processDecodes, processRestoreState, processSaveState, processUpdates, processValidators, queueEvent, removeFacesListener, restoreAttachedState, restoreState, saveAttachedState, saveState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, visitTree
getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getListenersForEventClass, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, subscribeToEvent, unsubscribeFromEvent
public static final String COMPONENT_TYPE
public static final String COMPONENT_FAMILY
public String getFamily()
getFamily
in class javax.faces.component.UIColumn
public boolean isBreakRowBefore()
AbstractColumn
isBreakRowBefore
in class AbstractColumn
public void setBreakRowBefore(boolean breakRowBefore)
public int getColspan()
AbstractColumn
getColspan
in class AbstractColumn
public void setColspan(int colspan)
public Comparator<?> getComparator()
AbstractColumn
getComparator
in class AbstractColumn
public void setComparator(Comparator<?> comparator)
public Filter<?> getFilter()
AbstractColumn
getFilter
in class AbstractColumn
public void setFilter(Filter<?> filter)
public String getFilterConverterMessage()
AbstractColumn
getFilterConverterMessage
in class AbstractColumn
public void setFilterConverterMessage(String filterConverterMessage)
public Object getFilterExpression()
AbstractColumn
getFilterExpression
in class AbstractColumn
public void setFilterExpression(Object filterExpression)
public String getFilterType()
AbstractColumn
getFilterType
in class AbstractColumn
public void setFilterType(String filterType)
public Object getFilterValue()
AbstractColumn
getFilterValue
in class AbstractColumn
public void setFilterValue(Object filterValue)
public String getFooterClass()
ColumnProps
getFooterClass
in interface ColumnProps
public void setFooterClass(String footerClass)
public String getHeaderClass()
ColumnProps
getHeaderClass
in interface ColumnProps
public void setHeaderClass(String headerClass)
public String getName()
AbstractColumn
getName
in class AbstractColumn
public void setName(String name)
public int getRowspan()
AbstractColumn
getRowspan
in class AbstractColumn
public void setRowspan(int rowspan)
public Object getSortBy()
AbstractColumn
getSortBy
in class AbstractColumn
public void setSortBy(Object sortBy)
public SortOrder getSortOrder()
AbstractColumn
getSortOrder
in class AbstractColumn
public void setSortOrder(SortOrder sortOrder)
public String getSortType()
AbstractColumn
getSortType
in class AbstractColumn
public void setSortType(String sortType)
public String getStyle()
StyleProps
getStyle
in interface StyleProps
public void setStyle(String style)
public String getStyleClass()
StyleClassProps
getStyleClass
in interface StyleClassProps
public void setStyleClass(String styleClass)
public String getSubmittedFilterValue()
AbstractColumn
getSubmittedFilterValue
in class AbstractColumn
public void setSubmittedFilterValue(String submittedFilterValue)
public String getWidth()
AbstractColumn
getWidth
in class AbstractColumn
public void setWidth(String width)
Copyright © 2016 JBoss by Red Hat. All Rights Reserved.