PickListTag (RichFaces JSF components library 3.3.1.GA-NX9.05 API)

java.lang.Object
- javax.faces.webapp.UIComponentTagBase
- - javax.faces.webapp.UIComponentClassicTagBase
  - - javax.faces.webapp.UIComponentELTag
    - - org.richfaces.webapp.taglib.UIComponentELTagBase
      - org.ajax4jsf.webapp.taglib.UIComponentTagBase
        
        org.ajax4jsf.webapp.taglib.HtmlComponentTagBase
        
        org.richfaces.taglib.PickListTag

All Implemented Interfaces:

javax.servlet.jsp.tagext.BodyTag, javax.servlet.jsp.tagext.IterationTag, javax.servlet.jsp.tagext.JspIdConsumer, javax.servlet.jsp.tagext.JspTag, javax.servlet.jsp.tagext.Tag
```
public class PickListTag
extends org.ajax4jsf.webapp.taglib.HtmlComponentTagBase
```

Field Summary
- Fields inherited from class javax.faces.webapp.UIComponentClassicTagBase
  bodyContent, pageContext, UNIQUE_ID_PREFIX
- Fields inherited from interface javax.servlet.jsp.tagext.Tag
  EVAL_BODY_INCLUDE, EVAL_PAGE, SKIP_BODY, SKIP_PAGE
- Fields inherited from interface javax.servlet.jsp.tagext.BodyTag
  EVAL_BODY_BUFFERED, EVAL_BODY_TAG
- Fields inherited from interface javax.servlet.jsp.tagext.IterationTag
  EVAL_BODY_AGAIN

Constructor Summary

Constructors
Constructor and Description

PickListTag()

Constructors
Constructor and Description
`PickListTag()`

Method Summary

