ICEfaces-EE ACE Components
Tag list


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.

For more information, see the List 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).
header
footer


Client Events
NameDescriptionSupported classes for argument
selectFired when an item is clicked & selected in the List.javax.faces.event.AjaxBehaviorEvent
deselectFired when an item is clicked & deselected in the List.javax.faces.event.AjaxBehaviorEvent
moveFired when an item is moved within the List.javax.faces.event.AjaxBehaviorEvent
migrateFired when an item is migrated to this List.javax.faces.event.AjaxBehaviorEvent
sortFired when a change to the current sort occurs on the list.javax.faces.event.AjaxBehaviorEvent
filterFired 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 Classorg.icefaces.ace.component.list.ACEListTag
TagExtraInfo ClassNone
Body ContentJSP
Display NameNone

Attributes
NameRequiredRequest-timeTypeDescription
accesskeynotruejava.lang.StringAccess key that, when pressed, transfers focus to this component.
bindingnotruejavax.el.ValueExpressionUsing an EL expression, bind the component reference to a bean property, so that the component may be accessed in the bean.
bodyClassnotruejava.lang.StringStyle class to apply to the container UL element.
bodyStylenotruejava.lang.StringStyle rules to apply to the container UL element.
bottomButtonClassnotruejava.lang.StringStyle class to apply to the span defining the bottom button icon. Default = 'ui-icon ui-icon-arrowstop-1-s'.
compactnotruejava.lang.BooleanEnables an alternate style on the table that uses greatly reduced padding and a 8 point default font. Default = 'false'.
controlsContainerClassnotruejava.lang.StringStyle class to apply to the DIV surrounding the reordering controls.
controlsEnablednotruejava.lang.BooleanEnable a set of buttons to control reordering of items within this list.Requires selection of determine items to adjust via buttons. Default = 'false'.
controlsFormatnotruejava.lang.StringDefines 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'.
controlsItemClassnotruejava.lang.StringStyle class to apply to the div surrounding the individual reordering icons. Default = 'ui-state-default ui-corner-all'.
controlsSpacerClassnotruejava.lang.StringStyle class to apply to the spacer container around each button element.
doubleClickMigrationnotruejava.lang.BooleanEnable 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'.
downButtonClassnotruejava.lang.StringStyle class to apply to the span defining the down button icon. Default = 'ui-icon ui-icon-arrow-1-s'.
draggingnotruejava.lang.BooleanEnable the dragging of list items in this list. Note this attribute has no effect when an f:selectItem(s) model is used. Default = 'true'.
dropGroupnotruejava.lang.StringEnables 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.
filterBynotruejava.lang.ObjectDefines a ValueExpression of the value of this row to use when filtering this list. Setting this attribute enables filtering.
filterEventnotruejava.lang.StringDefines 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'.
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.
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.
firstnotrueintZero-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'.
footerClassnotruejava.lang.StringStyle class to apply to the footer DIV element.
footerStylenotruejava.lang.StringStyle rules to apply to the footer DIV element.
headerClassnotruejava.lang.StringStyle class to apply to the header DIV element.
headerStylenotruejava.lang.StringStyle rules to apply to the header DIV element.
heightnotruejava.lang.StringDefines a CSS height value to set in the UL element style. eg. '200px', '10%', etc.
idnotruejava.lang.StringThe component identifier for this component. This value must be unique within the closest parent component that is a naming container.
itemClassnotruejava.lang.StringStyle class to apply to the iterative LI element.
itemStylenotruejava.lang.StringStyle rules to apply to the iterative LI element.
placeholdernotruejava.lang.BooleanEnable adding a style to the whitespace that is cleared for a list item being dragged / dropped. Default = 'true'.
placeholderClassnotruejava.lang.StringStyle class to apply to the optional dragging placeholder LI element.
renderednotruebooleanReturn true if this component (and its children) should be rendered during the Render Response phase of the request processing lifecycle. Default = 'true'.
rowIndexnotrueintZero-relative index of the row currently being accessed in the underlying DataModel, or -1 for no current row. Default = '0'.
rowsnotrueintThe 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'.
selectionListenernotruejavax.el.MethodExpressionDefine a method listener that is passed a ListSelectEvent wrapping the arrayof items newly selected in a single request.
selectionModenotruejava.lang.StringEnables 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).
selectionsnotruejava.util.SetDefines 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.
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.
stylenotruejava.lang.StringStyle rules to apply to the container DIV element
styleClassnotruejava.lang.StringStyle class to apply to the container DIV element.
tabIndexnotruejava.lang.IntegerDefines 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'.
topButtonClassnotruejava.lang.StringStyle class to apply to the span defining the top button icon. Default = 'ui-icon ui-icon-arrowstop-1-n'.
upButtonClassnotruejava.lang.StringStyle class to apply to the span defining the up button icon. Default = 'ui-icon ui-icon-arrow-1-n'.
valuenotruejava.lang.ObjectThe DataModel instance representing the data to which this component is bound, or a collection of data for which a DataModel instance is synthesized.
varnotruejava.lang.StringThe request-scope attribute (if any) under which the data object for the current row will be exposed when iterating.

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.