org.icefaces.ace.component.list

Class ListBase

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

javax.faces.component.UIData

org.icefaces.ace.component.list.ListBase

All Implemented Interfaces:

java.util.EventListener, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.NamingContainer, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.component.UniqueIdVendor, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, IceClientBehaviorHolder, IList

Direct Known Subclasses:

ACEList

public abstract class ListBase
extends javax.faces.component.UIData
implements IList, IceClientBehaviorHolder

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	ListBase.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.UIData

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

Fields inherited from interface javax.faces.component.NamingContainer

SEPARATOR_CHAR

Constructor Summary

Constructors

Constructor and Description
ListBase()

Method Summary

Modifier and Type	Method and Description
void	addClientBehavior(java.lang.String eventName, javax.faces.component.behavior.ClientBehavior behavior)
java.lang.String	getAccesskey() Return the value of the accesskey property.
java.lang.String	getBodyClass() Return the value of the bodyClass property.
java.lang.String	getBodyStyle() Return the value of the bodyStyle property.
java.lang.String	getBottomButtonClass() Return the value of the bottomButtonClass property.
java.lang.String	getControlsContainerClass() Return the value of the controlsContainerClass property.
java.lang.String	getControlsFormat() Return the value of the controlsFormat property.
java.lang.String	getControlsItemClass() Return the value of the controlsItemClass property.
java.lang.String	getControlsSpacerClass() Return the value of the controlsSpacerClass property.
java.lang.String	getDefaultEventName()
java.lang.String	getDefaultExecute(java.lang.String event)
java.lang.String	getDefaultRender(java.lang.String event)
java.lang.String	getDownButtonClass() Return the value of the downButtonClass property.
java.lang.String	getDragHandle() Return the value of the dragHandle property.
java.lang.String	getDropGroup() Return the value of the dropGroup property.
java.util.Collection<java.lang.String>	getEventNames()
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.util.List	getFilteredData() Return the value of the filteredData property.
java.lang.String	getFilterEvent() Return the value of the filterEvent property.
javax.faces.component.UIComponent	getFilterFacet() Return the value of the filter facet 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.Object	getFilterValues() Return the value of the filterValues property.
java.lang.String	getFooterClass() Return the value of the footerClass property.
javax.faces.component.UIComponent	getFooterFacet() Return the value of the footer facet property.
java.lang.String	getFooterStyle() Return the value of the footerStyle property.
java.lang.String	getHeaderClass() Return the value of the headerClass property.
javax.faces.component.UIComponent	getHeaderFacet() Return the value of the header facet property.
java.lang.String	getHeaderStyle() Return the value of the headerStyle property.
java.lang.String	getHeight() Return the value of the height property.
java.lang.String	getItemClass() Return the value of the itemClass property.
java.lang.String	getItemStyle() Return the value of the itemStyle property.
java.lang.String	getListenerArgument(java.lang.String event)
java.lang.String	getPlaceholderClass() Return the value of the placeholderClass property.
java.lang.String	getRemoveButtonClass() Return the value of the removeButtonClass property.
javax.el.MethodExpression	getSelectionListener() Return the value of the selectionListener property.
java.lang.String	getSelectionMode() Return the value of the selectionMode property.
java.util.Set	getSelections() Return the value of the selections 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.String	getStyle() Return the value of the style property.
java.lang.String	getStyleClass() Return the value of the styleClass property.
java.lang.Integer	getTabIndex() Return the value of the tabIndex property.
java.lang.String	getTopButtonClass() Return the value of the topButtonClass property.
java.lang.String	getType() Return the value of the type property.
java.lang.String	getUpButtonClass() Return the value of the upButtonClass property.
java.lang.Integer	getValueHashCode() Return the value of the valueHashCode property.
java.lang.Boolean	isApplyingFilters() Return the value of the applyingFilters property.
java.lang.Boolean	isApplyingSorts() Return the value of the applyingSorts property.
java.lang.Boolean	isCompact() Return the value of the compact property.
java.lang.Boolean	isControlsEnabled() Return the value of the controlsEnabled property.
java.lang.Boolean	isDoubleClickMigration() Return the value of the doubleClickMigration property.
java.lang.Boolean	isDragging() Return the value of the dragging property.
java.lang.Boolean	isPlaceholder() Return the value of the placeholder property.
protected boolean	isPropertySet(java.lang.String finder)
boolean	isRangedFilter() Return the value of the rangedFilter property.
java.lang.Boolean	isSortAscending() Return the value of the sortAscending property.
void	setAccesskey(java.lang.String accesskey) Set the value of the accesskey property.
void	setApplyingFilters(java.lang.Boolean applyingFilters) Set the value of the applyingFilters property.
void	setApplyingSorts(java.lang.Boolean applyingSorts) Set the value of the applyingSorts property.
void	setBodyClass(java.lang.String bodyClass) Set the value of the bodyClass property.
void	setBodyStyle(java.lang.String bodyStyle) Set the value of the bodyStyle property.
void	setBottomButtonClass(java.lang.String bottomButtonClass) Set the value of the bottomButtonClass property.
void	setCompact(java.lang.Boolean compact) Set the value of the compact property.
void	setControlsContainerClass(java.lang.String controlsContainerClass) Set the value of the controlsContainerClass property.
void	setControlsEnabled(java.lang.Boolean controlsEnabled) Set the value of the controlsEnabled property.
void	setControlsFormat(java.lang.String controlsFormat) Set the value of the controlsFormat property.
void	setControlsItemClass(java.lang.String controlsItemClass) Set the value of the controlsItemClass property.
void	setControlsSpacerClass(java.lang.String controlsSpacerClass) Set the value of the controlsSpacerClass property.
void	setDoubleClickMigration(java.lang.Boolean doubleClickMigration) Set the value of the doubleClickMigration property.
void	setDownButtonClass(java.lang.String downButtonClass) Set the value of the downButtonClass property.
void	setDragging(java.lang.Boolean dragging) Set the value of the dragging property.
void	setDragHandle(java.lang.String dragHandle) Set the value of the dragHandle property.
void	setDropGroup(java.lang.String dropGroup) Set the value of the dropGroup 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	setFilteredData(java.util.List filteredData) Set the value of the filteredData property.
void	setFilterEvent(java.lang.String filterEvent) Set the value of the filterEvent property.
void	setFilterFacet(javax.faces.component.UIComponent filter) Set the value of the filter facet 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	setFilterValues(java.lang.Object filterValues) Set the value of the filterValues property.
void	setFooterClass(java.lang.String footerClass) Set the value of the footerClass property.
void	setFooterFacet(javax.faces.component.UIComponent footer) Set the value of the footer facet property.
void	setFooterStyle(java.lang.String footerStyle) Set the value of the footerStyle property.
void	setHeaderClass(java.lang.String headerClass) Set the value of the headerClass property.
void	setHeaderFacet(javax.faces.component.UIComponent header) Set the value of the header facet property.
void	setHeaderStyle(java.lang.String headerStyle) Set the value of the headerStyle property.
void	setHeight(java.lang.String height) Set the value of the height property.
void	setItemClass(java.lang.String itemClass) Set the value of the itemClass property.
void	setItemStyle(java.lang.String itemStyle) Set the value of the itemStyle property.
void	setPlaceholder(java.lang.Boolean placeholder) Set the value of the placeholder property.
void	setPlaceholderClass(java.lang.String placeholderClass) Set the value of the placeholderClass property.
void	setRangedFilter(boolean rangedFilter) Set the value of the rangedFilter property.
void	setRemoveButtonClass(java.lang.String removeButtonClass) Set the value of the removeButtonClass property.
void	setSelectionListener(javax.el.MethodExpression selectionListener) Set the value of the selectionListener property.
void	setSelectionMode(java.lang.String selectionMode) Set the value of the selectionMode property.
void	setSelections(java.util.Set selections) Set the value of the selections 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	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	setTabIndex(java.lang.Integer tabIndex) Set the value of the tabIndex property.
void	setTopButtonClass(java.lang.String topButtonClass) Set the value of the topButtonClass property.
void	setType(java.lang.String type) Set the value of the type property.
void	setUpButtonClass(java.lang.String upButtonClass) Set the value of the upButtonClass property.
void	setValueExpression(java.lang.String name, javax.el.ValueExpression binding)
void	setValueHashCode(java.lang.Integer valueHashCode) Set the value of the valueHashCode property.

