|
RichFaces UI Components UI 4.3.0.CR1 | |||||||||
| 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
javax.faces.component.UISelectMany
org.richfaces.component.AbstractSelectManyComponent
org.richfaces.component.AbstractOrderingComponent
org.richfaces.component.AbstractPickList
org.richfaces.component.UIPickList
@Generated(value={"RichFaces CDK","4.3.0.CR1"})
public class UIPickList
The <rich:pickList> is a component for selecting items from a list. Additionally, it allows for the selected items to be ordered (client-side). From the client side perspective, items are added/removed from the source list, and removed/added to the target list.
| Nested Class Summary | |
|---|---|
protected static class |
UIPickList.Properties
|
| Field Summary | |
|---|---|
static String |
COMPONENT_FAMILY
|
static String |
COMPONENT_TYPE
|
| Fields inherited from class javax.faces.component.UISelectMany |
|---|
INVALID_MESSAGE_ID |
| Fields inherited from class javax.faces.component.UIInput |
|---|
CONVERSION_MESSAGE_ID, REQUIRED_MESSAGE_ID, UPDATE_MESSAGE_ID, VALIDATE_EMPTY_FIELDS_PARAM_NAME |
| 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 |
| Constructor Summary | |
|---|---|
UIPickList()
|
|
| Method Summary | |
|---|---|
String |
getActiveClass()
|
String |
getAddAllText()
The text to display in the add-all button |
String |
getAddText()
The text to display in the add button |
String |
getChangedClass()
|
String |
getCollectionType()
|
String |
getColumnClasses()
|
String |
getDefaultEventName()
|
String |
getDisabledClass()
|
String |
getDownBottomText()
The text to display in the move-to-bottom button |
String |
getDownText()
The text to display in the move-down button |
Collection<String> |
getEventNames()
|
String |
getFamily()
|
String |
getHeaderClass()
|
String |
getItemClass()
|
String |
getListHeight()
|
String |
getListWidth()
|
String |
getMaxListHeight()
|
String |
getMinListHeight()
|
String |
getOnadditems()
Javascript code executed when items are removed from the source list, and added to the target list |
String |
getOnblur()
Javascript code executed when this element loses focus. |
String |
getOnchange()
Javascript code executed when the list element loses focus and its value has been modified since gaining focus. |
String |
getOnclick()
|
String |
getOndblclick()
|
String |
getOnfocus()
Javascript code executed when this element receives focus |
String |
getOnkeydown()
|
String |
getOnkeypress()
|
String |
getOnkeyup()
|
String |
getOnmousedown()
|
String |
getOnmousemove()
|
String |
getOnmouseout()
|
String |
getOnmouseover()
|
String |
getOnmouseup()
|
String |
getOnremoveitems()
Javascript code executed when items are removed from the target list, and added to the source list |
String |
getOnsourceblur()
Javascript code executed when the source list element loses focus. |
String |
getOnsourceclick()
Javascript code executed when a pointer button is clicked over the source list element . |
String |
getOnsourcedblclick()
Javascript code executed when a pointer button is double clicked over the source list element . |
String |
getOnsourcefocus()
Javascript code executed when the source list element receives focus. |
String |
getOnsourcekeydown()
Javascript code executed when a key is pressed down over the source list element . |
String |
getOnsourcekeypress()
Javascript code executed when a key is pressed and released over the source list element . |
String |
getOnsourcekeyup()
Javascript code executed when a key is released over the source list element . |
String |
getOnsourcemousedown()
Javascript code executed when a pointer button is pressed down over the source list element . |
String |
getOnsourcemousemove()
Javascript code executed when a pointer button is moved within the source list element . |
String |
getOnsourcemouseout()
Javascript code executed when a pointer button is moved away from the source list element . |
String |
getOnsourcemouseover()
Javascript code executed when a pointer button is moved onto the source list element . |
String |
getOnsourcemouseup()
Javascript code executed when a pointer button is released over the source list element . |
String |
getOntargetblur()
Javascript code executed when the target list element loses focus. |
String |
getOntargetclick()
Javascript code executed when a pointer button is clicked over the target list element . |
String |
getOntargetdblclick()
Javascript code executed when a pointer button is double clicked over the target list element . |
String |
getOntargetfocus()
Javascript code executed when the target list element receives focus. |
String |
getOntargetkeydown()
Javascript code executed when a key is pressed down over the target list element . |
String |
getOntargetkeypress()
Javascript code executed when a key is pressed and released over the target list element . |
String |
getOntargetkeyup()
Javascript code executed when a key is released over the target list element . |
String |
getOntargetmousedown()
Javascript code executed when a pointer button is pressed down over the target list element . |
String |
getOntargetmousemove()
Javascript code executed when a pointer button is moved within the target list element . |
String |
getOntargetmouseout()
Javascript code executed when a pointer button is moved away from the target list element . |
String |
getOntargetmouseover()
Javascript code executed when a pointer button is moved onto the target list element . |
String |
getOntargetmouseup()
Javascript code executed when a pointer button is released over the target list element . |
String |
getRemoveAllText()
The text to display in the remove-all button |
String |
getRemoveText()
The text to display in the remove button |
String |
getSelectItemClass()
|
String |
getSourceCaption()
The text placed above the source list of items |
String |
getStyle()
|
String |
getStyleClass()
|
String |
getTargetCaption()
The text placed above the target list of items |
String |
getUpText()
The text to display in the move-up button |
String |
getUpTopText()
The text to display in the move-to-top button |
String |
getVar()
|
boolean |
isDisabled()
|
boolean |
isOrderable()
If "true", then the target list is orderable, and the ordering controls are displayed |
boolean |
isShowButton()
|
boolean |
isSwitchByClick()
if "true", then clicking an item moves it from one list to another |
boolean |
isSwitchByDblClick()
if "true", then double-clicking an item moves it from one list to another |
void |
setActiveClass(String activeClass)
|
void |
setAddAllText(String addAllText)
|
void |
setAddText(String addText)
|
void |
setChangedClass(String changedClass)
|
void |
setCollectionType(String collectionType)
|
void |
setColumnClasses(String columnClasses)
|
void |
setDisabled(boolean disabled)
|
void |
setDisabledClass(String disabledClass)
|
void |
setDownBottomText(String downBottomText)
|
void |
setDownText(String downText)
|
void |
setHeaderClass(String headerClass)
|
void |
setItemClass(String itemClass)
|
void |
setListHeight(String listHeight)
|
void |
setListWidth(String listWidth)
|
void |
setMaxListHeight(String maxListHeight)
|
void |
setMinListHeight(String minListHeight)
|
void |
setOnadditems(String onadditems)
|
void |
setOnblur(String onblur)
|
void |
setOnchange(String onchange)
|
void |
setOnclick(String onclick)
|
void |
setOndblclick(String ondblclick)
|
void |
setOnfocus(String onfocus)
|
void |
setOnkeydown(String onkeydown)
|
void |
setOnkeypress(String onkeypress)
|
void |
setOnkeyup(String onkeyup)
|
void |
setOnmousedown(String onmousedown)
|
void |
setOnmousemove(String onmousemove)
|
void |
setOnmouseout(String onmouseout)
|
void |
setOnmouseover(String onmouseover)
|
void |
setOnmouseup(String onmouseup)
|
void |
setOnremoveitems(String onremoveitems)
|
void |
setOnsourceblur(String onsourceblur)
|
void |
setOnsourceclick(String onsourceclick)
|
void |
setOnsourcedblclick(String onsourcedblclick)
|
void |
setOnsourcefocus(String onsourcefocus)
|
void |
setOnsourcekeydown(String onsourcekeydown)
|
void |
setOnsourcekeypress(String onsourcekeypress)
|
void |
setOnsourcekeyup(String onsourcekeyup)
|
void |
setOnsourcemousedown(String onsourcemousedown)
|
void |
setOnsourcemousemove(String onsourcemousemove)
|
void |
setOnsourcemouseout(String onsourcemouseout)
|
void |
setOnsourcemouseover(String onsourcemouseover)
|
void |
setOnsourcemouseup(String onsourcemouseup)
|
void |
setOntargetblur(String ontargetblur)
|
void |
setOntargetclick(String ontargetclick)
|
void |
setOntargetdblclick(String ontargetdblclick)
|
void |
setOntargetfocus(String ontargetfocus)
|
void |
setOntargetkeydown(String ontargetkeydown)
|
void |
setOntargetkeypress(String ontargetkeypress)
|
void |
setOntargetkeyup(String ontargetkeyup)
|
void |
setOntargetmousedown(String ontargetmousedown)
|
void |
setOntargetmousemove(String ontargetmousemove)
|
void |
setOntargetmouseout(String ontargetmouseout)
|
void |
setOntargetmouseover(String ontargetmouseover)
|
void |
setOntargetmouseup(String ontargetmouseup)
|
void |
setOrderable(boolean orderable)
|
void |
setRemoveAllText(String removeAllText)
|
void |
setRemoveText(String removeText)
|
void |
setSelectItemClass(String selectItemClass)
|
void |
setShowButton(boolean showButton)
|
void |
setSourceCaption(String sourceCaption)
|
void |
setStyle(String style)
|
void |
setStyleClass(String styleClass)
|
void |
setSwitchByClick(boolean switchByClick)
|
void |
setSwitchByDblClick(boolean switchByDblClick)
|
void |
setTargetCaption(String targetCaption)
|
void |
setUpText(String upText)
|
void |
setUpTopText(String upTopText)
|
void |
setVar(String var)
|
| Methods inherited from class org.richfaces.component.AbstractOrderingComponent |
|---|
compareValues |
| Methods inherited from class org.richfaces.component.AbstractSelectManyComponent |
|---|
columns, validateValue |
| Methods inherited from class javax.faces.component.UISelectMany |
|---|
getSelectedValues, getValueBinding, getValueExpression, setSelectedValues, setValueBinding, setValueExpression |
| Methods inherited from class javax.faces.component.UIInput |
|---|
addValidator, addValueChangeListener, clearInitialState, decode, getConvertedValue, getConverterMessage, getRequiredMessage, getSubmittedValue, getValidator, getValidatorMessage, getValidators, getValueChangeListener, getValueChangeListeners, isEmpty, isImmediate, isLocalValueSet, isRequired, isValid, markInitialState, processDecodes, processUpdates, processValidators, removeValidator, removeValueChangeListener, resetValue, restoreState, saveState, setConverterMessage, setImmediate, setLocalValueSet, setRequired, setRequiredMessage, setSubmittedValue, setValid, setValidator, setValidatorMessage, setValue, setValueChangeListener, updateModel, validate |
| Methods inherited from class javax.faces.component.UIOutput |
|---|
getConverter, getLocalValue, getValue, setConverter |
| Methods inherited from class javax.faces.component.UIComponentBase |
|---|
addClientBehavior, addFacesListener, broadcast, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getRenderer, getRendererType, getRendersChildren, invokeOnComponent, isRendered, isTransient, processRestoreState, processSaveState, queueEvent, 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, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, visitTree |
| 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 |
|---|
addClientBehavior, getClientBehaviors |
| Methods inherited from interface javax.faces.component.ValueHolder |
|---|
getConverter, getLocalValue, getValue, setConverter |
| Field Detail |
|---|
public static final String COMPONENT_TYPE
public static final String COMPONENT_FAMILY
| Constructor Detail |
|---|
public UIPickList()
| Method Detail |
|---|
public String getFamily()
getFamily in class javax.faces.component.UISelectManypublic Collection<String> getEventNames()
getEventNames in interface javax.faces.component.behavior.ClientBehaviorHoldergetEventNames in class javax.faces.component.UIComponentBasepublic String getDefaultEventName()
getDefaultEventName in interface javax.faces.component.behavior.ClientBehaviorHoldergetDefaultEventName in class javax.faces.component.UIComponentBasepublic String getActiveClass()
getActiveClass in class AbstractSelectManyComponentpublic void setActiveClass(String activeClass)
public String getAddAllText()
AbstractPickList
getAddAllText in class AbstractPickListpublic void setAddAllText(String addAllText)
public String getAddText()
AbstractPickList
getAddText in class AbstractPickListpublic void setAddText(String addText)
public String getChangedClass()
getChangedClass in class AbstractSelectManyComponentpublic void setChangedClass(String changedClass)
public String getCollectionType()
getCollectionType in class AbstractSelectManyComponentpublic void setCollectionType(String collectionType)
public String getColumnClasses()
getColumnClasses in class AbstractSelectManyComponentpublic void setColumnClasses(String columnClasses)
public boolean isDisabled()
isDisabled in class AbstractSelectManyComponentpublic void setDisabled(boolean disabled)
public String getDisabledClass()
getDisabledClass in class AbstractSelectManyComponentpublic void setDisabledClass(String disabledClass)
public String getDownBottomText()
AbstractOrderingComponent
getDownBottomText in class AbstractOrderingComponentpublic void setDownBottomText(String downBottomText)
public String getDownText()
AbstractOrderingComponent
getDownText in class AbstractOrderingComponentpublic void setDownText(String downText)
public String getHeaderClass()
getHeaderClass in class AbstractSelectManyComponentpublic void setHeaderClass(String headerClass)
public String getItemClass()
getItemClass in class AbstractSelectManyComponentpublic void setItemClass(String itemClass)
public String getListHeight()
getListHeight in class AbstractSelectManyComponentpublic void setListHeight(String listHeight)
public String getListWidth()
getListWidth in class AbstractSelectManyComponentpublic void setListWidth(String listWidth)
public String getMaxListHeight()
getMaxListHeight in class AbstractSelectManyComponentpublic void setMaxListHeight(String maxListHeight)
public String getMinListHeight()
getMinListHeight in class AbstractSelectManyComponentpublic void setMinListHeight(String minListHeight)
public String getOnadditems()
AbstractPickList
getOnadditems in class AbstractPickListpublic void setOnadditems(String onadditems)
public String getOnblur()
AbstractSelectManyComponent
getOnblur in class AbstractSelectManyComponentpublic void setOnblur(String onblur)
public String getOnchange()
AbstractSelectManyComponent
getOnchange in class AbstractSelectManyComponentpublic void setOnchange(String onchange)
public String getOnclick()
getOnclick in class AbstractSelectManyComponentpublic void setOnclick(String onclick)
public String getOndblclick()
getOndblclick in class AbstractSelectManyComponentpublic void setOndblclick(String ondblclick)
public String getOnfocus()
AbstractSelectManyComponent
getOnfocus in class AbstractSelectManyComponentpublic void setOnfocus(String onfocus)
public String getOnkeydown()
getOnkeydown in class AbstractSelectManyComponentpublic void setOnkeydown(String onkeydown)
public String getOnkeypress()
getOnkeypress in class AbstractSelectManyComponentpublic void setOnkeypress(String onkeypress)
public String getOnkeyup()
getOnkeyup in class AbstractSelectManyComponentpublic void setOnkeyup(String onkeyup)
public String getOnmousedown()
getOnmousedown in class AbstractSelectManyComponentpublic void setOnmousedown(String onmousedown)
public String getOnmousemove()
getOnmousemove in class AbstractSelectManyComponentpublic void setOnmousemove(String onmousemove)
public String getOnmouseout()
getOnmouseout in class AbstractSelectManyComponentpublic void setOnmouseout(String onmouseout)
public String getOnmouseover()
getOnmouseover in class AbstractSelectManyComponentpublic void setOnmouseover(String onmouseover)
public String getOnmouseup()
getOnmouseup in class AbstractSelectManyComponentpublic void setOnmouseup(String onmouseup)
public String getOnremoveitems()
AbstractPickList
getOnremoveitems in class AbstractPickListpublic void setOnremoveitems(String onremoveitems)
public String getOnsourceblur()
AbstractPickList
getOnsourceblur in class AbstractPickListpublic void setOnsourceblur(String onsourceblur)
public String getOnsourceclick()
AbstractPickList
getOnsourceclick in class AbstractPickListpublic void setOnsourceclick(String onsourceclick)
public String getOnsourcedblclick()
AbstractPickList
getOnsourcedblclick in class AbstractPickListpublic void setOnsourcedblclick(String onsourcedblclick)
public String getOnsourcefocus()
AbstractPickList
getOnsourcefocus in class AbstractPickListpublic void setOnsourcefocus(String onsourcefocus)
public String getOnsourcekeydown()
AbstractPickList
getOnsourcekeydown in class AbstractPickListpublic void setOnsourcekeydown(String onsourcekeydown)
public String getOnsourcekeypress()
AbstractPickList
getOnsourcekeypress in class AbstractPickListpublic void setOnsourcekeypress(String onsourcekeypress)
public String getOnsourcekeyup()
AbstractPickList
getOnsourcekeyup in class AbstractPickListpublic void setOnsourcekeyup(String onsourcekeyup)
public String getOnsourcemousedown()
AbstractPickList
getOnsourcemousedown in class AbstractPickListpublic void setOnsourcemousedown(String onsourcemousedown)
public String getOnsourcemousemove()
AbstractPickList
getOnsourcemousemove in class AbstractPickListpublic void setOnsourcemousemove(String onsourcemousemove)
public String getOnsourcemouseout()
AbstractPickList
getOnsourcemouseout in class AbstractPickListpublic void setOnsourcemouseout(String onsourcemouseout)
public String getOnsourcemouseover()
AbstractPickList
getOnsourcemouseover in class AbstractPickListpublic void setOnsourcemouseover(String onsourcemouseover)
public String getOnsourcemouseup()
AbstractPickList
getOnsourcemouseup in class AbstractPickListpublic void setOnsourcemouseup(String onsourcemouseup)
public String getOntargetblur()
AbstractPickList
getOntargetblur in class AbstractPickListpublic void setOntargetblur(String ontargetblur)
public String getOntargetclick()
AbstractPickList
getOntargetclick in class AbstractPickListpublic void setOntargetclick(String ontargetclick)
public String getOntargetdblclick()
AbstractPickList
getOntargetdblclick in class AbstractPickListpublic void setOntargetdblclick(String ontargetdblclick)
public String getOntargetfocus()
AbstractPickList
getOntargetfocus in class AbstractPickListpublic void setOntargetfocus(String ontargetfocus)
public String getOntargetkeydown()
AbstractPickList
getOntargetkeydown in class AbstractPickListpublic void setOntargetkeydown(String ontargetkeydown)
public String getOntargetkeypress()
AbstractPickList
getOntargetkeypress in class AbstractPickListpublic void setOntargetkeypress(String ontargetkeypress)
public String getOntargetkeyup()
AbstractPickList
getOntargetkeyup in class AbstractPickListpublic void setOntargetkeyup(String ontargetkeyup)
public String getOntargetmousedown()
AbstractPickList
getOntargetmousedown in class AbstractPickListpublic void setOntargetmousedown(String ontargetmousedown)
public String getOntargetmousemove()
AbstractPickList
getOntargetmousemove in class AbstractPickListpublic void setOntargetmousemove(String ontargetmousemove)
public String getOntargetmouseout()
AbstractPickList
getOntargetmouseout in class AbstractPickListpublic void setOntargetmouseout(String ontargetmouseout)
public String getOntargetmouseover()
AbstractPickList
getOntargetmouseover in class AbstractPickListpublic void setOntargetmouseover(String ontargetmouseover)
public String getOntargetmouseup()
AbstractPickList
getOntargetmouseup in class AbstractPickListpublic void setOntargetmouseup(String ontargetmouseup)
public boolean isOrderable()
AbstractPickListIf "true", then the target list is orderable, and the ordering controls are displayed
Default is "false"
isOrderable in class AbstractPickListpublic void setOrderable(boolean orderable)
public String getRemoveAllText()
AbstractPickList
getRemoveAllText in class AbstractPickListpublic void setRemoveAllText(String removeAllText)
public String getRemoveText()
AbstractPickList
getRemoveText in class AbstractPickListpublic void setRemoveText(String removeText)
public String getSelectItemClass()
getSelectItemClass in class AbstractSelectManyComponentpublic void setSelectItemClass(String selectItemClass)
public boolean isShowButton()
isShowButton in class AbstractOrderingComponentpublic void setShowButton(boolean showButton)
public String getSourceCaption()
AbstractPickList
getSourceCaption in class AbstractPickListpublic void setSourceCaption(String sourceCaption)
public String getStyle()
getStyle in class AbstractSelectManyComponentpublic void setStyle(String style)
public String getStyleClass()
getStyleClass in class AbstractSelectManyComponentpublic void setStyleClass(String styleClass)
public boolean isSwitchByClick()
AbstractPickListif "true", then clicking an item moves it from one list to another
Default is "false"
isSwitchByClick in class AbstractPickListpublic void setSwitchByClick(boolean switchByClick)
public boolean isSwitchByDblClick()
AbstractPickListif "true", then double-clicking an item moves it from one list to another
Default is "true"
isSwitchByDblClick in class AbstractPickListpublic void setSwitchByDblClick(boolean switchByDblClick)
public String getTargetCaption()
AbstractPickList
getTargetCaption in class AbstractPickListpublic void setTargetCaption(String targetCaption)
public String getUpText()
AbstractOrderingComponent
getUpText in class AbstractOrderingComponentpublic void setUpText(String upText)
public String getUpTopText()
AbstractOrderingComponent
getUpTopText in class AbstractOrderingComponentpublic void setUpTopText(String upTopText)
public String getVar()
getVar in class AbstractSelectManyComponentpublic void setVar(String var)
|
RichFaces UI Components UI 4.3.0.CR1 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||