Methods
Modifier and Type	Method and Description
`java.lang.String`	`getComponentType()`
`java.lang.String`	`getRendererType()`
`void`	`release()`
`void`	`setControlClass(javax.el.ValueExpression __controlClass)` CSS class for a list Setter for controlClass
`void`	`setConverter(javax.el.ValueExpression __converter)` Id of Converter to be used or reference to a Converter Setter for converter
`void`	`setConverterMessage(javax.el.ValueExpression __converterMessage)` A ValueExpression enabled attribute that, if present, will be used as the text of the converter message, replacing any message that comes from the converter Setter for converterMessage
`void`	`setCopyAllControlLabel(javax.el.ValueExpression __copyAllControlLabel)` Defines a label for a "Copy all" control Setter for copyAllControlLabel
`void`	`setCopyAllTitle(javax.el.ValueExpression __copyAllTitle)` HTML: alt for a "Copy all" button Setter for copyAllTitle
`void`	`setCopyAllVisible(javax.el.ValueExpression __copyAllVisible)` If "false", the 'Copy All' control will not be displayed.
`void`	`setCopyControlLabel(javax.el.ValueExpression __copyControlLabel)` Defines a label for a "Copy" control Setter for copyControlLabel
`void`	`setCopyTitle(javax.el.ValueExpression __copyTitle)` HTML: alt for a "Copy" button Setter for copyTitle
`void`	`setCopyVisible(javax.el.ValueExpression __copyVisible)` If "false", the 'Copy' control will not be displayed.
`void`	`setDisabled(javax.el.ValueExpression __disabled)` If "true", disable this component on page.
`void`	`setDisabledStyle(javax.el.ValueExpression __disabledStyle)` CSS style rules to be applied to disabled controls Setter for disabledStyle
`void`	`setDisabledStyleClass(javax.el.ValueExpression __disabledStyleClass)` The disabledStyleClass for disabled controls Setter for disabledStyleClass
`void`	`setEnabledStyle(javax.el.ValueExpression __enabledStyle)` CSS style rules to be applied to enabled controls Setter for enabledStyle
`void`	`setEnabledStyleClass(javax.el.ValueExpression __enabledStyleClass)` The enabledStyleClass for enabled controls Setter for enabledStyleClass
`void`	`setFastMoveControlsVisible(javax.el.ValueExpression __fastMoveControlsVisible)` If "false", 'Copy All' and 'Remove All' controls aren't displayed.
`void`	`setImmediate(javax.el.ValueExpression __immediate)` A flag indicating that this component value must be converted and validated immediately (that is, during Apply Request Values phase), rather than waiting until a Process Validations phase Setter for immediate
`void`	`setLabel(javax.el.ValueExpression __label)` A localized user presentable name for this component.
`void`	`setListClass(javax.el.ValueExpression __listClass)` CSS class for a list Setter for listClass
`void`	`setListsHeight(javax.el.ValueExpression __listsHeight)` Defines height of the list.
`void`	`setMoveControlsVerticalAlign(javax.el.ValueExpression __moveControlsVerticalAlign)` Customizes vertically a position of move/copy controls relatively to lists.
`void`	`setMoveControlsVisible(javax.el.ValueExpression __moveControlsVisible)` If "false", 'Copy' and 'Remove' controls aren't displayed.
`void`	`setOnblur(javax.el.ValueExpression __onblur)` The client side script method to be called when the component loses the focus Setter for onblur
`void`	`setOnfocus(javax.el.ValueExpression __onfocus)` The client side script method to be called when the component gets the focus Setter for onfocus
`void`	`setOnlistchange(javax.el.ValueExpression __onlistchange)` The client side script method to be called when the list is changed Setter for onlistchange
`void`	`setOnlistchanged(javax.el.ValueExpression __onlistchanged)` The client side script method to be called before the list is changed Setter for onlistchanged
`protected void`	`setProperties(javax.faces.component.UIComponent component)`
`void`	`setRemoveAllControlLabel(javax.el.ValueExpression __removeAllControlLabel)` Defines a label for a "Remove all" control Setter for removeAllControlLabel
`void`	`setRemoveAllTitle(javax.el.ValueExpression __removeAllTitle)` HTML: alt for a "Remove" all button Setter for removeAllTitle
`void`	`setRemoveAllVisible(javax.el.ValueExpression __removeAllVisible)` If "false", the 'Remove All' control will not be displayed.
`void`	`setRemoveControlLabel(javax.el.ValueExpression __removeControlLabel)` Defines a label for a "Remove" control Setter for removeControlLabel
`void`	`setRemoveTitle(javax.el.ValueExpression __removeTitle)` HTML: alt for a "Remove" button Setter for removeTitle
`void`	`setRemoveVisible(javax.el.ValueExpression __removeVisible)` If "false", the 'Remove' control will not be displayed.
`void`	`setRequired(javax.el.ValueExpression __required)` If "true", this component is checked for non-empty input Setter for required
`void`	`setRequiredMessage(javax.el.ValueExpression __requiredMessage)` A ValueExpression enabled attribute that, if present, will be used as the text of the validation message for the "required" facility, if the "required" facility is used Setter for requiredMessage
`void`	`setShowButtonsLabel(javax.el.ValueExpression __showButtonsLabel)` Shows a label for a button.
`void`	`setSourceListWidth(javax.el.ValueExpression __sourceListWidth)` Defines width of a source list.
`void`	`setSwitchByClick(javax.el.ValueExpression __switchByClick)` If "true", items can be moved between the lists by clicking on them.
`void`	`setSwitchByDblClick(javax.el.ValueExpression __switchByDblClick)` If "true", items can be moved between the lists by double-clicking on them.
`void`	`setTargetListWidth(javax.el.ValueExpression __targetListWidth)` Defines width of a target list.
`void`	`setValidator(javax.el.MethodExpression __validator)` MethodBinding pointing at a method that is called during Process Validations phase of the request processing lifecycle, to validate the current value of this component Setter for validator
`void`	`setValidatorMessage(javax.el.ValueExpression __validatorMessage)` A ValueExpression enabled attribute that, if present, will be used as the text of the validator message, replacing any message that comes from the validator Setter for validatorMessage
`void`	`setValue(javax.el.ValueExpression __value)` The current value of this component Setter for value
`void`	`setValueChangeListener(javax.el.MethodExpression __valueChangeListener)` Listener for value changes Setter for valueChangeListener

