org.gwtbootstrap3.extras.select.client.ui

Class MultipleSelect

Object

UIObject

Widget

Panel

ComplexPanel

ComplexWidget

SelectBase<List<String>>

MultipleSelect

All Implemented Interfaces:

IsEditor<LeafValueEditor<List<String>>>, HasAttachHandlers, HasValueChangeHandlers<List<String>>, HasHandlers, EventListener, TakesValue<List<String>>, Focusable, HasEnabled, HasValue<List<String>>, HasVisibility, HasWidgets, HasWidgets.ForIsWidget, IndexedPanel, IndexedPanel.ForIsWidget, IsWidget, Iterable<Widget>, HasId, HasInlineStyle, HasPull, HasResponsiveness, HasSize<ButtonSize>, HasType<ButtonType>, HasAllSelectHandlers<List<String>>, HasHiddenHandlers, HasHideHandlers, HasLoadedHandlers, HasRefreshedHandlers, HasRenderedHandlers, HasShowHandlers, HasShownHandlers

public class MultipleSelect
extends SelectBase<List<String>>

Multiple select box.

Author:

Xiaodong Sun

Nested Class Summary

Nested classes/interfaces inherited from class UIObject

UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled

Nested classes/interfaces inherited from interface IndexedPanel

IndexedPanel.ForIsWidget

Nested classes/interfaces inherited from interface HasWidgets

HasWidgets.ForIsWidget

Field Summary

Fields inherited from class SelectBase

attrMixin, itemMap, options, selectElement

Fields inherited from class UIObject

DEBUG_ID_PREFIX

Fields inherited from interface HasAllSelectHandlers

CHANGED_EVENT, HIDDEN_EVENT, HIDE_EVENT, LOADED_EVENT, REFRESHED_EVENT, RENDERED_EVENT, SHOW_EVENT, SHOWN_EVENT

Constructor Summary

Constructors

Constructor and Description
MultipleSelect()

Method Summary

Modifier and Type	Method and Description
void	deselectAll() Deselect all items in a multi-select.
List<Option>	getSelectedItems() Returns the selected items list.
List<String>	getValue()
boolean	isMultiple() Returns true if multiple selection is allowed.
void	selectAll() Select all items in a multi-select.
void	setCountSelectedTextFormat(int minCount) Specifies the minimum count of the count > # selection format with a multiple select.
void	setDeselectAllText(String deselectAllText) The text on the button that deselects all options when actionsBox is enabled. Defaults to Deselect All.
void	setMaxOptions(int maxOptions) When set to a positive value and in a multi-select, the number of selected options cannot exceed the given value.
void	setMaxOptionsTextHandler(MaxOptionsTextHandler handler) Sets the handler to get texts displayed when SelectOptions.MAX_OPTIONS is enabled and the maximum number of options within the entire select or an option group have been selected.
void	setMultipleSeparator(String multipleSeparator) Sets the character displayed in the button that separates selected options. Defaults to , .
void	setNoneSelectedText(String noneSelectedText) Sets the text that is displayed when a multiple select has no selected options. Defaults to Nothing Selected.
void	setSelectAllText(String selectAllText) The text on the button that selects all options when actionsBox is enabled. Defaults to Select All.
void	setSelectedTextFormat(SelectedTextFormat format) Specifies how the selection is displayed with a multiple select. Defaults to SelectedTextFormat.VALUES.
protected void	setSelectedValue(List<String> value) Selects the given value.
void	setShowActionsBox(boolean showActionsBox) When set to true, adds two buttons to the top of the drop-down menu (Select All & Deselect All). Defaults to false.

Methods inherited from class SelectBase

add, addHiddenHandler, addHideHandler, addLoadedHandler, addRefreshedHandler, addRenderedHandler, addShowHandler, addShownHandler, addValueChangeHandler, asEditor, command, getItem, getItemCount, getItems, getLanguage, getSize, getStyle, getTabIndex, getType, hide, insert, isEnabled, isItemSelected, isVisible, mobile, onLoad, onUnload, refresh, remove, render, setAccessKey, setContainer, setCountSelectedTextHandler, setDropdownAlignRight, setDropupAuto, setEnabled, setFixedMenuSize, setFocus, setForceDropup, setHeader, setHideDisabled, setLanguage, setLiveSearch, setLiveSearchNormalize, setLiveSearchPlaceholder, setLiveSearchStyle, setMenuSize, setMobile, setPlaceholder, setSelectOnTab, setSelectWidth, setShowContent, setShowIcon, setShowMenuArrow, setShowSubtext, setSize, setStyle, setTabIndex, setType, setValue, setValue, setVisible, setWidth, setWindowPadding, setWindowPaddingTopRightBottomLeft, show, toggle

