org.icefaces.ace.component.column

Class ColumnBase

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

javax.faces.component.UIColumn

org.icefaces.ace.component.column.ColumnBase

All Implemented Interfaces:

java.util.EventListener, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, IColumn

Direct Known Subclasses:

Column

public abstract class ColumnBase
extends javax.faces.component.UIColumn
implements IColumn

Component that represents a column in an ace:dataTable.

For more information, see the Column Wiki Documentation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	ColumnBase.PropertyKeys

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COMPONENT_TYPE
static java.lang.String	RENDERER_TYPE

Fields inherited from class javax.faces.component.UIColumn

COMPONENT_FAMILY

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

Constructor Summary

Constructors

Constructor and Description
ColumnBase()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAccesskey() Return the value of the accesskey property.
int	getColspan() Return the value of the colspan property.
java.lang.Integer	getDisplayPriority() Return the value of the displayPriority property.
java.lang.String	getFamily()
java.lang.Object	getFilterBy() Return the value of the filterBy property.
java.lang.Object	getFilterDateLocale() Return the value of the filterDateLocale property.
java.lang.String	getFilterDatePattern() Return the value of the filterDatePattern property.
java.lang.String	getFilterMatchMode() Return the value of the filterMatchMode property.
java.lang.Object	getFilterOptions() Return the value of the filterOptions property.
java.lang.String	getFilterStyle() Return the value of the filterStyle property.
java.lang.String	getFilterStyleClass() Return the value of the filterStyleClass property.
java.lang.String	getFilterValue() Return the value of the filterValue property.
java.lang.Object	getFilterValueMax() Return the value of the filterValueMax property.
java.lang.Object	getFilterValueMin() Return the value of the filterValueMin property.
java.lang.String	getFooterText() Return the value of the footerText property.
java.lang.Object	getGroupBy() Return the value of the groupBy property.
java.lang.String	getHeaderText() Return the value of the headerText property.
java.lang.String	getLazyColumnKey() Return the value of the lazyColumnKey property.
java.lang.Integer	getPinningOrder() Return the value of the pinningOrder property.
int	getRowspan() Return the value of the rowspan property.
java.lang.Object	getSortBy() Return the value of the sortBy property.
java.util.Comparator	getSortFunction() Return the value of the sortFunction property.
java.lang.Integer	getSortPriority() Return the value of the sortPriority property.
java.lang.String	getStyle() Return the value of the style property.
java.lang.String	getStyleClass() Return the value of the styleClass property.
java.lang.String	getType() Return the value of the type property.
boolean	isConfigurable() Return the value of the configurable property.
boolean	isHideSortControls() Return the value of the hideSortControls property.
protected boolean	isPropertySet(java.lang.String finder)
boolean	isRangedFilter() Return the value of the rangedFilter property.
boolean	isReorderable() Return the value of the reorderable property.
java.lang.Boolean	isSortAscending() Return the value of the sortAscending property.
boolean	isSortWhenGrouping() Return the value of the sortWhenGrouping property.
boolean	isStacked() Return the value of the stacked property.
void	setAccesskey(java.lang.String accesskey) Set the value of the accesskey property.
void	setColspan(int colspan) Set the value of the colspan property.
void	setConfigurable(boolean configurable) Set the value of the configurable property.
void	setDisplayPriority(java.lang.Integer displayPriority) Set the value of the displayPriority property.
void	setFilterBy(java.lang.Object filterBy) Set the value of the filterBy property.
void	setFilterDateLocale(java.lang.Object filterDateLocale) Set the value of the filterDateLocale property.
void	setFilterDatePattern(java.lang.String filterDatePattern) Set the value of the filterDatePattern property.
void	setFilterMatchMode(java.lang.String filterMatchMode) Set the value of the filterMatchMode property.
void	setFilterOptions(java.lang.Object filterOptions) Set the value of the filterOptions property.
void	setFilterStyle(java.lang.String filterStyle) Set the value of the filterStyle property.
void	setFilterStyleClass(java.lang.String filterStyleClass) Set the value of the filterStyleClass property.
void	setFilterValue(java.lang.String filterValue) Set the value of the filterValue property.
void	setFilterValueMax(java.lang.Object filterValueMax) Set the value of the filterValueMax property.
void	setFilterValueMin(java.lang.Object filterValueMin) Set the value of the filterValueMin property.
void	setFooterText(java.lang.String footerText) Set the value of the footerText property.
void	setGroupBy(java.lang.Object groupBy) Set the value of the groupBy property.
void	setHeaderText(java.lang.String headerText) Set the value of the headerText property.
void	setHideSortControls(boolean hideSortControls) Set the value of the hideSortControls property.
void	setLazyColumnKey(java.lang.String lazyColumnKey) Set the value of the lazyColumnKey property.
void	setPinningOrder(java.lang.Integer pinningOrder) Set the value of the pinningOrder property.
void	setRangedFilter(boolean rangedFilter) Set the value of the rangedFilter property.
void	setReorderable(boolean reorderable) Set the value of the reorderable property.
void	setRowspan(int rowspan) Set the value of the rowspan property.
void	setSortAscending(java.lang.Boolean sortAscending) Set the value of the sortAscending property.
void	setSortBy(java.lang.Object sortBy) Set the value of the sortBy property.
void	setSortFunction(java.util.Comparator sortFunction) Set the value of the sortFunction property.
void	setSortPriority(java.lang.Integer sortPriority) Set the value of the sortPriority property.
void	setSortWhenGrouping(boolean sortWhenGrouping) Set the value of the sortWhenGrouping property.
void	setStacked(boolean stacked) Set the value of the stacked property.
void	setStyle(java.lang.String style) Set the value of the style property.
void	setStyleClass(java.lang.String styleClass) Set the value of the styleClass property.
void	setType(java.lang.String type) Set the value of the type property.
void	setValueExpression(java.lang.String name, javax.el.ValueExpression binding)

