|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectjavax.faces.component.UIComponent
javax.faces.component.UIComponentBase
javax.faces.component.UIOutput
javax.faces.component.UIInput
org.alfresco.web.ui.common.component.UISelectList
public class UISelectList
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.
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 | |
---|---|
UISelectList()
Default constructor |
Method Summary | |
---|---|
void |
broadcast(javax.faces.event.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(javax.faces.context.FacesContext context)
|
void |
encodeBegin(javax.faces.context.FacesContext context)
|
void |
encodeChildren(javax.faces.context.FacesContext context)
|
java.lang.String |
getClientId(javax.faces.context.FacesContext context)
|
boolean |
getEscapeItemDescription()
Get the escape item description flag |
boolean |
getEscapeItemLabel()
Get the escape item label flag |
java.lang.String |
getFamily()
|
boolean |
getRendersChildren()
|
int |
getRowIndex()
|
boolean |
isActiveSelect()
Get the active selection mode flag |
boolean |
isMultiSelect()
Get the multi-select rendering flag |
void |
processDecodes(javax.faces.context.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(javax.faces.event.FacesEvent event)
Override event queueing from child components - wrap and add current row value |
void |
restoreState(javax.faces.context.FacesContext context,
java.lang.Object state)
|
java.lang.Object |
saveState(javax.faces.context.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 |
---|
public UISelectList()
Method Detail |
---|
public java.lang.String getFamily()
getFamily
in class javax.faces.component.UIInput
UIComponent.getFamily()
public void restoreState(javax.faces.context.FacesContext context, java.lang.Object state)
restoreState
in interface javax.faces.component.StateHolder
restoreState
in class javax.faces.component.UIInput
StateHolder.restoreState(javax.faces.context.FacesContext, java.lang.Object)
public java.lang.Object saveState(javax.faces.context.FacesContext context)
saveState
in interface javax.faces.component.StateHolder
saveState
in class javax.faces.component.UIInput
StateHolder.saveState(javax.faces.context.FacesContext)
public java.lang.String getClientId(javax.faces.context.FacesContext context)
getClientId
in class javax.faces.component.UIComponentBase
public void processDecodes(javax.faces.context.FacesContext context)
processDecodes
in class javax.faces.component.UIInput
public void queueEvent(javax.faces.event.FacesEvent event)
queueEvent
in class javax.faces.component.UIComponentBase
public void broadcast(javax.faces.event.FacesEvent event) throws javax.faces.event.AbortProcessingException
broadcast
in class javax.faces.component.UIInput
javax.faces.event.AbortProcessingException
public void decode(javax.faces.context.FacesContext context)
decode
in class javax.faces.component.UIInput
UIComponentBase.decode(javax.faces.context.FacesContext)
public void encodeChildren(javax.faces.context.FacesContext context) throws java.io.IOException
encodeChildren
in class javax.faces.component.UIComponentBase
java.io.IOException
UIComponentBase.encodeChildren(javax.faces.context.FacesContext)
public boolean getRendersChildren()
getRendersChildren
in class javax.faces.component.UIComponentBase
UIComponentBase.getRendersChildren()
public void encodeBegin(javax.faces.context.FacesContext context) throws java.io.IOException
encodeBegin
in class javax.faces.component.UIComponentBase
java.io.IOException
UIComponentBase.encodeBegin(javax.faces.context.FacesContext)
public int getRowIndex()
public void setRowIndex(int rowIndex)
rowIndex
- public boolean isMultiSelect()
public void setMultiSelect(boolean multiSelect)
multiSelect
- True for multi-selectpublic boolean isActiveSelect()
public void setActiveSelect(boolean activeSelect)
activeSelect
- True for active selectionpublic boolean getEscapeItemLabel()
public void setEscapeItemLabel(boolean escapeItemLabel)
escapeItemLabel
- true to escape the items labelpublic boolean getEscapeItemDescription()
public void setEscapeItemDescription(boolean escapeItemDescription)
escapeItemDescription
- true to escape the items description
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |