ICEfaces ACE Components
Tag column


Component that represents a column in an ace:dataTable.

For more information, see the Column Wiki Documentation.


Facets
filterAn optional facet that is rendered in place of the built-in filtering inputs to provide more flexibility when filtering values. This facet is rendered as a simple popup dialog. When using this facet, the 'filterValue' property has to be set as well (or 'filterValueMin' and 'filterValueMax' if working with ranges).



Tag Information
Tag Classorg.icefaces.ace.component.column.ColumnTag
TagExtraInfo ClassNone
Body ContentJSP
Display NameNone

Attributes
NameRequiredRequest-timeTypeDescription
accesskeynotruejava.lang.StringAccess 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.
bindingnotruejavax.el.ValueExpressionUsing an EL expression, bind the component reference to a bean property, so that the component may be accessed in the bean.
colspannotrueintDefines the number of columns the rendered cell spans. Only significant to Column components within a column group. Default = '1'.
columnNameConfigurablenotruebooleanWhen false, configuring this column's name will be disabled in the TableConfigPanel component, otherwise configuring this column's name will be enabled when column name configuration is enabled as well in the TableConfigPanel component. Default = 'true'.
columnOrderingConfigurablenotruebooleanWhen false, configuring this column's order will be disabled in the TableConfigPanel component, otherwise configuring this column's order will be enabled when column ordering configuration is enabled as well in the TableConfigPanel component. Default = 'true'.
columnSortingConfigurablenotruebooleanWhen false, configuring this column's sorting will be disabled in the TableConfigPanel component, otherwise configuring this column's sorting will be enabled when column sorting configuration is enabled as well in the TableConfigPanel component. Default = 'true'.
columnVisibilityConfigurablenotruebooleanWhen false, configuring this column's visibility will be disabled in the TableConfigPanel component, otherwise configuring this column's visibility will be enabled when column visibility configuration is enabled as well in the TableConfigPanel component. Default = 'true'.
configurablenotruebooleanWhen false, this column is excluded from the list of columns available for configuration on a TableConfigPanel component. Default = 'true'.
displayPrioritynotruejava.lang.IntegerEnables 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.
filterBynotruejava.lang.ObjectDefines 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.
filterDateLocalenotruejava.lang.ObjectLocale 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.
filterDatePatternnotruejava.lang.StringDateFormat pattern for the date filter input. See the DateTimeEntry Wiki Documentation for limitations. Default = 'yyyy-MM-dd'.
filterMatchModenotruejava.lang.StringDefines the method of filter comparison used, default is "startsWith". Types available include: "contains", "exact", "startsWith" and "endsWith". Default = 'startsWith'.
filterOptionsnotruejava.lang.ObjectDefines a collection of SelectItem objects for use as filter choices.
filterStylenotruejava.lang.StringDefines additional CSS rules to be applied to the filter text input.
filterStyleClassnotruejava.lang.StringDefines supplementary CSS classes to add to those already applied on this component.
filterValuenotruejava.lang.StringDefines the string input filtering this column, coming from the client, or from the application via a value binding.
filterValueMaxnotruejava.lang.ObjectWhen 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.
filterValueMinnotruejava.lang.ObjectWhen 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.
filterValuesnotruejava.lang.ObjectDefines multiple filter values. This property can only be set programmatically, typically when using the filter facet as well. The value must be a Collection or an Array of strings. If this attribute is set, 'filterValue', 'filterValueMin', and 'filterValueMax' are ignored.
footerTextnotruejava.lang.StringDefines a plain text footer with less effort than adding a facet.
groupBynotruejava.lang.ObjectDefines 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.
headerTextnotruejava.lang.StringDefines 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.
hideSortControlsnotruebooleanWhen true, the sort controls in the column header will not be rendered. Default = 'false'.
idnotruejava.lang.StringThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.
inheritFromnotruejava.lang.StringSpecifies the id of the header column from which to inherit properties. Note that this is only a way to inherit properties from a header column and not necessarily a way to couple a body column to a header column for other purposes. When exporting and on the table configuration panel, the same rules of correspondence will be applied. This property is primarily intended for cases when multiple column components can occupy the same column position and only one of them is rendered, based on some business or display logic. It's also useful for having multiple body columns inherit properties from the same header column, as a way to avoid repetition, and in cases when sorting and filtering controls are desired to be rendered on a middle or top header row and not on the bottom row, as it is customary.
lazyColumnKeynotruejava.lang.StringSpecifies 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.
pinningOrdernotruejava.lang.IntegerDefine 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.
rangedFilternotruebooleanIf 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'.
renderednotruebooleanReturn true if this component (and its children) should be rendered during the Render Response phase of the request processing lifecycle. Default = 'true'.
reorderablenotruebooleanEnables per-column control of column ordering when the attribute ("reorderableColumns") is true at the table level. Default = 'true'.
rowspannotrueintDefines the number of rows the rendered cell spans. Only significant to Column components within a column group. Default = '1'.
sortAscendingnotruejava.lang.BooleanDefines 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'.
sortBynotruejava.lang.ObjectDefines 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.
sortFunctionnotruejava.util.ComparatorDefines an alternate method of sorting. Sort this column using a Comparator object that takes the sortBy values of this column as input.
sortPrioritynotruejava.lang.IntegerDefines the priority of a column during sorting. The column priorities 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().
sortWhenGroupingnotruebooleanWhen disabled, this column will neither be sortable nor automatically sorted when using the groupBy attribute. Default = 'true'.
stackednotruebooleanWhen enabled, this column is rendered underneath the previous column.
stylenotruejava.lang.StringCustom inline CSS styles to use for this component. These styles are generally applied to the root DOM element of the component. This is intended for per-component basic style customizations. Note that due to browser CSS precedence rules, CSS rendered on a DOM element will take precedence over the external stylesheets used to provide the ThemeRoller theme on this component. If the CSS properties applied with this attribute do not affect the DOM element you want to style, you may need to create a custom theme styleClass for the theme CSS class that targets the particular DOM elements you wish to customize.
styleClassnotruejava.lang.StringCustom CSS style class(es) to use for this component. These style classes can be defined in your page or in a theme CSS file.
typenotruejava.lang.StringSpecifies the data type of this column, determining how the 'value' attribute of this component will be handled when filtering. Valid options include : 'text', 'boolean', 'date', 'byte', 'short', 'int', 'long', 'float', and 'double' (when 'text' is used, all values are treated as strings; 'date' assumes the value object is a Date object). Default = 'text'.

Variables
No Variables Defined.


Output Generated by Tag Library Documentation Generator. Java, JSP, and JavaServer Pages are trademarks or registered trademarks of Sun Microsystems, Inc. in the US and other countries. Copyright 2002-4 Sun Microsystems, Inc. 4150 Network Circle Santa Clara, CA 95054, U.S.A. All Rights Reserved.