Methods inherited from class ComplexWidget

getId, getPull, insert, setColor, setHiddenOn, setId, setMarginBottom, setMarginLeft, setMarginRight, setMarginTop, setPaddingBottom, setPaddingLeft, setPaddingRight, setPaddingTop, setPull, setVisibleOn

Methods inherited from class ComplexPanel

add, add, adjustIndex, checkIndexBoundsForAccess, checkIndexBoundsForInsertion, getChildren, getWidget, getWidgetCount, getWidgetIndex, getWidgetIndex, insert, iterator, remove

Methods inherited from class Panel

add, adopt, clear, doAttachChildren, doDetachChildren, orphan, remove

Methods inherited from class Widget

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onBrowserEvent, onDetach, removeFromParent, setLayoutData, sinkEvents, unsinkEvents

Methods inherited from class UIObject

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, sinkBitlessEvent, toString

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface HasHandlers

fireEvent

Methods inherited from interface Iterable

forEach, spliterator

Constructor Detail

MultipleSelect

public MultipleSelect()

Method Detail

isMultiple

public final boolean isMultiple()

Description copied from class: SelectBase

Returns true if multiple selection is allowed.

Specified by:

isMultiple in class SelectBase<List<String>>

Returns:

true if multiple selection is allowed

setShowActionsBox

public void setShowActionsBox(boolean showActionsBox)

When set to true, adds two buttons to the top of the drop-down menu (Select All & Deselect All).

Defaults to false.

Parameters:

showActionsBox -

setDeselectAllText

public void setDeselectAllText(String deselectAllText)

The text on the button that deselects all options when actionsBox is enabled.

Defaults to Deselect All.

Parameters:

deselectAllText -

setSelectAllText

public void setSelectAllText(String selectAllText)

The text on the button that selects all options when actionsBox is enabled.

Defaults to Select All.

Parameters:

selectAllText -

setMaxOptions

public void setMaxOptions(int maxOptions)

When set to a positive value and in a multi-select, the number of selected options cannot exceed the given value. When set to a strict negative value (less than zero), this options will be deactivated.

Parameters:

maxOptions -

setMaxOptionsTextHandler

public void setMaxOptionsTextHandler(MaxOptionsTextHandler handler)

Sets the handler to get texts displayed when SelectOptions.MAX_OPTIONS is enabled and the maximum number of options within the entire select or an option group have been selected.

Parameters:

handler -

See Also:

setMaxOptions(int)

setMultipleSeparator

public void setMultipleSeparator(String multipleSeparator)

Sets the character displayed in the button that separates selected options.

Defaults to , .

Parameters:

multipleSeparator -

setNoneSelectedText

public void setNoneSelectedText(String noneSelectedText)

Sets the text that is displayed when a multiple select has no selected options.

Defaults to Nothing Selected.

Parameters:

noneSelectedText -

setSelectedTextFormat

public void setSelectedTextFormat(SelectedTextFormat format)

Specifies how the selection is displayed with a multiple select.

Defaults to SelectedTextFormat.VALUES.

Parameters:

format -

See Also:

SelectedTextFormat

setCountSelectedTextFormat

public void setCountSelectedTextFormat(int minCount)

Specifies the minimum count of the count > # selection format with a multiple select.

Parameters:

minCount -

See Also:

SelectedTextFormat.getFormat(int)

getValue

public List<String> getValue()

setSelectedValue

protected void setSelectedValue(List<String> value)

Description copied from class: SelectBase

Selects the given value. If the value is null or does not match any option, no option will be selected.

Specified by:

setSelectedValue in class SelectBase<List<String>>

getSelectedItems

public List<Option> getSelectedItems()

Returns the selected items list. If no item is selected, this method returns an empty list.

Returns:

the selected items list

selectAll

public void selectAll()

Select all items in a multi-select.

deselectAll

public void deselectAll()

Deselect all items in a multi-select.