org.primefaces.component.picklist
Class PickList

java.lang.Object
  javax.faces.component.UIComponent
      javax.faces.component.UIComponentBase
          javax.faces.component.UIOutput
              javax.faces.component.UIInput
                  org.primefaces.component.picklist.PickList

All Implemented Interfaces:

EventListener, javax.faces.component.behavior.ClientBehaviorHolder, javax.faces.component.EditableValueHolder, javax.faces.component.PartialStateHolder, javax.faces.component.StateHolder, javax.faces.component.TransientStateHolder, javax.faces.component.ValueHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, Widget

public class PickList
extends javax.faces.component.UIInput
implements Widget, javax.faces.component.behavior.ClientBehaviorHolder

Nested Class Summary

protected static class

PickList.PropertyKeys

Field Summary

static String	ADD_ALL_BUTTON_CLASS
static String	ADD_ALL_BUTTON_ICON_CLASS
static String	ADD_BUTTON_CLASS
static String	ADD_BUTTON_ICON_CLASS
static String	CAPTION_CLASS
static String	COMPONENT_FAMILY
static String	COMPONENT_TYPE
static String	CONTAINER_CLASS
static String	FILTER_CLASS
static String	FILTER_CONTAINER
static String	ITEM_CLASS
static String	ITEM_DISABLED_CLASS
static String	LIST_CLASS
static String	MOVE_BOTTOM_BUTTON_CLASS
static String	MOVE_BOTTOM_BUTTON_ICON_CLASS
static String	MOVE_DOWN_BUTTON_CLASS
static String	MOVE_DOWN_BUTTON_ICON_CLASS
static String	MOVE_TOP_BUTTON_CLASS
static String	MOVE_TOP_BUTTON_ICON_CLASS
static String	MOVE_UP_BUTTON_CLASS
static String	MOVE_UP_BUTTON_ICON_CLASS
static String	REMOVE_ALL_BUTTON_CLASS
static String	REMOVE_ALL_BUTTON_ICON_CLASS
static String	REMOVE_BUTTON_CLASS
static String	REMOVE_BUTTON_ICON_CLASS
static String	SOURCE_CLASS
static String	SOURCE_CONTROLS
static String	TARGET_CLASS
static String	TARGET_CONTROLS

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

PickList()

Method Summary

String	getAddAllLabel()
String	getAddLabel()
String	getEffect()
String	getEffectSpeed()
Collection<String>	getEventNames()
protected javax.faces.context.FacesContext	getFacesContext()
String	getFamily()
String	getFilterFunction()
String	getFilterMatchMode()
String	getItemLabel()
Object	getItemValue()
String	getLabel()
String	getMoveBottomLabel()
String	getMoveDownLabel()
String	getMoveTopLabel()
String	getMoveUpLabel()
String	getOnTransfer()
String	getRemoveAllLabel()
String	getRemoveLabel()
String	getStyle()
String	getStyleClass()
String	getVar()
String	getWidgetVar()
void	handleAttribute(String name, Object value)
boolean	isDisabled()
boolean	isItemDisabled()
boolean	isShowCheckbox()
boolean	isShowSourceControls()
boolean	isShowSourceFilter()
boolean	isShowTargetControls()
boolean	isShowTargetFilter()
void	populateModel(javax.faces.context.FacesContext context, String[] values, List model)
void	queueEvent(javax.faces.event.FacesEvent event)
String	resolveWidgetVar()
void	setAddAllLabel(String _addAllLabel)
void	setAddLabel(String _addLabel)
void	setDisabled(boolean _disabled)
void	setEffect(String _effect)
void	setEffectSpeed(String _effectSpeed)
void	setFilterFunction(String _filterFunction)
void	setFilterMatchMode(String _filterMatchMode)
void	setItemDisabled(boolean _itemDisabled)
void	setItemLabel(String _itemLabel)
void	setItemValue(Object _itemValue)
void	setLabel(String _label)
void	setMoveBottomLabel(String _moveBottomLabel)
void	setMoveDownLabel(String _moveDownLabel)
void	setMoveTopLabel(String _moveTopLabel)
void	setMoveUpLabel(String _moveUpLabel)
void	setOnTransfer(String _onTransfer)
void	setRemoveAllLabel(String _removeAllLabel)
void	setRemoveLabel(String _removeLabel)
void	setShowCheckbox(boolean _showCheckbox)
void	setShowSourceControls(boolean _showSourceControls)
void	setShowSourceFilter(boolean _showSourceFilter)
void	setShowTargetControls(boolean _showTargetControls)
void	setShowTargetFilter(boolean _showTargetFilter)
void	setStyle(String _style)
void	setStyleClass(String _styleClass)
void	setVar(String _var)
void	setWidgetVar(String _widgetVar)
protected void	validateValue(javax.faces.context.FacesContext facesContext, Object newValue)