Methods inherited from class javax.faces.component.UIColumn

getFooter, getHeader, setFooter, setHeader

Methods inherited from class javax.faces.component.UIComponentBase

addClientBehavior, 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, unsubscribeFromEvent

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, visitTree

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

COMPONENT_TYPE

public static final java.lang.String COMPONENT_TYPE

See Also:

Constant Field Values

RENDERER_TYPE

public static final java.lang.String RENDERER_TYPE

Constructor Detail

ColumnBase

public ColumnBase()

Method Detail

getFamily

public java.lang.String getFamily()

Overrides:

getFamily in class javax.faces.component.UIColumn

setAccesskey

public void setAccesskey(java.lang.String accesskey)

Set the value of the accesskey property.

Contents: Access key that, when pressed, transfers focus to the filter input of this column, if filtering is enabled for this column, or to the ascending sort button, if sorting is enabled for this column.

Specified by:

setAccesskey in interface IColumn

getAccesskey

public java.lang.String getAccesskey()

Return the value of the accesskey property.

Contents: Access key that, when pressed, transfers focus to the filter input of this column, if filtering is enabled for this column, or to the ascending sort button, if sorting is enabled for this column.

Specified by:

getAccesskey in interface IColumn

setColspan

public void setColspan(int colspan)

Set the value of the colspan property.

Contents: Defines the number of columns the rendered cell spans. Only significant to Column components within a column group.

Specified by:

setColspan in interface IColumn

getColspan

public int getColspan()

Return the value of the colspan property.

Contents: Defines the number of columns the rendered cell spans. Only significant to Column components within a column group. Default = '1'.

Specified by:

getColspan in interface IColumn

setConfigurable

public void setConfigurable(boolean configurable)

Set the value of the configurable property.

Contents: When disabled, this column is excluded from the list of columns available for configuration on a TableConfigPanel component.

Specified by:

setConfigurable in interface IColumn

isConfigurable

public boolean isConfigurable()

Return the value of the configurable property.

Contents: When disabled, this column is excluded from the list of columns available for configuration on a TableConfigPanel component. Default = 'true'.

Specified by:

isConfigurable in interface IColumn

setDisplayPriority

public void setDisplayPriority(java.lang.Integer displayPriority)

Set the value of the displayPriority property.

Contents: Enables responsive column display for this column by specifying a priority value that ranges from 1 to 6, with lower numerical values representing higher priorities. A prioritized column is subject to being conditionally displayed in the client, based on the user agent's viewport width. It is necessary to include the mobi:deviceResource component on the page in order for this feature to work correctly on mobile devices. Columns with higher priority take precedence over columns with lower priority. Columns that don't have this attribute set will always be displayed. As for stacked columns, the ace:column component at the top of a column stack dictates the display priority of the rendered column in the client. As for multi-row headers (i.e. ace:columnGroup/ace:row), each header column must have this attribute set, and, if it's a parent header column, its value must be the same as that of its highest priority child, otherwise the parent will remain visible when all its children are hidden, taking up space.

Specified by:

setDisplayPriority in interface IColumn

getDisplayPriority

public java.lang.Integer getDisplayPriority()

Return the value of the displayPriority property.

