org.alfresco.web.ui.common.component

Class UISelectList

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

javax.faces.component.UIOutput

javax.faces.component.UIInput

org.alfresco.web.ui.common.component.UISelectList

All Implemented Interfaces:

EditableValueHolder, NamingContainer, StateHolder, ValueHolder

public class UISelectList
extends UIInput
implements NamingContainer

The SelectList component displays a graphical list of items, each with a label and icon image. The list has three selection modes; single select (radio), multi-select (checkbox) and active selection mode (child action components). The value for the component is collection of UIListItem objects or a UIListItems instance. For passive single and multi-select modes, the selected value(s) can be retrieved from the component. For active selection mode, appropriate child components such as Command buttons or Action Links will be rendered for each item in the list, data-binding to the specified 'var' variable should be used to bind required params. It is then up to the developer to retrieve the selected item param from the actionListener of the appropriate child component.

Author:

Kevin Roast

Field Summary

Fields inherited from class javax.faces.component.UIInput

COMPONENT_FAMILY, COMPONENT_TYPE, CONVERSION_MESSAGE_ID, REQUIRED_MESSAGE_ID

Fields inherited from interface javax.faces.component.NamingContainer

SEPARATOR_CHAR

Constructor Summary

Constructors

Constructor and Description
UISelectList() Default constructor

Method Summary

Modifier and Type	Method and Description
void	broadcast(FacesEvent event) Override event broadcasting to look for event wrappers to set the current row context correctly for components that have been rendered multiple times in the list.
void	decode(FacesContext context)
void	encodeBegin(FacesContext context)
void	encodeChildren(FacesContext context)
String	getClientId(FacesContext context)
boolean	getEscapeItemDescription() Get the escape item description flag
boolean	getEscapeItemLabel() Get the escape item label flag
String	getFamily()
boolean	getRendersChildren()
int	getRowIndex()
boolean	isActiveSelect() Get the active selection mode flag
boolean	isMultiSelect() Get the multi-select rendering flag
void	processDecodes(FacesContext context) Override the processing of child component decodes - we set the current row context so any events queued by child components wrapped in FacesEventWrapper have current row value.
void	queueEvent(FacesEvent event) Override event queueing from child components - wrap and add current row value
void	restoreState(FacesContext context, Object state)
Object	saveState(FacesContext context)
void	setActiveSelect(boolean activeSelect) Set true for active selection mode, false otherwise
void	setEscapeItemDescription(boolean escapeItemDescription) Set true to escape the items description, false otherwise
void	setEscapeItemLabel(boolean escapeItemLabel) Set true to escape the items label, false otherwise
void	setMultiSelect(boolean multiSelect) Set true for multi-select rendering, false otherwise
void	setRowIndex(int rowIndex) Set the transient current row index.

Methods inherited from class javax.faces.component.UIInput

addValidator, addValueChangeListener, compareValues, getConvertedValue, getSubmittedValue, getValidator, getValidators, getValue, getValueChangeListener, getValueChangeListeners, isImmediate, isLocalValueSet, isRequired, isValid, processUpdates, processValidators, removeValidator, removeValueChangeListener, setImmediate, setLocalValueSet, setRequired, setSubmittedValue, setValid, setValidator, setValue, setValueChangeListener, updateModel, validate, validateValue

Methods inherited from class javax.faces.component.UIOutput

getConverter, getLocalValue, setConverter

Methods inherited from class javax.faces.component.UIComponentBase

addFacesListener, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getFacesContext, getFacesListeners, getFacet, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getValueBinding, isRendered, isTransient, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding

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.ValueHolder

getConverter, getLocalValue, setConverter

Constructor Detail

UISelectList

public UISelectList()

Default constructor

Method Detail

getFamily

public String getFamily()

Overrides:

getFamily in class UIInput

See Also:

UIComponent.getFamily()

restoreState

public void restoreState(FacesContext context,
                         Object state)

Specified by:

restoreState in interface StateHolder

Overrides:

restoreState in class UIInput

See Also:

StateHolder.restoreState(javax.faces.context.FacesContext, java.lang.Object)

saveState

public Object saveState(FacesContext context)

Specified by:

saveState in interface StateHolder

Overrides:

saveState in class UIInput

See Also:

StateHolder.saveState(javax.faces.context.FacesContext)

getClientId

public String getClientId(FacesContext context)

Overrides:

getClientId in class UIComponentBase

Returns:

the client Id for this naming container component - based on the current row context. This allows a single component rendered multiple times in a list to dynamically base their ID on the current row - so that the 'correct' component is decoded and event is queued with the current row value.

processDecodes

public void processDecodes(FacesContext context)

Override the processing of child component decodes - we set the current row context so any events queued by child components wrapped in FacesEventWrapper have current row value.

Overrides:

processDecodes in class UIInput

queueEvent

public void queueEvent(FacesEvent event)

Override event queueing from child components - wrap and add current row value

Overrides:

queueEvent in class UIComponentBase

broadcast

public void broadcast(FacesEvent event)
               throws AbortProcessingException

Override event broadcasting to look for event wrappers to set the current row context correctly for components that have been rendered multiple times in the list.

Overrides:

broadcast in class UIInput

Throws:

AbortProcessingException

decode

public void decode(FacesContext context)

Overrides:

decode in class UIInput

See Also:

UIComponentBase.decode(javax.faces.context.FacesContext)

encodeChildren

public void encodeChildren(FacesContext context)
                    throws IOException

Overrides:

encodeChildren in class UIComponentBase

Throws:

IOException

See Also:

UIComponentBase.encodeChildren(javax.faces.context.FacesContext)

getRendersChildren

public boolean getRendersChildren()

Overrides:

getRendersChildren in class UIComponentBase

See Also:

UIComponentBase.getRendersChildren()

encodeBegin

public void encodeBegin(FacesContext context)
                 throws IOException

Overrides:

encodeBegin in class UIComponentBase

Throws:

IOException

See Also:

UIComponentBase.encodeBegin(javax.faces.context.FacesContext)

getRowIndex

public int getRowIndex()

Returns:

current row index

setRowIndex

public void setRowIndex(int rowIndex)

Set the transient current row index. Setting this value causes all child components to have their ID values reset - so that cached clientID values are regenerated when next requested.

Parameters:

rowIndex - int

isMultiSelect

public boolean isMultiSelect()

Get the multi-select rendering flag

Returns:

true for multi-select rendering, false otherwise

setMultiSelect

public void setMultiSelect(boolean multiSelect)

Set true for multi-select rendering, false otherwise

Parameters:

multiSelect - True for multi-select

isActiveSelect

public boolean isActiveSelect()

Get the active selection mode flag

Returns:

true for active selection mode, false otherwise

setActiveSelect

public void setActiveSelect(boolean activeSelect)

Set true for active selection mode, false otherwise

Parameters:

activeSelect - True for active selection

getEscapeItemLabel

public boolean getEscapeItemLabel()

Get the escape item label flag

Returns:

true if the items label should be escaped, false otherwise

setEscapeItemLabel

public void setEscapeItemLabel(boolean escapeItemLabel)

Set true to escape the items label, false otherwise

Parameters:

escapeItemLabel - true to escape the items label

getEscapeItemDescription

public boolean getEscapeItemDescription()

Get the escape item description flag

Returns:

true if the items description should be escaped, false otherwise

setEscapeItemDescription

public void setEscapeItemDescription(boolean escapeItemDescription)

Set true to escape the items description, false otherwise

Parameters:

escapeItemDescription - true to escape the items description