Package org.primefaces.component.selectcheckboxmenu

Class SelectCheckboxMenu

java.lang.Object

javax.faces.component.UIComponent

javax.faces.component.UIComponentBase

javax.faces.component.UIOutput

javax.faces.component.UIInput

javax.faces.component.UISelectMany

javax.faces.component.html.HtmlSelectManyCheckbox

org.primefaces.component.selectcheckboxmenu.SelectCheckboxMenuBase

org.primefaces.component.selectcheckboxmenu.SelectCheckboxMenu

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

public class SelectCheckboxMenu
extends SelectCheckboxMenuBase

Nested Class Summary

Nested classes/interfaces inherited from class org.primefaces.component.selectcheckboxmenu.SelectCheckboxMenuBase

SelectCheckboxMenuBase.PropertyKeys

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ARIA_TOGGLER_CHECKBOX_ALL
static final String	CLOSER_CLASS
static final String	COMPONENT_TYPE
static final String	FILTER_CLASS
static final String	FILTER_CONTAINER_CLASS
static final String	FOOTER_CLASS
static final String	HEADER_CLASS
static final String	ITEM_CLASS
static final String	ITEMS_WRAPPER_CLASS
static final String	LABEL_CLASS
static final String	LABEL_CONTAINER_CLASS
static final String	LIST_CLASS
static final String	MULTIPLE_CLASS
static final String	MULTIPLE_CONTAINER_CLASS
static final String	PANEL_CLASS
static final String	ROW_ITEM_CLASS
static final String	ROW_ITEM_GROUP_CLASS
static final String	STYLE_CLASS
static final String	TABLE_CLASS
static final String	TOKEN_DISPLAY_CLASS
static final String	TOKEN_ICON_CLASS
static final String	TOKEN_LABEL_CLASS
static final String	TRIGGER_CLASS

Fields inherited from class org.primefaces.component.selectcheckboxmenu.SelectCheckboxMenuBase

COMPONENT_FAMILY, DEFAULT_RENDERER

Fields inherited from class javax.faces.component.UISelectMany

INVALID_MESSAGE_ID

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.Widget

ATTR_WIDGET_VAR_PATTERN, CALLBACK_POST_CONSTRUCT, CALLBACK_POST_REFRESH, CALLBACK_PRE_DESTROY

Constructor Summary

Constructors

Constructor	Description
SelectCheckboxMenu()

Method Summary

Modifier and Type	Method	Description
Map<String,Class<? extends javax.faces.event.BehaviorEvent>>	getBehaviorEventMapping()
List<Column>	getColumns()
String	getDefaultEventName()
Collection<String>	getEventNames()
String	getInputClientId()
String	getLabelledBy()
String	getValidatableInputClientId()
void	queueEvent(javax.faces.event.FacesEvent event)
void	setLabelledBy(String labelledBy)	Sets the id of the label for aria.

Methods inherited from class org.primefaces.component.selectcheckboxmenu.SelectCheckboxMenuBase

getAppendTo, getEmptyLabel, getFamily, getFilterFunction, getFilterMatchMode, getFilterPlaceholder, getLabelSeparator, getOnHide, getOnShow, getPanelStyle, getPanelStyleClass, getScrollHeight, getTabindex, getTitle, getVar, getWidgetVar, isCaseSensitive, isDynamic, isFilter, isFilterNormalize, isMultiple, isShowHeader, isUpdateLabel, setAppendTo, setCaseSensitive, setDynamic, setEmptyLabel, setFilter, setFilterFunction, setFilterMatchMode, setFilterNormalize, setFilterPlaceholder, setLabelSeparator, setMultiple, setOnHide, setOnShow, setPanelStyle, setPanelStyleClass, setScrollHeight, setShowHeader, setTabindex, setTitle, setUpdateLabel, setVar, setWidgetVar

Methods inherited from class javax.faces.component.html.HtmlSelectManyCheckbox

getAccesskey, getBorder, getDir, getDisabledClass, getEnabledClass, getLabel, getLang, getLayout, getOnblur, getOnchange, getOnclick, getOndblclick, getOnfocus, getOnkeydown, getOnkeypress, getOnkeyup, getOnmousedown, getOnmousemove, getOnmouseout, getOnmouseover, getOnmouseup, getOnselect, getRole, getSelectedClass, getStyle, getStyleClass, getUnselectedClass, isDisabled, isReadonly, setAccesskey, setBorder, setDir, setDisabled, setDisabledClass, setEnabledClass, setLabel, setLang, setLayout, setOnblur, setOnchange, setOnclick, setOndblclick, setOnfocus, setOnkeydown, setOnkeypress, setOnkeyup, setOnmousedown, setOnmousemove, setOnmouseout, setOnmouseover, setOnmouseup, setOnselect, setReadonly, setRole, setSelectedClass, setStyle, setStyleClass, setUnselectedClass