Methods inherited from class org.ajax4jsf.webapp.taglib.HtmlComponentTagBase
setDir, setLang, setOnclick, setOndblclick, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setStyle, setStyleClass, setTitle

Methods inherited from class org.ajax4jsf.webapp.taglib.UIComponentTagBase
getExpressionFactory, isValueReference, setActionListenerProperty, setActionProperty, setBooleanProperty, setBooleanProperty, setDoubleProperty, setDoubleProperty, setFloatProperty, setFloatProperty, setIntegerProperty, setIntegerProperty, setLongProperty, setLongProperty, setProperty, setProperty, setStringProperty, setStringProperty, setValueChangedListenerProperty, setValueProperty, setValueProperty

Methods inherited from class org.richfaces.webapp.taglib.UIComponentELTagBase
setActionListenerProperty, setActionProperty, setConverterProperty, setRowKeyConverterProperty, setValidatorProperty, setValueChangeListenerProperty

Methods inherited from class javax.faces.webapp.UIComponentELTag
createComponent, getELContext, hasBinding, setBinding, setRendered

Methods inherited from class javax.faces.webapp.UIComponentClassicTagBase
addChild, addFacet, addVerbatimAfterComponent, addVerbatimBeforeComponent, createVerbatimComponent, createVerbatimComponentFromBodyContent, doAfterBody, doEndTag, doInitBody, doStartTag, encodeBegin, encodeChildren, encodeEnd, findComponent, getBodyContent, getComponentInstance, getCreated, getCreatedComponents, getDoAfterBodyValue, getDoEndValue, getDoStartValue, getFacesContext, getFacesJspId, getFacetName, getId, getIndexOfNextChildTag, getJspId, getParent, getParentUIComponentClassicTagBase, getPreviousOut, setBodyContent, setId, setJspId, setPageContext, setParent, setupResponseWriter

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface javax.servlet.jsp.tagext.Tag
doEndTag, doStartTag, getParent, setPageContext, setParent

- Constructor Detail
  - PickListTag
```
public PickListTag()
```
- Method Detail
  - setControlClass
```
public void setControlClass(javax.el.ValueExpression __controlClass)
```
    CSS class for a list Setter for controlClass
    
    Parameters:
    controlClass - - new value
  - setConverter
```
public void setConverter(javax.el.ValueExpression __converter)
```
    Id of Converter to be used or reference to a Converter Setter for converter
    
    Parameters:
    converter - - new value
  - setConverterMessage
```
public void setConverterMessage(javax.el.ValueExpression __converterMessage)
```
    A ValueExpression enabled attribute that, if present, will be used as the text of the converter message, replacing any message that comes from the converter Setter for converterMessage
    
    Parameters:
    converterMessage - - new value
  - setCopyAllControlLabel
```
public void setCopyAllControlLabel(javax.el.ValueExpression __copyAllControlLabel)
```
    Defines a label for a "Copy all" control Setter for copyAllControlLabel
    
    Parameters:
    copyAllControlLabel - - new value
  - setCopyAllTitle
```
public void setCopyAllTitle(javax.el.ValueExpression __copyAllTitle)
```
    HTML: alt for a "Copy all" button Setter for copyAllTitle
    
    Parameters:
    copyAllTitle - - new value
  - setCopyAllVisible
```
public void setCopyAllVisible(javax.el.ValueExpression __copyAllVisible)
```
    If "false", the 'Copy All' control will not be displayed. Even if this value is "true", the 'Copy All' control will not be displayed if the "fastMoveControlsVisible" attribute is "false". Default value is "true". Setter for copyAllVisible
    
    Parameters:
    copyAllVisible - - new value
  - setCopyControlLabel
```
public void setCopyControlLabel(javax.el.ValueExpression __copyControlLabel)
```
    Defines a label for a "Copy" control Setter for copyControlLabel
    
    Parameters:
    copyControlLabel - - new value
  - setCopyTitle