Contents: Enables responsive column display for this column by specifying a priority value that ranges from 1 to 6, with lower numerical values representing higher priorities. A prioritized column is subject to being conditionally displayed in the client, based on the user agent's viewport width. It is necessary to include the mobi:deviceResource component on the page in order for this feature to work correctly on mobile devices. Columns with higher priority take precedence over columns with lower priority. Columns that don't have this attribute set will always be displayed. As for stacked columns, the ace:column component at the top of a column stack dictates the display priority of the rendered column in the client. As for multi-row headers (i.e. ace:columnGroup/ace:row), each header column must have this attribute set, and, if it's a parent header column, its value must be the same as that of its highest priority child, otherwise the parent will remain visible when all its children are hidden, taking up space.

Specified by:

getDisplayPriority in interface IColumn

setFilterBy

public void setFilterBy(java.lang.Object filterBy)

Set the value of the filterBy property.

Contents: Defines a ValueExpression of the value of this row to use when filtering this column. Setting this attribute, or the "value" attribute for a column enables filtering.

Specified by:

setFilterBy in interface IColumn

getFilterBy

public java.lang.Object getFilterBy()

Return the value of the filterBy property.

Contents: Defines a ValueExpression of the value of this row to use when filtering this column. Setting this attribute, or the "value" attribute for a column enables filtering.

Specified by:

getFilterBy in interface IColumn

setFilterDateLocale

public void setFilterDateLocale(java.lang.Object filterDateLocale)

Set the value of the filterDateLocale property.

Contents: Locale to be used for the date filter input. Valid values can be a Locale string or java.util.Locale objects. Default is locale of view root.

Specified by:

setFilterDateLocale in interface IColumn

getFilterDateLocale

public java.lang.Object getFilterDateLocale()

Return the value of the filterDateLocale property.

Contents: Locale to be used for the date filter input. Valid values can be a Locale string or java.util.Locale objects. Default is locale of view root.

Specified by:

getFilterDateLocale in interface IColumn

setFilterDatePattern

public void setFilterDatePattern(java.lang.String filterDatePattern)

Set the value of the filterDatePattern property.

Contents: DateFormat pattern for the date filter input. See the DateTimeEntry Wiki Documentation for limitations.

Specified by:

setFilterDatePattern in interface IColumn

getFilterDatePattern

public java.lang.String getFilterDatePattern()

Return the value of the filterDatePattern property.

Contents: DateFormat pattern for the date filter input. See the DateTimeEntry Wiki Documentation for limitations. Default = 'yyyy-MM-dd'.

Specified by:

getFilterDatePattern in interface IColumn

setFilterMatchMode

public void setFilterMatchMode(java.lang.String filterMatchMode)

Set the value of the filterMatchMode property.

Contents: Defines the method of filter comparison used, default is "startsWith". Types available include: "contains", "exact", "startsWith" and "endsWith".

Specified by:

setFilterMatchMode in interface IColumn

getFilterMatchMode

public java.lang.String getFilterMatchMode()

Return the value of the filterMatchMode property.

Contents: Defines the method of filter comparison used, default is "startsWith". Types available include: "contains", "exact", "startsWith" and "endsWith". Default = 'startsWith'.

Specified by:

getFilterMatchMode in interface IColumn

setFilterOptions

public void setFilterOptions(java.lang.Object filterOptions)

Set the value of the filterOptions property.

Contents: Defines a collection of SelectItem objects for use as filter choices.

Specified by:

setFilterOptions in interface IColumn

getFilterOptions

public java.lang.Object getFilterOptions()

Return the value of the filterOptions property.

Contents: Defines a collection of SelectItem objects for use as filter choices.

Specified by:

getFilterOptions in interface IColumn

setFilterStyle

public void setFilterStyle(java.lang.String filterStyle)

Set the value of the filterStyle property.

Contents: Defines additional CSS rules to be applied to the filter text input.

Specified by:

setFilterStyle in interface IColumn

getFilterStyle

public java.lang.String getFilterStyle()

Return the value of the filterStyle property.

Contents: Defines additional CSS rules to be applied to the filter text input.

Specified by:

getFilterStyle in interface IColumn

setFilterStyleClass

public void setFilterStyleClass(java.lang.String filterStyleClass)

Set the value of the filterStyleClass property.

Contents: Defines supplementary CSS classes to add to those already applied on this component.

Specified by:

setFilterStyleClass in interface IColumn

getFilterStyleClass

public java.lang.String getFilterStyleClass()

Return the value of the filterStyleClass property.

Contents: Defines supplementary CSS classes to add to those already applied on this component.

Specified by:

