@Generated(value={"RichFaces CDK","4.5.0-SNAPSHOT"}) public class UIPickList extends AbstractPickList implements javax.faces.component.behavior.ClientBehaviorHolder, EventsKeyProps, EventsMouseProps, MultiSelectProps
The <r:pickList> is a component for pick items in a list (client-side).
| Modifier and Type | Class and Description |
|---|---|
protected static class |
UIPickList.Properties |
| Modifier and Type | Field and Description |
|---|---|
static String |
COMPONENT_FAMILY |
static String |
COMPONENT_TYPE |
| Constructor and Description |
|---|
UIPickList() |
| Modifier and Type | Method and Description |
|---|---|
String |
getAddAllText()
The text to display in the add-all button
|
String |
getAddText()
The text to display in the add button
|
String |
getCaption()
The text placed above the list of items
|
String |
getCollectionType()
Optional attribute that is a literal string that is the fully qualified class name of a concrete class that
implements java.util.Collection, or an EL expression that evaluates to either 1.
|
String |
getColumnClasses()
columnClasses specifies a comma-delimited list of CSS style classes to apply to each column.
|
String |
getDefaultEventName() |
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 |
getListHeight()
The height of the list element (in pixels)
|
String |
getMaxListHeight()
The maximum height of the item list (in pixels).
|
String |
getMinListHeight()
The minimum height of the item list (in pixels).
|
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()
Javascript code executed when a pointer button is clicked over this element.
|
String |
getOndblclick()
Javascript code executed when a pointer button is double clicked over this element.
|
String |
getOnfocus()
Javascript code executed when this element receives focus
|
String |
getOnkeydown()
Javascript code executed when a key is pressed down over this element.
|
String |
getOnkeypress()
Javascript code executed when a key is pressed and released over this element.
|
String |
getOnkeyup()
Javascript code executed when a key is released over this element.
|
String |
getOnmousedown()
Javascript code executed when a pointer button is pressed down over this element.
|
String |
getOnmousemove()
Javascript code executed when a pointer button is moved within this element.
|
String |
getOnmouseout()
Javascript code executed when a pointer button is moved away from this element.
|
String |
getOnmouseover()
Javascript code executed when a pointer button is moved onto this element.
|
String |
getOnmouseup()
Javascript code executed when a pointer button is released over this element.
|
String |
getOnremoveitems()
Javascript code executed when items are removed from the target list, and added to the source list
|
String |
getRemoveAllText()
The text to display in the remove-all button
|
String |
getRemoveText()
The text to display in the remove button
|
String |
getSourceCaption()
The text placed above the source list of items
|
String |
getStyle()
CSS style(s) to be applied when this component is rendered.
|
String |
getStyleClass()
Space-separated list of CSS style class(es) to be applied when this element is rendered.
|
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()
Expose the value from the value attribute under this request scoped key so that it may be referred to in EL for the value of other attributes.
|
boolean |
isDisabled()
Flag indicating that this element must never receive focus or be included in a subsequent submit.
|
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 |
setAddAllText(String addAllText) |
void |
setAddText(String addText) |
void |
setCaption(String caption) |
void |
setCollectionType(String collectionType) |
void |
setColumnClasses(String columnClasses) |
void |
setDisabled(boolean disabled) |
void |
setDownBottomText(String downBottomText) |
void |
setDownText(String downText) |
void |
setListHeight(String listHeight) |
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 |
setOrderable(boolean orderable) |
void |
setRemoveAllText(String removeAllText) |
void |
setRemoveText(String removeText) |
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) |
getPickButtonsTextcompareValues, getOrderButtonsTextcolumns, validateValuegetSelectedValues, getValueBinding, getValueExpression, setSelectedValues, setValueBinding, setValueExpressionaddValidator, addValueChangeListener, clearInitialState, decode, getConvertedValue, getConverterMessage, getRequiredMessage, getSubmittedValue, getValidator, getValidatorMessage, getValidators, getValue, 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, validategetConverter, getLocalValue, setConverteraddClientBehavior, addFacesListener, broadcast, encodeBegin, encodeChildren, encodeEnd, findComponent, getAttributes, getChildCount, getChildren, getClientBehaviors, getClientId, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getPassThroughAttributes, getRenderer, getRendererType, getRendersChildren, invokeOnComponent, isRendered, isTransient, processRestoreState, processSaveState, queueEvent, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, subscribeToEvent, unsubscribeFromEventencodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getPassThroughAttributes, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, visitTreeclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitpublic static final String COMPONENT_TYPE
public static final String COMPONENT_FAMILY
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 getAddAllText()
AbstractPickListgetAddAllText in class AbstractPickListpublic void setAddAllText(String addAllText)
public String getAddText()
AbstractPickListgetAddText in class AbstractPickListpublic void setAddText(String addText)
public String getCaption()
AbstractOrderingComponentgetCaption in class AbstractOrderingComponentpublic void setCaption(String caption)
public String getCollectionType()
MultiSelectPropsgetCollectionType in interface MultiSelectPropspublic void setCollectionType(String collectionType)
public String getColumnClasses()
MultiSelectPropsgetColumnClasses in interface MultiSelectPropspublic void setColumnClasses(String columnClasses)
public boolean isDisabled()
DisabledPropsisDisabled in interface DisabledPropspublic void setDisabled(boolean disabled)
public String getDownBottomText()
AbstractOrderingComponentgetDownBottomText in class AbstractOrderingComponentpublic void setDownBottomText(String downBottomText)
public String getDownText()
AbstractOrderingComponentgetDownText in class AbstractOrderingComponentpublic void setDownText(String downText)
public String getListHeight()
MultiSelectPropsgetListHeight in interface MultiSelectPropspublic void setListHeight(String listHeight)
public String getMaxListHeight()
MultiSelectPropsgetMaxListHeight in interface MultiSelectPropspublic void setMaxListHeight(String maxListHeight)
public String getMinListHeight()
MultiSelectPropsgetMinListHeight in interface MultiSelectPropspublic void setMinListHeight(String minListHeight)
public String getOnadditems()
AbstractPickListgetOnadditems in class AbstractPickListpublic void setOnadditems(String onadditems)
public String getOnblur()
MultiSelectPropsgetOnblur in interface MultiSelectPropspublic void setOnblur(String onblur)
public String getOnchange()
MultiSelectPropsgetOnchange in interface MultiSelectPropspublic void setOnchange(String onchange)
public String getOnclick()
EventsMousePropsgetOnclick in interface EventsMousePropspublic void setOnclick(String onclick)
public String getOndblclick()
EventsMousePropsgetOndblclick in interface EventsMousePropspublic void setOndblclick(String ondblclick)
public String getOnfocus()
MultiSelectPropsgetOnfocus in interface MultiSelectPropspublic void setOnfocus(String onfocus)
public String getOnkeydown()
EventsKeyPropsgetOnkeydown in interface EventsKeyPropspublic void setOnkeydown(String onkeydown)
public String getOnkeypress()
EventsKeyPropsgetOnkeypress in interface EventsKeyPropspublic void setOnkeypress(String onkeypress)
public String getOnkeyup()
EventsKeyPropsgetOnkeyup in interface EventsKeyPropspublic void setOnkeyup(String onkeyup)
public String getOnmousedown()
EventsMousePropsgetOnmousedown in interface EventsMousePropspublic void setOnmousedown(String onmousedown)
public String getOnmousemove()
EventsMousePropsgetOnmousemove in interface EventsMousePropspublic void setOnmousemove(String onmousemove)
public String getOnmouseout()
EventsMousePropsgetOnmouseout in interface EventsMousePropspublic void setOnmouseout(String onmouseout)
public String getOnmouseover()
EventsMousePropsgetOnmouseover in interface EventsMousePropspublic void setOnmouseover(String onmouseover)
public String getOnmouseup()
EventsMousePropsgetOnmouseup in interface EventsMousePropspublic void setOnmouseup(String onmouseup)
public String getOnremoveitems()
AbstractPickListgetOnremoveitems in class AbstractPickListpublic void setOnremoveitems(String onremoveitems)
public boolean isOrderable()
AbstractPickListIf "true", then the target list is orderable, and the ordering controls are displayed
Default is "true"
isOrderable in class AbstractPickListpublic void setOrderable(boolean orderable)
public String getRemoveAllText()
AbstractPickListgetRemoveAllText in class AbstractPickListpublic void setRemoveAllText(String removeAllText)
public String getRemoveText()
AbstractPickListgetRemoveText in class AbstractPickListpublic void setRemoveText(String removeText)
public boolean isShowButton()
isShowButton in class AbstractOrderingComponentpublic void setShowButton(boolean showButton)
public String getSourceCaption()
AbstractPickListgetSourceCaption in class AbstractPickListpublic void setSourceCaption(String sourceCaption)
public String getStyle()
StylePropsgetStyle in interface StylePropspublic void setStyle(String style)
public String getStyleClass()
StyleClassPropsgetStyleClass in interface StyleClassPropspublic 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()
AbstractPickListgetTargetCaption in class AbstractPickListpublic void setTargetCaption(String targetCaption)
public String getUpText()
AbstractOrderingComponentgetUpText in class AbstractOrderingComponentpublic void setUpText(String upText)
public String getUpTopText()
AbstractOrderingComponentgetUpTopText in class AbstractOrderingComponentpublic void setUpTopText(String upTopText)
public String getVar()
MultiSelectPropsgetVar in interface MultiSelectPropspublic void setVar(String var)
Copyright © 2014 JBoss by Red Hat. All rights reserved.