Methods inherited from class javax.faces.component.UIData

broadcast, createUniqueId, encodeBegin, getClientId, getDataModel, getFirst, getFooter, getHeader, getRowCount, getRowData, getRowIndex, getRows, getValue, getVar, invokeOnComponent, isRowAvailable, isRowStatePreserved, markInitialState, processDecodes, processUpdates, processValidators, queueEvent, restoreState, saveState, setDataModel, setFirst, setFooter, setHeader, setRowIndex, setRows, setRowStatePreserved, setValue, setValueBinding, setVar, visitTree

Methods inherited from class javax.faces.component.UIComponentBase

addFacesListener, clearInitialState, decode, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, getValueBinding, isRendered, isTransient, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, 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

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.faces.component.behavior.ClientBehaviorHolder

getClientBehaviors

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

See Also:

Constant Field Values

Constructor Detail

ListBase

public ListBase()

Method Detail

getFamily

public java.lang.String getFamily()

Overrides:

getFamily in class javax.faces.component.UIData

setAccesskey

public void setAccesskey(java.lang.String accesskey)

Set the value of the accesskey property.

Contents: Access key that, when pressed, transfers focus to this component.

Specified by:

setAccesskey in interface IList

getAccesskey

public java.lang.String getAccesskey()

Return the value of the accesskey property.