Methods inherited from class javax.faces.component.UIInput

addValidator, addValueChangeListener, clearInitialState, compareValues, 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, getDefaultEventName, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getListenersForEventClass, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class javax.faces.component.UIComponent

encodeAll, getClientId, getCompositeComponentParent, getContainerClientId, getCurrentComponent, getCurrentCompositeComponent, getNamingContainer, getResourceBundleMap, getStateHelper, getStateHelper, getTransientStateHelper, getTransientStateHelper, getValueExpression, initialStateMarked, isCompositeComponent, isInView, isVisitable, popComponentFromEL, processEvent, pushComponentToEL, restoreTransientState, saveTransientState, setInView, setValueExpression, 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, getDefaultEventName

Methods inherited from interface javax.faces.component.ValueHolder

getConverter, getLocalValue, getValue, setConverter

Field Detail

COMPONENT_TYPE

public static final String COMPONENT_TYPE

See Also:

Constant Field Values

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY

See Also:

Constant Field Values

CONTAINER_CLASS

public static final String CONTAINER_CLASS

See Also:

Constant Field Values

LIST_CLASS

public static final String LIST_CLASS

See Also:

Constant Field Values

SOURCE_CLASS

public static final String SOURCE_CLASS

See Also:

Constant Field Values

TARGET_CLASS

public static final String TARGET_CLASS

See Also:

Constant Field Values

SOURCE_CONTROLS

public static final String SOURCE_CONTROLS

See Also:

Constant Field Values

TARGET_CONTROLS

public static final String TARGET_CONTROLS

See Also:

Constant Field Values

ITEM_CLASS

public static final String ITEM_CLASS

See Also:

Constant Field Values

ITEM_DISABLED_CLASS

public static final String ITEM_DISABLED_CLASS

See Also:

Constant Field Values

CAPTION_CLASS

public static final String CAPTION_CLASS

See Also:

Constant Field Values

ADD_BUTTON_CLASS

public static final String ADD_BUTTON_CLASS

See Also:

Constant Field Values

ADD_ALL_BUTTON_CLASS

public static final String ADD_ALL_BUTTON_CLASS

See Also:

Constant Field Values

REMOVE_BUTTON_CLASS

public static final String REMOVE_BUTTON_CLASS

See Also:

Constant Field Values

REMOVE_ALL_BUTTON_CLASS

public static final String REMOVE_ALL_BUTTON_CLASS

See Also:

Constant Field Values

ADD_BUTTON_ICON_CLASS

public static final String ADD_BUTTON_ICON_CLASS

See Also:

Constant Field Values

ADD_ALL_BUTTON_ICON_CLASS

public static final String ADD_ALL_BUTTON_ICON_CLASS

See Also:

Constant Field Values

REMOVE_BUTTON_ICON_CLASS

public static final String REMOVE_BUTTON_ICON_CLASS

See Also:

Constant Field Values

REMOVE_ALL_BUTTON_ICON_CLASS

public static final String REMOVE_ALL_BUTTON_ICON_CLASS

See Also:

Constant Field Values

MOVE_UP_BUTTON_CLASS

public static final String MOVE_UP_BUTTON_CLASS

See Also:

Constant Field Values

MOVE_DOWN_BUTTON_CLASS

public static final String MOVE_DOWN_BUTTON_CLASS

See Also:

Constant Field Values

MOVE_TOP_BUTTON_CLASS

public static final String MOVE_TOP_BUTTON_CLASS

See Also:

Constant Field Values

MOVE_BOTTOM_BUTTON_CLASS

public static final String MOVE_BOTTOM_BUTTON_CLASS

See Also:

Constant Field Values

MOVE_UP_BUTTON_ICON_CLASS

public static final String MOVE_UP_BUTTON_ICON_CLASS

See Also:

Constant Field Values

MOVE_DOWN_BUTTON_ICON_CLASS

public static final String MOVE_DOWN_BUTTON_ICON_CLASS

See Also:

Constant Field Values

MOVE_TOP_BUTTON_ICON_CLASS

public static final String MOVE_TOP_BUTTON_ICON_CLASS

See Also:

Constant Field Values

MOVE_BOTTOM_BUTTON_ICON_CLASS

public static final String MOVE_BOTTOM_BUTTON_ICON_CLASS

See Also:

Constant Field Values