```
public void setCopyTitle(javax.el.ValueExpression __copyTitle)
```
    HTML: alt for a "Copy" button Setter for copyTitle
    
    Parameters:
    copyTitle - - new value
  - setCopyVisible
```
public void setCopyVisible(javax.el.ValueExpression __copyVisible)
```
    If "false", the 'Copy' control will not be displayed. Even if this value is "true", the 'Copy' control will not be displayed if the "moveControlsVisible" attribute is "false". Default value is "true". Setter for copyVisible
    
    Parameters:
    copyVisible - - new value
  - setDisabled
```
public void setDisabled(javax.el.ValueExpression __disabled)
```
    If "true", disable this component on page. Setter for disabled
    
    Parameters:
    disabled - - new value
  - setDisabledStyle
```
public void setDisabledStyle(javax.el.ValueExpression __disabledStyle)
```
    CSS style rules to be applied to disabled controls Setter for disabledStyle
    
    Parameters:
    disabledStyle - - new value
  - setDisabledStyleClass
```
public void setDisabledStyleClass(javax.el.ValueExpression __disabledStyleClass)
```
    The disabledStyleClass for disabled controls Setter for disabledStyleClass
    
    Parameters:
    disabledStyleClass - - new value
  - setEnabledStyle
```
public void setEnabledStyle(javax.el.ValueExpression __enabledStyle)
```
    CSS style rules to be applied to enabled controls Setter for enabledStyle
    
    Parameters:
    enabledStyle - - new value
  - setEnabledStyleClass
```
public void setEnabledStyleClass(javax.el.ValueExpression __enabledStyleClass)
```
    The enabledStyleClass for enabled controls Setter for enabledStyleClass
    
    Parameters:
    enabledStyleClass - - new value
  - setFastMoveControlsVisible
```
public void setFastMoveControlsVisible(javax.el.ValueExpression __fastMoveControlsVisible)
```
    If "false", 'Copy All' and 'Remove All' controls aren't displayed. Even if this value is "true", the 'Copy All' and 'Remove All' controls will not be displayed if the "copyAllVisible" and "removeAllVisible" attribute values are "false". Default value is "true". Setter for fastMoveControlsVisible
    
    Parameters:
    fastMoveControlsVisible - - new value
  - setImmediate
```
public void setImmediate(javax.el.ValueExpression __immediate)
```
    A flag indicating that this component value must be converted and validated immediately (that is, during Apply Request Values phase), rather than waiting until a Process Validations phase Setter for immediate
    
    Parameters:
    immediate - - new value
  - setLabel
```
public void setLabel(javax.el.ValueExpression __label)
```
    A localized user presentable name for this component. Setter for label
    
    Parameters:
    label - - new value
  - setListClass
```
public void setListClass(javax.el.ValueExpression __listClass)
```
    CSS class for a list Setter for listClass
    
    Parameters:
    listClass - - new value
  - setListsHeight
```
public void setListsHeight(javax.el.ValueExpression __listsHeight)
```
    Defines height of the list. Default value is "140px" Setter for listsHeight
    
    Parameters:
    listsHeight - - new value
  - setMoveControlsVerticalAlign
```
public void setMoveControlsVerticalAlign(javax.el.ValueExpression __moveControlsVerticalAlign)
```
    Customizes vertically a position of move/copy controls relatively to lists. Default value is "center". Setter for moveControlsVerticalAlign
    
    Parameters:
    moveControlsVerticalAlign - - new value
  - setMoveControlsVisible
```
public void setMoveControlsVisible(javax.el.ValueExpression __moveControlsVisible)
```
    If "false", 'Copy' and 'Remove' controls aren't displayed. Even if this value is "true", the 'Copy' and 'Remove' controls will not be displayed if the "copyVisible" and "removeVisible" attribute values are "false". Default value is "true". Setter for moveControlsVisible
    
    Parameters:
    moveControlsVisible - - new value
  - setOnblur