getFilterStyleClass in interface IColumn

setFilterValue

public void setFilterValue(java.lang.String filterValue)

Set the value of the filterValue property.

Contents: Defines the string input filtering this column, coming from the client, or from the application via a value binding.

Specified by:

setFilterValue in interface IColumn

getFilterValue

public java.lang.String getFilterValue()

Return the value of the filterValue property.

Contents: Defines the string input filtering this column, coming from the client, or from the application via a value binding.

Specified by:

getFilterValue in interface IColumn

setFilterValueMax

public void setFilterValueMax(java.lang.Object filterValueMax)

Set the value of the filterValueMax property.

Contents: When range filtering is enabled, this property is used to access or to set the maximum filter value of the range. The value can't be a primitive type; use the corresponding wrapper object instead.

Specified by:

setFilterValueMax in interface IColumn

getFilterValueMax

public java.lang.Object getFilterValueMax()

Return the value of the filterValueMax property.

Contents: When range filtering is enabled, this property is used to access or to set the maximum filter value of the range. The value can't be a primitive type; use the corresponding wrapper object instead.

Specified by:

getFilterValueMax in interface IColumn

setFilterValueMin

public void setFilterValueMin(java.lang.Object filterValueMin)

Set the value of the filterValueMin property.

Contents: When range filtering is enabled, this property is used to access or to set the minimum filter value of the range. The value can't be a primitive type; use the corresponding wrapper object instead.

Specified by:

setFilterValueMin in interface IColumn

getFilterValueMin

public java.lang.Object getFilterValueMin()

Return the value of the filterValueMin property.

Contents: When range filtering is enabled, this property is used to access or to set the minimum filter value of the range. The value can't be a primitive type; use the corresponding wrapper object instead.

Specified by:

getFilterValueMin in interface IColumn

setFooterText

public void setFooterText(java.lang.String footerText)

Set the value of the footerText property.

Contents: Defines a plain text footer with less effort than adding a facet.

Specified by:

setFooterText in interface IColumn

getFooterText

public java.lang.String getFooterText()

Return the value of the footerText property.

Contents: Defines a plain text footer with less effort than adding a facet.

Specified by:

getFooterText in interface IColumn

setGroupBy

public void setGroupBy(java.lang.Object groupBy)

Set the value of the groupBy property.

Contents: Defines a value expression representing the value of this column per row when determining if the values of this column in sibling rows are equal. If they are equal, span the rows witha single column cell.

Specified by:

setGroupBy in interface IColumn

getGroupBy

public java.lang.Object getGroupBy()

Return the value of the groupBy property.

Contents: Defines a value expression representing the value of this column per row when determining if the values of this column in sibling rows are equal. If they are equal, span the rows witha single column cell.

Specified by:

getGroupBy in interface IColumn

setHeaderText

public void setHeaderText(java.lang.String headerText)

Set the value of the headerText property.

Contents: Defines a plain text header with less effort than adding a facet. Note that even when using a header facet this property should also be set as a short-form label for the column that will be used within the ace:tableConfigPanel.

Specified by:

setHeaderText in interface IColumn

getHeaderText

public java.lang.String getHeaderText()

Return the value of the headerText property.

Contents: Defines a plain text header with less effort than adding a facet. Note that even when using a header facet this property should also be set as a short-form label for the column that will be used within the ace:tableConfigPanel.

Specified by:

getHeaderText in interface IColumn

setHideSortControls

public void setHideSortControls(boolean hideSortControls)

Set the value of the hideSortControls property.

Contents: When true, the sort controls in the column header will not be rendered.

Specified by:

setHideSortControls in interface IColumn

isHideSortControls

public boolean isHideSortControls()

Return the value of the hideSortControls property.

Contents: When true, the sort controls in the column header will not be rendered. Default = 'false'.

Specified by:

isHideSortControls in interface IColumn

setLazyColumnKey

public void setLazyColumnKey(java.lang.String lazyColumnKey)

Set the value of the lazyColumnKey property.

Contents: Specifies a string that will be used to identify this column when working in lazy mode. This string will be passed as a key of the filters map and will be returned from SortCriteria.getPropertyName() in the LazyDataModel.load() method. If this attribute is defined, then this value will be used instead of the value obtained by parsing the EL expressions of the sortyBy and filterBy attributes. This attribute is useful when using complex and/or dynamic EL expressions that can't be parsed nor resolved at render time, such as when using c:forEach to define the columns.

Specified by:

setLazyColumnKey in interface IColumn

getLazyColumnKey

public java.lang.String getLazyColumnKey()

Return the value of the lazyColumnKey property.

