@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.
|
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 filtering value.
|
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 |
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, useBuiltInSortgetFooter, getHeader, setFooter, setHeaderaddClientBehavior, addFacesListener, broadcast, clearInitialState, decode, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getDefaultEventName, getEventNames, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, 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, subscribeToEvent, unsubscribeFromEventencodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, visitTreepublic static final String COMPONENT_TYPE
public static final String COMPONENT_FAMILY
public String getFamily()
getFamily in class javax.faces.component.UIColumnpublic boolean isBreakRowBefore()
AbstractColumnisBreakRowBefore in class AbstractColumnpublic void setBreakRowBefore(boolean breakRowBefore)
public int getColspan()
AbstractColumngetColspan in class AbstractColumnpublic void setColspan(int colspan)
public Comparator<?> getComparator()
AbstractColumngetComparator in class AbstractColumnpublic void setComparator(Comparator<?> comparator)
public Filter<?> getFilter()
AbstractColumngetFilter in class AbstractColumnpublic void setFilter(Filter<?> filter)
public String getFilterConverterMessage()
AbstractColumngetFilterConverterMessage in class AbstractColumnpublic void setFilterConverterMessage(String filterConverterMessage)
public Object getFilterExpression()
AbstractColumngetFilterExpression in class AbstractColumnpublic void setFilterExpression(Object filterExpression)
public String getFilterType()
AbstractColumngetFilterType in class AbstractColumnpublic void setFilterType(String filterType)
public Object getFilterValue()
AbstractColumngetFilterValue in class AbstractColumnpublic void setFilterValue(Object filterValue)
public String getFooterClass()
ColumnPropsgetFooterClass in interface ColumnPropspublic void setFooterClass(String footerClass)
public String getHeaderClass()
ColumnPropsgetHeaderClass in interface ColumnPropspublic void setHeaderClass(String headerClass)
public int getRowspan()
AbstractColumngetRowspan in class AbstractColumnpublic void setRowspan(int rowspan)
public Object getSortBy()
AbstractColumngetSortBy in class AbstractColumnpublic void setSortBy(Object sortBy)
public SortOrder getSortOrder()
AbstractColumngetSortOrder in class AbstractColumnpublic void setSortOrder(SortOrder sortOrder)
public String getSortType()
AbstractColumngetSortType in class AbstractColumnpublic void setSortType(String sortType)
public String getStyle()
StylePropsgetStyle in interface StylePropspublic void setStyle(String style)
public String getStyleClass()
StyleClassPropsgetStyleClass in interface StyleClassPropspublic void setStyleClass(String styleClass)
public String getSubmittedFilterValue()
AbstractColumngetSubmittedFilterValue in class AbstractColumnpublic void setSubmittedFilterValue(String submittedFilterValue)
public String getWidth()
AbstractColumngetWidth in class AbstractColumnpublic void setWidth(String width)
Copyright © 2014 JBoss by Red Hat. All Rights Reserved.