FILTER_CLASS

public static final String FILTER_CLASS

See Also:

Constant Field Values

FILTER_CONTAINER

public static final String FILTER_CONTAINER

See Also:

Constant Field Values

Constructor Detail

PickList

public PickList()

Method Detail

getFamily

public String getFamily()

Overrides:

getFamily in class javax.faces.component.UIInput

getWidgetVar

public String getWidgetVar()

setWidgetVar

public void setWidgetVar(String _widgetVar)

getVar

public String getVar()

setVar

public void setVar(String _var)

getItemLabel

public String getItemLabel()

setItemLabel

public void setItemLabel(String _itemLabel)

getItemValue

public Object getItemValue()

setItemValue

public void setItemValue(Object _itemValue)

getStyle

public String getStyle()

setStyle

public void setStyle(String _style)

getStyleClass

public String getStyleClass()

setStyleClass

public void setStyleClass(String _styleClass)

isDisabled

public boolean isDisabled()

setDisabled

public void setDisabled(boolean _disabled)

getEffect

public String getEffect()

setEffect

public void setEffect(String _effect)

getEffectSpeed

public String getEffectSpeed()

setEffectSpeed

public void setEffectSpeed(String _effectSpeed)

getAddLabel

public String getAddLabel()

setAddLabel

public void setAddLabel(String _addLabel)

getAddAllLabel

public String getAddAllLabel()

setAddAllLabel

public void setAddAllLabel(String _addAllLabel)

getRemoveLabel

public String getRemoveLabel()

setRemoveLabel

public void setRemoveLabel(String _removeLabel)

getRemoveAllLabel

public String getRemoveAllLabel()

setRemoveAllLabel

public void setRemoveAllLabel(String _removeAllLabel)

getMoveUpLabel

public String getMoveUpLabel()

setMoveUpLabel

public void setMoveUpLabel(String _moveUpLabel)

getMoveTopLabel

public String getMoveTopLabel()

setMoveTopLabel

public void setMoveTopLabel(String _moveTopLabel)

getMoveDownLabel

public String getMoveDownLabel()

setMoveDownLabel

public void setMoveDownLabel(String _moveDownLabel)

getMoveBottomLabel

public String getMoveBottomLabel()

setMoveBottomLabel

public void setMoveBottomLabel(String _moveBottomLabel)

isShowSourceControls

public boolean isShowSourceControls()

setShowSourceControls

public void setShowSourceControls(boolean _showSourceControls)

isShowTargetControls

public boolean isShowTargetControls()

setShowTargetControls

public void setShowTargetControls(boolean _showTargetControls)

getOnTransfer

public String getOnTransfer()

setOnTransfer

public void setOnTransfer(String _onTransfer)

getLabel

public String getLabel()

setLabel

public void setLabel(String _label)

isItemDisabled

public boolean isItemDisabled()

setItemDisabled

public void setItemDisabled(boolean _itemDisabled)

isShowSourceFilter

public boolean isShowSourceFilter()

setShowSourceFilter

public void setShowSourceFilter(boolean _showSourceFilter)

isShowTargetFilter

public boolean isShowTargetFilter()

setShowTargetFilter

public void setShowTargetFilter(boolean _showTargetFilter)

getFilterMatchMode

public String getFilterMatchMode()

setFilterMatchMode

public void setFilterMatchMode(String _filterMatchMode)

getFilterFunction

public String getFilterFunction()

setFilterFunction

public void setFilterFunction(String _filterFunction)

isShowCheckbox

public boolean isShowCheckbox()

setShowCheckbox

public void setShowCheckbox(boolean _showCheckbox)

getEventNames

public Collection<String> getEventNames()

Specified by:

getEventNames in interface javax.faces.component.behavior.ClientBehaviorHolder

Overrides:

getEventNames in class javax.faces.component.UIComponentBase

validateValue

protected void validateValue(javax.faces.context.FacesContext facesContext,
                             Object newValue)

Overrides:

validateValue in class javax.faces.component.UIInput

queueEvent

public void queueEvent(javax.faces.event.FacesEvent event)

Overrides:

queueEvent in class javax.faces.component.UIComponentBase

populateModel

public void populateModel(javax.faces.context.FacesContext context,
                          String[] values,
                          List model)

getFacesContext

protected javax.faces.context.FacesContext getFacesContext()

Overrides:

getFacesContext in class javax.faces.component.UIComponentBase

resolveWidgetVar

public String resolveWidgetVar()

Specified by:

resolveWidgetVar in interface Widget

handleAttribute

public void handleAttribute(String name,
                            Object value)