```
public void setOnblur(javax.el.ValueExpression __onblur)
```
    The client side script method to be called when the component loses the focus Setter for onblur
    
    Parameters:
    onblur - - new value
  - setOnfocus
```
public void setOnfocus(javax.el.ValueExpression __onfocus)
```
    The client side script method to be called when the component gets the focus Setter for onfocus
    
    Parameters:
    onfocus - - new value
  - setOnlistchange
```
public void setOnlistchange(javax.el.ValueExpression __onlistchange)
```
    The client side script method to be called when the list is changed Setter for onlistchange
    
    Parameters:
    onlistchange - - new value
  - setOnlistchanged
```
public void setOnlistchanged(javax.el.ValueExpression __onlistchanged)
```
    The client side script method to be called before the list is changed Setter for onlistchanged
    
    Parameters:
    onlistchanged - - new value
  - setRemoveAllControlLabel
```
public void setRemoveAllControlLabel(javax.el.ValueExpression __removeAllControlLabel)
```
    Defines a label for a "Remove all" control Setter for removeAllControlLabel
    
    Parameters:
    removeAllControlLabel - - new value
  - setRemoveAllTitle
```
public void setRemoveAllTitle(javax.el.ValueExpression __removeAllTitle)
```
    HTML: alt for a "Remove" all button Setter for removeAllTitle
    
    Parameters:
    removeAllTitle - - new value
  - setRemoveAllVisible
```
public void setRemoveAllVisible(javax.el.ValueExpression __removeAllVisible)
```
    If "false", the 'Remove All' control will not be displayed. Even if this value is "true", the 'Remove All' control will not be displayed if the "fastMoveControlsVisible" attribute is "false". Default value is "true". Setter for removeAllVisible
    
    Parameters:
    removeAllVisible - - new value
  - setRemoveControlLabel
```
public void setRemoveControlLabel(javax.el.ValueExpression __removeControlLabel)
```
    Defines a label for a "Remove" control Setter for removeControlLabel
    
    Parameters:
    removeControlLabel - - new value
  - setRemoveTitle
```
public void setRemoveTitle(javax.el.ValueExpression __removeTitle)
```
    HTML: alt for a "Remove" button Setter for removeTitle
    
    Parameters:
    removeTitle - - new value
  - setRemoveVisible
```
public void setRemoveVisible(javax.el.ValueExpression __removeVisible)
```
    If "false", the 'Remove' control will not be displayed. Even if this value is "true", the 'Remove' control will not be displayed if the "moveControlsVisible" attribute is "false". Default value is "true". Setter for removeVisible
    
    Parameters:
    removeVisible - - new value
  - setRequired
```
public void setRequired(javax.el.ValueExpression __required)
```
    If "true", this component is checked for non-empty input Setter for required
    
    Parameters:
    required - - new value
  - setRequiredMessage
```
public void setRequiredMessage(javax.el.ValueExpression __requiredMessage)
```
    A ValueExpression enabled attribute that, if present, will be used as the text of the validation message for the "required" facility, if the "required" facility is used Setter for requiredMessage
    
    Parameters:
    requiredMessage - - new value
  - setShowButtonsLabel
```
public void setShowButtonsLabel(javax.el.ValueExpression __showButtonsLabel)
```
    Shows a label for a button. Default value is "true" Setter for showButtonsLabel
    
    Parameters:
    showButtonsLabel - - new value
  - setSourceListWidth
```
public void setSourceListWidth(javax.el.ValueExpression __sourceListWidth)
```
    Defines width of a source list. Default value is "140px" Setter for sourceListWidth
    
    Parameters:
    sourceListWidth - - new value
  - setSwitchByClick
```
public void setSwitchByClick(javax.el.ValueExpression __switchByClick)
```
    If "true", items can be moved between the lists by clicking on them. Default value is "false". Setter for switchByClick
    
    Parameters:
    switchByClick - - new value
  - setSwitchByDblClick