Contents: Access key that, when pressed, transfers focus to this component.

Specified by:

getAccesskey in interface IList

setBodyClass

public void setBodyClass(java.lang.String bodyClass)

Set the value of the bodyClass property.

Contents: Style class to apply to the container UL element.

Specified by:

setBodyClass in interface IList

getBodyClass

public java.lang.String getBodyClass()

Return the value of the bodyClass property.

Contents: Style class to apply to the container UL element.

Specified by:

getBodyClass in interface IList

setBodyStyle

public void setBodyStyle(java.lang.String bodyStyle)

Set the value of the bodyStyle property.

Contents: Style rules to apply to the container UL element.

Specified by:

setBodyStyle in interface IList

getBodyStyle

public java.lang.String getBodyStyle()

Return the value of the bodyStyle property.

Contents: Style rules to apply to the container UL element.

Specified by:

getBodyStyle in interface IList

setBottomButtonClass

public void setBottomButtonClass(java.lang.String bottomButtonClass)

Set the value of the bottomButtonClass property.

Contents: Style class to apply to the span defining the bottom button icon.

Specified by:

setBottomButtonClass in interface IList

getBottomButtonClass

public java.lang.String getBottomButtonClass()

Return the value of the bottomButtonClass property.

Contents: Style class to apply to the span defining the bottom button icon. Default = 'ui-icon ui-icon-arrowstop-1-s'.

Specified by:

getBottomButtonClass in interface IList

setCompact

public void setCompact(java.lang.Boolean compact)

Set the value of the compact property.

Contents: Enables an alternate style on the table that uses greatly reduced padding and a 8 point default font.

Specified by:

setCompact in interface IList

isCompact

public java.lang.Boolean isCompact()

Return the value of the compact property.

Contents: Enables an alternate style on the table that uses greatly reduced padding and a 8 point default font. Default = 'false'.

Specified by:

isCompact in interface IList

setControlsContainerClass

public void setControlsContainerClass(java.lang.String controlsContainerClass)

Set the value of the controlsContainerClass property.

Contents: Style class to apply to the DIV surrounding the reordering controls.

Specified by:

setControlsContainerClass in interface IList

getControlsContainerClass

public java.lang.String getControlsContainerClass()

Return the value of the controlsContainerClass property.

Contents: Style class to apply to the DIV surrounding the reordering controls.

Specified by:

getControlsContainerClass in interface IList

setControlsEnabled

public void setControlsEnabled(java.lang.Boolean controlsEnabled)

Set the value of the controlsEnabled property.

Contents: Enable a set of buttons to control reordering of items within this list.Requires selection of determine items to adjust via buttons.