Methods inherited from class javax.faces.component.UISelectMany

compareValues, getSelectedValues, getSubmittedValue, getValueBinding, getValueExpression, setSelectedValues, setSubmittedValue, setValueBinding, setValueExpression, validateValue

Methods inherited from class javax.faces.component.UIInput

addValidator, addValueChangeListener, clearInitialState, decode, getConvertedValue, getConverterMessage, getRequiredMessage, 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, setValid, setValidator, setValidatorMessage, setValue, setValueChangeListener, updateModel, validate

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, invokeOnComponent, isRendered, isTransient, processRestoreState, processSaveState, removeFacesListener, restoreAttachedState, saveAttachedState, setId, setParent, setRendered, setRendererType, setTransient, subscribeToEvent, unsubscribeFromEvent

Methods inherited from class javax.faces.component.UIComponent

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

STYLE_CLASS

public static final String STYLE_CLASS

See Also:

• Constant Field Values

LABEL_CONTAINER_CLASS

public static final String LABEL_CONTAINER_CLASS

See Also:

• Constant Field Values

LABEL_CLASS

public static final String LABEL_CLASS

See Also:

• Constant Field Values

TRIGGER_CLASS

public static final String TRIGGER_CLASS

See Also:

• Constant Field Values

PANEL_CLASS

public static final String PANEL_CLASS

See Also:

• Constant Field Values

HEADER_CLASS

public static final String HEADER_CLASS

See Also:

• Constant Field Values

FOOTER_CLASS

public static final String FOOTER_CLASS

See Also:

• Constant Field Values

FILTER_CONTAINER_CLASS

public static final String FILTER_CONTAINER_CLASS

See Also:

• Constant Field Values

FILTER_CLASS

public static final String FILTER_CLASS

See Also:

• Constant Field Values

CLOSER_CLASS

public static final String CLOSER_CLASS

See Also:

• Constant Field Values

ITEMS_WRAPPER_CLASS

public static final String ITEMS_WRAPPER_CLASS

See Also:

• Constant Field Values

LIST_CLASS

public static final String LIST_CLASS

See Also:

• Constant Field Values

TABLE_CLASS

public static final String TABLE_CLASS

See Also:

• Constant Field Values

ITEM_CLASS

public static final String ITEM_CLASS

See Also:

• Constant Field Values

ROW_ITEM_GROUP_CLASS

public static final String ROW_ITEM_GROUP_CLASS

See Also:

• Constant Field Values

ROW_ITEM_CLASS

public static final String ROW_ITEM_CLASS

See Also:

• Constant Field Values

MULTIPLE_CLASS

public static final String MULTIPLE_CLASS

See Also:

• Constant Field Values

MULTIPLE_CONTAINER_CLASS

public static final String MULTIPLE_CONTAINER_CLASS

See Also:

• Constant Field Values

TOKEN_DISPLAY_CLASS

public static final String TOKEN_DISPLAY_CLASS

See Also:

• Constant Field Values

TOKEN_LABEL_CLASS

public static final String TOKEN_LABEL_CLASS

See Also:

• Constant Field Values

TOKEN_ICON_CLASS

public static final String TOKEN_ICON_CLASS

See Also:

• Constant Field Values

ARIA_TOGGLER_CHECKBOX_ALL

public static final String ARIA_TOGGLER_CHECKBOX_ALL

See Also:

• Constant Field Values

Constructor Details

SelectCheckboxMenu

public SelectCheckboxMenu()

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.html.HtmlSelectManyCheckbox

getDefaultEventName

public String getDefaultEventName()

Specified by:

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

Overrides:

getDefaultEventName in class javax.faces.component.html.HtmlSelectManyCheckbox

getInputClientId

public String getInputClientId()

Returns:

Client id of the input element

getValidatableInputClientId

public String getValidatableInputClientId()

Returns:

Client id of the validatable input element

getLabelledBy

public String getLabelledBy()

Returns:

Client id of the label for aria

setLabelledBy

public void setLabelledBy(String labelledBy)

Description copied from interface: InputHolder

Sets the id of the label for aria.

Parameters:

labelledBy - the id

getColumns

public List<Column> getColumns()

queueEvent

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

Overrides:

queueEvent in class javax.faces.component.UIComponentBase