Package 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.PickListBase

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, PrimeClientBehaviorHolder, Widget

public class PickList
extends PickListBase

Nested Class Summary

Nested classes/interfaces inherited from class org.primefaces.component.picklist.PickListBase

PickListBase.PropertyKeys

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ADD_ALL_BUTTON_CLASS
static final String	ADD_ALL_BUTTON_ICON_CLASS
static final String	ADD_BUTTON_CLASS
static final String	ADD_BUTTON_ICON_CLASS
static final String	BUTTONS_CELL_CLASS
static final String	BUTTONS_CLASS
static final String	CAPTION_CLASS
static final String	COMPONENT_TYPE
static final String	CONTAINER_CLASS
static final String	FILTER_CLASS
static final String	FILTER_CONTAINER
static final String	ITEM_CLASS
static final String	ITEM_DISABLED_CLASS
static final String	LIST_CLASS
static final String	LIST_WRAPPER_CLASS
static final String	MOVE_BOTTOM_BUTTON_CLASS
static final String	MOVE_BOTTOM_BUTTON_ICON_CLASS
static final String	MOVE_DOWN_BUTTON_CLASS
static final String	MOVE_DOWN_BUTTON_ICON_CLASS
static final String	MOVE_TOP_BUTTON_CLASS
static final String	MOVE_TOP_BUTTON_ICON_CLASS
static final String	MOVE_UP_BUTTON_CLASS
static final String	MOVE_UP_BUTTON_ICON_CLASS
static final String	REMOVE_ALL_BUTTON_CLASS
static final String	REMOVE_ALL_BUTTON_ICON_CLASS
static final String	REMOVE_BUTTON_CLASS
static final String	REMOVE_BUTTON_ICON_CLASS
static final String	SOURCE_CLASS
static final String	SOURCE_CONTROLS
static final String	TARGET_CLASS
static final String	TARGET_CONTROLS
static final String	VERTICAL_ADD_ALL_BUTTON_ICON_CLASS
static final String	VERTICAL_ADD_BUTTON_ICON_CLASS
static final String	VERTICAL_REMOVE_ALL_BUTTON_ICON_CLASS
static final String	VERTICAL_REMOVE_BUTTON_ICON_CLASS

Fields inherited from class org.primefaces.component.picklist.PickListBase

COMPONENT_FAMILY, DEFAULT_RENDERER

Fields inherited from class javax.faces.component.UIInput

ALWAYS_PERFORM_VALIDATION_WHEN_REQUIRED_IS_TRUE, CONVERSION_MESSAGE_ID, EMPTY_STRING_AS_NULL_PARAM_NAME, 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

Fields inherited from interface org.primefaces.component.api.PrimeClientBehaviorHolder

DEFAULT_SELECT_EVENT_NAMES

Fields inherited from interface org.primefaces.component.api.Widget

ATTR_WIDGET_VAR_PATTERN, CALLBACK_POST_CONSTRUCT, CALLBACK_POST_REFRESH, CALLBACK_PRE_DESTROY

Constructor Summary

Constructors

Constructor	Description
PickList()

Method Summary

Modifier and Type	Method	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.
Map<String,Class<? extends javax.faces.event.BehaviorEvent>>	getBehaviorEventMapping()
String	getDefaultEventName()
Collection<String>	getEventNames()
void	populateModel(javax.faces.context.FacesContext context, String[] values, List model)
void	queueEvent(javax.faces.event.FacesEvent event)
Object	saveState(javax.faces.context.FacesContext context)
void	validate(javax.faces.context.FacesContext context)
protected void	validateValue(javax.faces.context.FacesContext facesContext, Object newValue)

Methods inherited from class org.primefaces.component.picklist.PickListBase

getEffect, getEffectSpeed, getFamily, getFilterDelay, getFilterEvent, getFilterFunction, getFilterMatchMode, getItemLabel, getItemValue, getLabel, getLabelDisplay, getOnTransfer, getOrientation, getSourceFilterPlaceholder, getStyle, getStyleClass, getTabindex, getTargetFilterPlaceholder, getVar, getWidgetVar, isDisabled, isEscape, isEscapeValue, isFilterNormalize, isItemDisabled, isResponsive, isShowCheckbox, isShowSourceControls, isShowSourceFilter, isShowTargetControls, isShowTargetFilter, isTransferOnCheckboxClick, isTransferOnDblclick, setDisabled, setEffect, setEffectSpeed, setEscape, setEscapeValue, setFilterDelay, setFilterEvent, setFilterFunction, setFilterMatchMode, setFilterNormalize, setItemDisabled, setItemLabel, setItemValue, setLabel, setLabelDisplay, setOnTransfer, setOrientation, setResponsive, setShowCheckbox, setShowSourceControls, setShowSourceFilter, setShowTargetControls, setShowTargetFilter, setSourceFilterPlaceholder, setStyle, setStyleClass, setTabindex, setTargetFilterPlaceholder, setTransferOnCheckboxClick, setTransferOnDblclick, setVar, setWidgetVar

Methods inherited from class javax.faces.component.UIInput

addValidator, addValueChangeListener, clearInitialState, compareValues, decode, getConvertedValue, getConverterMessage, getRequiredMessage, getSubmittedValue, getValidator, getValidatorMessage, getValidators, getValue, getValueChangeListener, getValueChangeListeners, isEmpty, isImmediate, isLocalValueSet, isRequired, isValid, markInitialState, processDecodes, processUpdates, processValidators, removeValidator, removeValueChangeListener, resetValue, restoreState, setConverterMessage, setImmediate, setLocalValueSet, setRequired, setRequiredMessage, setSubmittedValue, setValid, setValidator, setValidatorMessage, setValue, setValueChangeListener, updateModel

Methods inherited from class javax.faces.component.UIOutput

getConverter, getLocalValue, 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, getPassThroughAttributes, 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, getPassThroughAttributes, 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

Methods inherited from interface javax.faces.component.ValueHolder

getConverter, getLocalValue, setConverter

Methods inherited from interface org.primefaces.component.api.Widget

resolveWidgetVar, resolveWidgetVar

Field Details

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

Constructor Details

PickList

public PickList()

Method Details

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

getDefaultEventName

public String getDefaultEventName()

Specified by:

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

Overrides:

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

saveState

public Object saveState(javax.faces.context.FacesContext context)

Specified by:

saveState in interface javax.faces.component.StateHolder

Overrides:

saveState in class javax.faces.component.UIInput