Specified by:

setControlsEnabled in interface IList

isControlsEnabled

public java.lang.Boolean isControlsEnabled()

Return the value of the controlsEnabled property.

Contents: Enable a set of buttons to control reordering of items within this list.Requires selection of determine items to adjust via buttons. Default = 'false'.

Specified by:

isControlsEnabled in interface IList

setControlsFormat

public void setControlsFormat(java.lang.String controlsFormat)

Set the value of the controlsFormat property.

Contents: Defines the order in which the buttons render. Specify a space delimited list of values such as "top", "up", "dwn", "btm", and "rmv" (for the remove button). Note that the remove button always makes a request to the server, whether an ajax event is used or not. This is done in order to keep the list contents consistent. A confirmation dialog is displayed before sending the request.

Specified by:

setControlsFormat in interface IList

getControlsFormat

public java.lang.String getControlsFormat()

Return the value of the controlsFormat property.

Contents: Defines the order in which the buttons render. Specify a space delimited list of values such as "top", "up", "dwn", "btm", and "rmv" (for the remove button). Note that the remove button always makes a request to the server, whether an ajax event is used or not. This is done in order to keep the list contents consistent. A confirmation dialog is displayed before sending the request. Default = 'top up dwn btm'.

Specified by:

getControlsFormat in interface IList

setControlsItemClass

public void setControlsItemClass(java.lang.String controlsItemClass)

Set the value of the controlsItemClass property.

Contents: Style class to apply to the div surrounding the individual reordering icons.

Specified by:

setControlsItemClass in interface IList

getControlsItemClass

public java.lang.String getControlsItemClass()

Return the value of the controlsItemClass property.

Contents: Style class to apply to the div surrounding the individual reordering icons. Default = 'ui-state-default ui-corner-all'.

Specified by:

getControlsItemClass in interface IList

setControlsSpacerClass

public void setControlsSpacerClass(java.lang.String controlsSpacerClass)

Set the value of the controlsSpacerClass property.

Contents: Style class to apply to the spacer container around each button element.

Specified by:

setControlsSpacerClass in interface IList

getControlsSpacerClass

public java.lang.String getControlsSpacerClass()

Return the value of the controlsSpacerClass property.

Contents: Style class to apply to the spacer container around each button element.

Specified by:

getControlsSpacerClass in interface IList

setDoubleClickMigration

public void setDoubleClickMigration(java.lang.Boolean doubleClickMigration)

Set the value of the doubleClickMigration property.

Contents: 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.

Specified by:

setDoubleClickMigration in interface IList

isDoubleClickMigration

public java.lang.Boolean isDoubleClickMigration()

Return the value of the doubleClickMigration property.

Contents: 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'.

Specified by:

isDoubleClickMigration in interface IList

setDownButtonClass

public void setDownButtonClass(java.lang.String downButtonClass)

Set the value of the downButtonClass property.

Contents: Style class to apply to the span defining the down button icon.

Specified by:

setDownButtonClass in interface IList

getDownButtonClass

public java.lang.String getDownButtonClass()

Return the value of the downButtonClass property.

Contents: Style class to apply to the span defining the down button icon. Default = 'ui-icon ui-icon-arrow-1-s'.

Specified by:

getDownButtonClass in interface IList

setDragHandle

public void setDragHandle(java.lang.String dragHandle)

Set the value of the dragHandle property.

Contents: Specifies the jQuery selector(s) of the elements inside the item container (

element) that will be used as the drag handle(s). This is intended to be used only when the list contains nested components and/or elements. If this attribute isn't specified, any point of the item container can initiate the dragging action. The selectors are relative to the item's root element. When using multiple selectors, separate them by commas.

Specified by:

setDragHandle in interface IList

getDragHandle

public java.lang.String getDragHandle()

Return the value of the dragHandle property.

Contents: Specifies the jQuery selector(s) of the elements inside the item container (

element) that will be used as the drag handle(s). This is intended to be used only when the list contains nested components and/or elements. If this attribute isn't specified, any point of the item container can initiate the dragging action. The selectors are relative to the item's root element. When using multiple selectors, separate them by commas.