```
public void setSwitchByDblClick(javax.el.ValueExpression __switchByDblClick)
```
    If "true", items can be moved between the lists by double-clicking on them. Default value is "true". Setter for switchByDblClick
    
    Parameters:
    switchByDblClick - - new value
  - setTargetListWidth
```
public void setTargetListWidth(javax.el.ValueExpression __targetListWidth)
```
    Defines width of a target list. Default value is "140px" Setter for targetListWidth
    
    Parameters:
    targetListWidth - - new value
  - setValidator
```
public void setValidator(javax.el.MethodExpression __validator)
```
    MethodBinding pointing at a method that is called during Process Validations phase of the request processing lifecycle, to validate the current value of this component Setter for validator
    
    Parameters:
    validator - - new value
  - setValidatorMessage
```
public void setValidatorMessage(javax.el.ValueExpression __validatorMessage)
```
    A ValueExpression enabled attribute that, if present, will be used as the text of the validator message, replacing any message that comes from the validator Setter for validatorMessage
    
    Parameters:
    validatorMessage - - new value
  - setValue
```
public void setValue(javax.el.ValueExpression __value)
```
    The current value of this component Setter for value
    
    Parameters:
    value - - new value
  - setValueChangeListener
```
public void setValueChangeListener(javax.el.MethodExpression __valueChangeListener)
```
    Listener for value changes Setter for valueChangeListener
    
    Parameters:
    valueChangeListener - - new value
  - release
```
public void release()
```
    Specified by:
    
    release in interface javax.servlet.jsp.tagext.Tag
    
    Overrides:
    
    release in class org.ajax4jsf.webapp.taglib.HtmlComponentTagBase
  - setProperties
```
protected void setProperties(javax.faces.component.UIComponent component)
```
    Overrides:
    
    setProperties in class org.ajax4jsf.webapp.taglib.HtmlComponentTagBase
  - getComponentType
```
public java.lang.String getComponentType()
```
    Specified by:
    
    getComponentType in class javax.faces.webapp.UIComponentTagBase
  - getRendererType
```
public java.lang.String getRendererType()
```
    Specified by:
    
    getRendererType in class javax.faces.webapp.UIComponentTagBase

Class PickListTag

Field Summary

Fields inherited from class javax.faces.webapp.UIComponentClassicTagBase

Fields inherited from interface javax.servlet.jsp.tagext.Tag

Fields inherited from interface javax.servlet.jsp.tagext.BodyTag

Fields inherited from interface javax.servlet.jsp.tagext.IterationTag

Constructor Summary

Method Summary

Methods inherited from class org.ajax4jsf.webapp.taglib.HtmlComponentTagBase

Methods inherited from class org.ajax4jsf.webapp.taglib.UIComponentTagBase

Methods inherited from class org.richfaces.webapp.taglib.UIComponentELTagBase

Methods inherited from class javax.faces.webapp.UIComponentELTag

Methods inherited from class javax.faces.webapp.UIComponentClassicTagBase

Methods inherited from class java.lang.Object

Methods inherited from interface javax.servlet.jsp.tagext.Tag

Constructor Detail

PickListTag

Method Detail

setControlClass

setConverter

setConverterMessage

setCopyAllControlLabel

setCopyAllTitle

setCopyAllVisible

setCopyControlLabel

setCopyTitle

setCopyVisible

setDisabled

setDisabledStyle

setDisabledStyleClass

setEnabledStyle

setEnabledStyleClass

setFastMoveControlsVisible

setImmediate

setLabel

setListClass

setListsHeight

setMoveControlsVerticalAlign

setMoveControlsVisible

setOnblur

setOnfocus

setOnlistchange

setOnlistchanged

setRemoveAllControlLabel

setRemoveAllTitle

setRemoveAllVisible

setRemoveControlLabel

setRemoveTitle

setRemoveVisible

setRequired

setRequiredMessage

setShowButtonsLabel

setSourceListWidth

setSwitchByClick

setSwitchByDblClick

setTargetListWidth

setValidator

setValidatorMessage

setValue

setValueChangeListener

release

setProperties

getComponentType

getRendererType