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.ValueHolder, javax.faces.event.ComponentSystemEventListener, javax.faces.event.FacesListener, javax.faces.event.SystemEventListenerHolder, PrimeClientBehaviorHolder, Widget

public class PickList
extends javax.faces.component.UIInput

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	org.primefaces.component.picklist.PickListBase.PropertyKeys

Field Summary

Fields

Modifier and Type	Field and Description
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	BUTTONS_CELL_CLASS
static String	BUTTONS_CLASS
static String	CAPTION_CLASS
static String	COMPONENT_FAMILY
static String	COMPONENT_TYPE
static String	CONTAINER_CLASS
static String	DEFAULT_RENDERER
static String	FILTER_CLASS
static String	FILTER_CONTAINER
static String	ITEM_CLASS
static String	ITEM_DISABLED_CLASS
static String	LIST_CLASS
static String	LIST_WRAPPER_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
static String	VERTICAL_ADD_ALL_BUTTON_ICON_CLASS
static String	VERTICAL_ADD_BUTTON_ICON_CLASS
static String	VERTICAL_REMOVE_ALL_BUTTON_ICON_CLASS
static String	VERTICAL_REMOVE_BUTTON_ICON_CLASS

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

BEANINFO_KEY, bindings, COMPOSITE_COMPONENT_TYPE_KEY, COMPOSITE_FACET_NAME, CURRENT_COMPONENT, CURRENT_COMPOSITE_COMPONENT, FACETS_KEY, VIEW_LOCATION_KEY

Constructor Summary

Constructors

Constructor and Description
PickList()

Method Summary

Modifier and Type	Method and Description
protected void	checkDisabled(javax.faces.context.FacesContext facesContext, String label, List<?> newEntries, List<?> oldEntries) Prohibits client-side manipulation of disabled entries, when CSS style-class ui-state-disabled is removed.
String	getAddAllLabel()
String	getAddLabel()
Map<String,Class<? extends javax.faces.event.BehaviorEvent>>	getBehaviorEventMapping()
String	getEffect()
String	getEffectSpeed()
Collection<String>	getEventNames()
String	getFamily()
int	getFilterDelay()
String	getFilterEvent()
String	getFilterFunction()
String	getFilterMatchMode()
String	getItemLabel()
Object	getItemValue()
String	getLabel()
String	getLabelDisplay()
String	getMoveBottomLabel()
String	getMoveDownLabel()
String	getMoveTopLabel()
String	getMoveUpLabel()
String	getOnTransfer()
String	getOrientation()
String	getRemoveAllLabel()
String	getRemoveLabel()
String	getStyle()
String	getStyleClass()
String	getTabindex()
String	getVar()
String	getWidgetVar()
boolean	isDisabled()
boolean	isEscape()
boolean	isItemDisabled()
boolean	isResponsive()
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	setEscape(boolean escape)
void	setFilterDelay(int filterDelay)
void	setFilterEvent(String filterEvent)
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	setLabelDisplay(String labelDisplay)
void	setMoveBottomLabel(String moveBottomLabel)
void	setMoveDownLabel(String moveDownLabel)
void	setMoveTopLabel(String moveTopLabel)
void	setMoveUpLabel(String moveUpLabel)
void	setOnTransfer(String onTransfer)
void	setOrientation(String orientation)
void	setRemoveAllLabel(String removeAllLabel)
void	setRemoveLabel(String removeLabel)
void	setResponsive(boolean responsive)
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	setTabindex(String tabindex)
void	setVar(String var)
void	setWidgetVar(String widgetVar)
void	validate(javax.faces.context.FacesContext context)
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

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, getFacesContext, getFacesListeners, getFacet, getFacetCount, getFacets, getFacetsAndChildren, getId, getParent, getRenderer, getRendererType, getRendersChildren, getValueBinding, invokeOnComponent, isRendered, isTransient, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, setValueBinding

Methods inherited from class javax.faces.component.UIComponent

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

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

LIST_WRAPPER_CLASS

public static final String LIST_WRAPPER_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

BUTTONS_CLASS

public static final String BUTTONS_CLASS

See Also:

Constant Field Values

BUTTONS_CELL_CLASS

public static final String BUTTONS_CELL_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

VERTICAL_ADD_BUTTON_ICON_CLASS

public static final String VERTICAL_ADD_BUTTON_ICON_CLASS

See Also:

Constant Field Values

VERTICAL_ADD_ALL_BUTTON_ICON_CLASS

public static final String VERTICAL_ADD_ALL_BUTTON_ICON_CLASS

See Also:

Constant Field Values

VERTICAL_REMOVE_BUTTON_ICON_CLASS

public static final String VERTICAL_REMOVE_BUTTON_ICON_CLASS

See Also:

Constant Field Values

VERTICAL_REMOVE_ALL_BUTTON_ICON_CLASS

public static final String VERTICAL_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

COMPONENT_FAMILY

public static final String COMPONENT_FAMILY

See Also:

Constant Field Values

DEFAULT_RENDERER

public static final String DEFAULT_RENDERER

See Also:

Constant Field Values

Constructor Detail

PickList

public PickList()

Method Detail

getBehaviorEventMapping

public Map<String,Class<? extends javax.faces.event.BehaviorEvent>> getBehaviorEventMapping()

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

checkDisabled

protected void checkDisabled(javax.faces.context.FacesContext facesContext,
                             String label,
                             List<?> newEntries,
                             List<?> oldEntries)

Prohibits client-side manipulation of disabled entries, when CSS style-class ui-state-disabled is removed. See https://github.com/primefaces/primefaces/issues/2127

Parameters:

newEntries - new/set entries of model source/target list

oldEntries - old/former entries of model source/target list

validate

public void validate(javax.faces.context.FacesContext context)

Overrides:

validate 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)

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)

getLabelDisplay

public String getLabelDisplay()

setLabelDisplay

public void setLabelDisplay(String labelDisplay)

getOrientation

public String getOrientation()

setOrientation

public void setOrientation(String orientation)

isResponsive

public boolean isResponsive()

setResponsive

public void setResponsive(boolean responsive)

getTabindex

public String getTabindex()

setTabindex

public void setTabindex(String tabindex)

getFilterEvent

public String getFilterEvent()

setFilterEvent

public void setFilterEvent(String filterEvent)

getFilterDelay

public int getFilterDelay()

setFilterDelay

public void setFilterDelay(int filterDelay)

isEscape

public boolean isEscape()

setEscape

public void setEscape(boolean escape)

resolveWidgetVar

public String resolveWidgetVar()

Specified by:

resolveWidgetVar in interface Widget