Contents: Specifies a string that will be used to identify this column when working in lazy mode. This string will be passed as a key of the filters map and will be returned from SortCriteria.getPropertyName() in the LazyDataModel.load() method. If this attribute is defined, then this value will be used instead of the value obtained by parsing the EL expressions of the sortyBy and filterBy attributes. This attribute is useful when using complex and/or dynamic EL expressions that can't be parsed nor resolved at render time, such as when using c:forEach to define the columns.

Specified by:

getLazyColumnKey in interface IColumn

setPinningOrder

public void setPinningOrder(java.lang.Integer pinningOrder)

Set the value of the pinningOrder property.

Contents: Define the position of this column in the pinned column region when column pinning and scrolling are enabled at the table level. Having a value in this field indicates a column is pinned. 1 indexed.

Specified by:

setPinningOrder in interface IColumn

getPinningOrder

public java.lang.Integer getPinningOrder()

Return the value of the pinningOrder property.

Contents: Define the position of this column in the pinned column region when column pinning and scrolling are enabled at the table level. Having a value in this field indicates a column is pinned. 1 indexed.

Specified by:

getPinningOrder in interface IColumn

setRangedFilter

public void setRangedFilter(boolean rangedFilter)

Set the value of the rangedFilter property.

Contents: If true, range filtering is enabled. When range filtering is enabled, two input fields will be rendered for filtering this column. The first one is to specify the minimum value and the second one is to specify the maximum value. All rows with values for this column in between this range will be matched. If only the minimum value is specified, all values greater than or equal to it will be matched; if only the maximum value is specified, all values less than or equal to it will be matched.

Specified by:

setRangedFilter in interface IColumn

isRangedFilter

public boolean isRangedFilter()

Return the value of the rangedFilter property.

Contents: If true, range filtering is enabled. When range filtering is enabled, two input fields will be rendered for filtering this column. The first one is to specify the minimum value and the second one is to specify the maximum value. All rows with values for this column in between this range will be matched. If only the minimum value is specified, all values greater than or equal to it will be matched; if only the maximum value is specified, all values less than or equal to it will be matched. Default = 'false'.

Specified by:

isRangedFilter in interface IColumn

setReorderable

public void setReorderable(boolean reorderable)

Set the value of the reorderable property.

Contents: Enables per-column control of column ordering when the attribute ("reorderableColumns") is true at the table level.

Specified by:

setReorderable in interface IColumn

isReorderable

public boolean isReorderable()

Return the value of the reorderable property.

Contents: Enables per-column control of column ordering when the attribute ("reorderableColumns") is true at the table level. Default = 'true'.

Specified by:

isReorderable in interface IColumn

setRowspan

public void setRowspan(int rowspan)

Set the value of the rowspan property.

Contents: Defines the number of rows the rendered cell spans. Only significant to Column components within a column group.

Specified by:

setRowspan in interface IColumn

getRowspan

public int getRowspan()

Return the value of the rowspan property.

Contents: Defines the number of rows the rendered cell spans. Only significant to Column components within a column group. Default = '1'.

Specified by:

getRowspan in interface IColumn

setSortAscending

public void setSortAscending(java.lang.Boolean sortAscending)

Set the value of the sortAscending property.

Contents: Defines the direction of column values during sorting. The column directions incoming from the client during a sort request overwrite any set by the application. Processing the sorted columns is done by the component whenever a client edits a sort control or the application calls table.applySorting().

Specified by:

setSortAscending in interface IColumn

isSortAscending

public java.lang.Boolean isSortAscending()

Return the value of the sortAscending property.

Contents: Defines the direction of column values during sorting. The column directions incoming from the client during a sort request overwrite any set by the application. Processing the sorted columns is done by the component whenever a client edits a sort control or the application calls table.applySorting(). Default = 'false'.

Specified by:

isSortAscending in interface IColumn

setSortBy

public void setSortBy(java.lang.Object sortBy)

Set the value of the sortBy property.

Contents: Defines a value expression representing the value of this column per row when sorting. Setting this attribute, or the "value" attribute for a column enables sorting.

Specified by:

setSortBy in interface IColumn

getSortBy

public java.lang.Object getSortBy()

Return the value of the sortBy property.

Contents: Defines a value expression representing the value of this column per row when sorting. Setting this attribute, or the "value" attribute for a column enables sorting.

Specified by:

getSortBy in interface IColumn

setSortFunction

public void setSortFunction(java.util.Comparator sortFunction)

Set the value of the sortFunction property.

Contents: Defines an alternate method of sorting. Sort this column using a Comparator