Renders an Array or List of objects as a styled HTML UL element. Supports dual & multilist configurations, reordering, item drag/drop, selection & block style layout. The component strives to be exceptionally easy to style and adjust layout.The ace:list value attributemay take a List of SelectItem objects to use their String label representations as list item contents, can take SelectItems as a model via f:selectItem(s) children, or value defines a List of arbitrary objects to be represented by iterative renderings of our child components.The components are associated with the iterative object via bindings of the 'var' property.
An 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).
header
footer
Client Events
Name
Description
Supported classes for argument
select
Fired when an item is clicked & selected in the List.
javax.faces.event.AjaxBehaviorEvent
deselect
Fired when an item is clicked & deselected in the List.
javax.faces.event.AjaxBehaviorEvent
move
Fired when an item is moved within the List. The listener method for this event can take an event object of the type org.icefaces.ace.event.ListMoveEvent.
javax.faces.event.AjaxBehaviorEvent
migrate
Fired when an item is migrated to this List. The listener method for this event can take an event object of the type org.icefaces.ace.event.ListMigrateEvent.
javax.faces.event.AjaxBehaviorEvent
sort
Fired when a change to the current sort occurs on the list.
javax.faces.event.AjaxBehaviorEvent
filter
Fired when a change to the current filters occurs on the list.
javax.faces.event.AjaxBehaviorEvent
Client events can be used with Client Behaviors and the ace:ajax tag.
Tag Information
Tag Class
org.icefaces.ace.component.list.ACEListTag
TagExtraInfo Class
None
Body Content
JSP
Display Name
None
Attributes
Name
Required
Request-time
Type
Description
accesskey
no
true
java.lang.String
Access key that, when pressed, transfers focus to this component.
binding
no
true
javax.el.ValueExpression
Using an EL expression, bind the component reference to a bean property, so that the component may be accessed in the bean.
bodyClass
no
true
java.lang.String
Style class to apply to the container UL element.
bodyStyle
no
true
java.lang.String
Style rules to apply to the container UL element.
bottomButtonClass
no
true
java.lang.String
Style class to apply to the span defining the bottom button icon. Default = 'ui-icon ui-icon-arrowstop-1-s'.
compact
no
true
java.lang.Boolean
Enables an alternate style on the table that uses greatly reduced padding and a 8 point default font. Default = 'false'.
controlsContainerClass
no
true
java.lang.String
Style class to apply to the DIV surrounding the reordering controls.
controlsEnabled
no
true
java.lang.Boolean
Enable a set of buttons to control reordering of items within this list.Requires selection of determine items to adjust via buttons. Default = 'false'.
controlsFormat
no
true
java.lang.String
Defines the order in which the reordering buttons render. Specify a space delimited list of values such as "top", "up", "dwn", "btm". Default = 'top up dwn btm'.
controlsItemClass
no
true
java.lang.String
Style class to apply to the div surrounding the individual reordering icons. Default = 'ui-state-default ui-corner-all'.
controlsSpacerClass
no
true
java.lang.String
Style class to apply to the spacer container around each button element.
doubleClickMigration
no
true
java.lang.Boolean
Enable single item migration to the next list in the first matching ListControl via item double clicks; with reverse migation via shift double clicks. If used in a dual list configuration the reverse migration is implied for the second list, and holding the shift key isn't required. Note this attribute has no effect when an f:selectItem(s) model is used. Default = 'true'.
downButtonClass
no
true
java.lang.String
Style class to apply to the span defining the down button icon. Default = 'ui-icon ui-icon-arrow-1-s'.
dragging
no
true
java.lang.Boolean
Enable the dragging of list items in this list. Note this attribute has no effect when an f:selectItem(s) model is used. Default = 'true'.
dropGroup
no
true
java.lang.String
Enables inter-list dragging and dropping; an identifier used to link this region and others for bi-directional dropping. Note this attribute has no effect when an f:selectItem(s) model is used.
filterBy
no
true
java.lang.Object
Defines a ValueExpression of the value of this row to use when filtering this list. Setting this attribute enables filtering.
filterEvent
no
true
java.lang.String
Defines the Javascript event on which to trigger filter event, ex. 'keyup', 'blur', 'change' and 'enter' (Note: columns filtered based on Date values always trigger the event on change). Default = 'change'.
filterMatchMode
no
true
java.lang.String
Defines the method of filter comparison used, default is "startsWith". Types available include: "contains", "exact", "startsWith" and "endsWith". Default = 'startsWith'.
filterOptions
no
true
java.lang.Object
Defines a collection of SelectItem objects for use as filter choices.
filterStyle
no
true
java.lang.String
Defines additional CSS rules to be applied to the filter text input.
filterStyleClass
no
true
java.lang.String
Defines supplementary CSS classes to add to those already applied on this component.
filterValue
no
true
java.lang.String
Defines the string input filtering this column, coming from the client, or from the application via a value binding.
filterValues
no
true
java.lang.Object
Defines 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.
first
no
true
int
Zero-relative row number of the first row in the underlying data model to be displayed, or zero to start at the beginning of the data model. Default = '0'.
footerClass
no
true
java.lang.String
Style class to apply to the footer DIV element.
footerStyle
no
true
java.lang.String
Style rules to apply to the footer DIV element.
headerClass
no
true
java.lang.String
Style class to apply to the header DIV element.
headerStyle
no
true
java.lang.String
Style rules to apply to the header DIV element.
height
no
true
java.lang.String
Defines a CSS height value to set in the UL element style. eg. '200px', '10%', etc.
id
no
true
java.lang.String
The component identifier for this component. This value must be unique within the closest parent component that is a naming container.
itemClass
no
true
java.lang.String
Style class to apply to the iterative LI element.
itemStyle
no
true
java.lang.String
Style rules to apply to the iterative LI element.
placeholder
no
true
java.lang.Boolean
Enable adding a style to the whitespace that is cleared for a list item being dragged / dropped. Default = 'true'.
placeholderClass
no
true
java.lang.String
Style class to apply to the optional dragging placeholder LI element.
rendered
no
true
boolean
Return true if this component (and its children) should be rendered during the Render Response phase of the request processing lifecycle. Default = 'true'.
rowIndex
no
true
int
Zero-relative index of the row currently being accessed in the underlying DataModel, or -1 for no current row. Default = '0'.
rows
no
true
int
The number of rows (starting with the one identified by the first property) to be displayed, or zero to display the entire set of available rows. Default = '0'.
selectionListener
no
true
javax.el.MethodExpression
Define a method listener that is passed a ListSelectEvent wrapping the arrayof items newly selected in a single request.
selectionMode
no
true
java.lang.String
Enables item selection via clicking when defined as "multiple" or "single". The default value of the property is null; this and any value other than "multiple" or "single" disables selection for the list. Note that each click begins a new selection. If "multiple" is set, CTRL (or Command) + Click adds to (or removes from) the selection, and Shift + Click will add to the selection all unselected items between the previous selection (or deselection) and the clicked item (inclusive of the clicked item itself).
selections
no
true
java.util.Set
Defines the set of Objects from the source List that are selected. Note that when f:selectItem(s) children are used as the model to this ace:list that selections are instead added to the Collection bound to the value attribute, to more closely emulate the h:selectManyListbox component.
sortAscending
no
true
java.lang.Boolean
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'.
sortBy
no
true
java.lang.Object
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.
sortFunction
no
true
java.util.Comparator
Defines an alternate method of sorting. Sort this column using a Comparator
style
no
true
java.lang.String
Style rules to apply to the container DIV element
styleClass
no
true
java.lang.String
Style class to apply to the container DIV element.
tabIndex
no
true
java.lang.Integer
Defines a tabindex to be shared by all keyboard navigable elements of the table. This includes sort controls, filter fields and individual rows themselves. Default = '0'.
topButtonClass
no
true
java.lang.String
Style class to apply to the span defining the top button icon. Default = 'ui-icon ui-icon-arrowstop-1-n'.
upButtonClass
no
true
java.lang.String
Style class to apply to the span defining the up button icon. Default = 'ui-icon ui-icon-arrow-1-n'.
value
no
true
java.lang.Object
The DataModel instance representing the data to which this component is bound, or a collection of data for which a DataModel instance is synthesized.
var
no
true
java.lang.String
The request-scope attribute (if any) under which the data object for the current row will be exposed when iterating.
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.