org.dominokit.domino.ui.forms

Class AbstractSelect<T,V,S extends AbstractSelect<T,V,S>>

java.lang.Object

org.dominokit.domino.ui.utils.BaseDominoElement<elemental2.dom.HTMLElement,T>

org.dominokit.domino.ui.forms.BasicFormElement<T,V>

org.dominokit.domino.ui.forms.ValueBox<T,E,V>

org.dominokit.domino.ui.forms.AbstractValueBox<S,elemental2.dom.HTMLElement,T>

org.dominokit.domino.ui.forms.AbstractSelect<T,V,S>

Type Parameters:

T - The type of the field value

V - The type of the single option value

S - The type of the field extending from this class

All Implemented Interfaces:

FormElement<S,T>, HasGrouping<S>, HasInputElement, DominoStyle<elemental2.dom.HTMLElement,S,S>, Focusable<S>, HasAutoValidation<S>, HasChangeHandlers<S,T>, HasChildren<S>, HasHelperText<S>, HasLabel<S>, HasLength<S>, HasName<S>, HasPlaceHolder<S>, HasValidation<S>, HasValue<S,T>, HasWavesElement, IsCollapsible<S>, IsReadOnly<S>, IsRequired<S>, Switchable<S>, org.gwtproject.editor.client.Editor<T>, org.gwtproject.editor.client.HasEditorErrors<T>, org.gwtproject.editor.client.LeafValueEditor<T>, org.gwtproject.editor.client.TakesValue<T>, org.jboss.elemento.IsElement<elemental2.dom.HTMLElement>

Direct Known Subclasses:

MultiSelect, Select

public abstract class AbstractSelect<T,V,S extends AbstractSelect<T,V,S>>
extends AbstractValueBox<S,elemental2.dom.HTMLElement,T>

The base implementation for dropdown select form fields components

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AbstractSelect.CloseMenuHandler<V> A function for implementing logic that will be executed whenever the select dropdown is closed
static class	AbstractSelect.DropDownPositionDown A DropDownPosition that opens the select dropdown menu always down
static class	AbstractSelect.DropDownPositionUp A DropDownPosition that opens the select dropdown menu always up
static interface	AbstractSelect.OnAddOptionHandler<V> A function for implementing logic to be executed when a new option is added on the fly using the setCreatable(boolean) feature
static interface	AbstractSelect.OptionRenderer<T> An interface for rendering the SelectOption
static class	AbstractSelect.PopupPositionTopDown<T,V,S extends AbstractSelect<T,V,S>> A DropDownPosition that opens the select dropdown menu up or down based on the largest space available, the menu will show where the is more space
static interface	AbstractSelect.SelectionHandler<V> A function to implement logic that will be called when the user change the selection in the select

Nested classes/interfaces inherited from class org.dominokit.domino.ui.forms.ValueBox

ValueBox.AutoValidate, ValueBox.AutoValidator

Nested classes/interfaces inherited from class org.dominokit.domino.ui.forms.BasicFormElement

BasicFormElement.FieldHandler<T>

Nested classes/interfaces inherited from class org.dominokit.domino.ui.utils.BaseDominoElement

BaseDominoElement.ElementHandler<T>, BaseDominoElement.ResizeHandler<T>, BaseDominoElement.StyleEditor<E extends elemental2.dom.HTMLElement,T extends org.jboss.elemento.IsElement<E>>, BaseDominoElement.WavesStyler

Nested classes/interfaces inherited from interface org.dominokit.domino.ui.utils.HasChangeHandlers

HasChangeHandlers.ChangeHandler<V>

Nested classes/interfaces inherited from interface org.dominokit.domino.ui.utils.HasValidation

HasValidation.Validator

Nested classes/interfaces inherited from interface org.gwtproject.editor.client.Editor

org.gwtproject.editor.client.Editor.Ignore, org.gwtproject.editor.client.Editor.Path

Field Summary

Fields

Modifier and Type	Field and Description
protected DominoElement<elemental2.dom.HTMLElement>	buttonValueContainer
protected SelectOption<V>	noneOption
protected LinkedList<SelectOption<V>>	options
protected DominoElement<elemental2.dom.HTMLElement>	valuesContainer

Fields inherited from class org.dominokit.domino.ui.forms.ValueBox

changeHandlers, changeListener, DISABLED, fieldContainer, fieldGroup, FLOATING, FOCUSED, inputContainer, inputListener

Fields inherited from class org.dominokit.domino.ui.utils.BaseDominoElement

element

Constructor Summary

Constructors

Constructor and Description
AbstractSelect() Creates an empty select
AbstractSelect(List<SelectOption<V>> options) Ceate a select with empty label and a list of initial options
AbstractSelect(String label) Create an empty select with a lable
AbstractSelect(String label, List<SelectOption<V>> options) Create a select field with a label and an initial options list

Method Summary

Modifier and Type	Method and Description
S	addGroup(SelectOptionGroup<V> group) Adds a select options group to the dropdown menu
S	addOptions(List<SelectOption<V>> options) Adds a List of options to the select dropdown menu
S	addSelectionHandler(AbstractSelect.SelectionHandler<V> selectionHandler)
S	appendChild(SelectOption<V> option) Adds an option to the select dropdown menu
S	appendChild(SelectOption<V> option, Consumer<DropdownAction<SelectOption<V>>> andThen)
S	clear(boolean silent) Clears the field value and only triggers the change handlers if silent flag is true
S	close() Closes the select dropdown menu
static void	closeAllSelects() closes all currently opened selects dropdown menus
S	closeMenu(AbstractSelect.CloseMenuHandler closeMenuHandler) Closes the dropdown menu and call the handler
boolean	containsKey(String key) Check if the select has an option with the specified key
boolean	containsValue(V value) Check if the select has an option with the specified value
protected ValueBox.AutoValidator	createAutoValidator(ValueBox.AutoValidate autoValidate) Create an AutoValidator that will automatically validate the component when it loses focus
protected elemental2.dom.HTMLElement	createInputElement(String type) Creates an input element with the specified type
protected DominoElement<elemental2.dom.HTMLDivElement>	createMandatoryAddOn() for thes select this creates the dropdown menu arrow
S	disable()
S	divider() Adds a separator item between the select option in the dropdown menu
protected void	doSetValue(T value)
S	dropdown() force open the select dropdown menu to open down by default
S	dropup() force open the select dropdown menu to open up by default
S	enable()
DominoElement<elemental2.dom.HTMLElement>	getButtonValueContainer()
String	getClearableText()
String	getDropDirection()
List<String>	getKeys()
SelectOption<V>	getOptionAt(int index)
List<SelectOption<V>>	getOptions()
DropDownMenu	getOptionsMenu()
DominoElement<elemental2.dom.HTMLButtonElement>	getSelectButton() the select box is actually rendered with a button
DominoElement<elemental2.dom.HTMLLabelElement>	getSelectLabel() Deprecated. use ValueBox.getLabelElement()
List<V>	getValues()
protected void	hidePlaceholder()
S	insertFirst(SelectOption<V> option) Insert an option as the first option in the dropdown menu
boolean	isAutoCloseOnSelect()
boolean	isClearable()
boolean	isClosePopOverOnOpen()
boolean	isCreatable()
boolean	isEnabled()
boolean	isSearchable()
abstract boolean	isSelected()
protected void	onSelection(SelectOption<V> option) By default this will call the Selection Handlers and the Change handlers
S	open() Opens the select dropdown menu
S	removeAllOptions() Removes all options from the select dropdown menu
S	removeOption(SelectOption<V> option) Removes an option from the select dropdown menu
S	removeOptions(Collection<SelectOption<V>> options) Removes a list of options from the select dropdown menu
S	removeSelectionHandler(AbstractSelect.SelectionHandler selectionHandler)
protected abstract void	scrollToSelectedOption() implementation of this method will determine how the select will scroll to the selected option when opens the dropdown menu
S	select(SelectOption<V> option) Selects the specified option if it is one of this select options
abstract S	select(SelectOption<V> option, boolean silent) Selects the option at the specified index if exists and set its value as the select value
S	selectAt(int index) Selects the option at the specified index if exists and set its value as the select value
S	selectAt(int index, boolean silent) Selects the option at the specified index if exists and set its value as the select value
S	selectByKey(String key) Selects an option by its key if exists
S	selectByKey(String key, boolean silent) Selects an option by its key if exists with ability to avoid triggering change handlers
void	setArrowIconSupplier(Supplier<BaseIcon<?>> arrowIconSupplier) Sets a supplier for an icon to use as the dropdown arrow
S	setAutoCloseOnSelect(boolean autoCloseOnSelect)
S	setClearable(boolean clearable) Enable/Disable the none option in the field
S	setClearableText(String clearableText) sets the text display for the none option from the setClearable(boolean)
S	setClosePopOverOnOpen(boolean closePopOverOnOpen) Enable/Disable closing other popups in the screen when opens the select dropdown menu
S	setCreatable(boolean creatable) Enable/Disable on the fly option creation
S	setDropPosition(DropDownPosition dropPosition) Sets a custom dropdown position for this select
S	setOnAddOptionHandler(AbstractSelect.OnAddOptionHandler<V> onAddOptionHandler) Adds a handler that will be called whenever we add a new option to the select using the setCreatable(boolean) feature
S	setOptionRenderer(AbstractSelect.OptionRenderer<V> optionRenderer) Sets the option renderer
S	setPopupWidth(int width) Sets the dropdown menu width
S	setReadOnly(boolean readOnly) set the readonly attribute value
S	setSearchable(boolean searchable) Disable/Enable search for the select.
S	setSearchFilter(DropDownMenu.SearchFilter searchFilter) Sets a custom search filter to be used when setSearchable(boolean) is enabled
abstract S	setValue(T value, boolean silent) Set the value with the ability to do so without triggering change handlers
protected void	showPlaceholder()
S	value(T value) set the filed value

Methods inherited from class org.dominokit.domino.ui.forms.AbstractValueBox

getMaxLength, getMinLength, getMinLengthErrorMessage, isEmpty, isEmptyIgnoreSpaces, setMaxLength, setMinLength, setMinLengthErrorMessage, updateCharacterCount

Methods inherited from class org.dominokit.domino.ui.forms.ValueBox

addChangeHandler, addLeftAddOn, addLeftAddOn, addLeftAddOn, addOnClearHandler, addRightAddOn, addRightAddOn, addRightAddOn, allowEmptyLabel, asTableField, autoValidate, callChangeHandlers, changeLabelFloating, clear, clearInvalid, clearValue, clearValue, condense, createLabelElement, doFocus, doUnfocus, element, floating, floatLabel, focus, getAdditionalInfoContainer, getCountItem, getErrorItem, getErrorsContainer, getFieldContainer, getFieldGroup, getFieldInputContainer, getFieldStyle, getFocusColor, getHelperContainer, getHelpItem, getInputContainer, getInputElement, getLabelElement, getLabelTextElement, getLeftAddonContainer, getLeftAddOnsContainer, getMandatoryAddOn, getNotesContainer, getOnClearHandlers, getPlaceholder, getPostfix, getPostFixItem, getPrefix, getPrefixItem, getRightAddonContainer, getRightAddOnsContainer, getStringValue, getValue, hasChangeHandler, hideLabelText, invalidate, invalidate, isAddFocusColor, isAutoValidation, isFloating, isFocused, isReadOnly, linkLabelToField, nonfloating, onEnterKey, pauseChangeHandlers, pauseFocusValidation, removeChangeHandler, removeLeftAddOn, removeLeftAddOn, removeLeftAddOn, removeLeftAddOn, removeLeftAddOns, removeOnClearHandler, removeRightAddOn, removeRightAddOn, removeRightAddOn, removeRightAddOn, removeRightAddOns, resumeChangeHandlers, resumeFocusValidation, setAutoValidation, setFieldStyle, setFixErrorsPosition, setFloating, setFocusColor, setLabel, setLabel, setLabel, setLabel, setLabelTextVisible, setPauseChangeHandlers, setPlaceholder, setPostFix, setPrefix, setSpellCheck, setTableField, shouldShowPlaceholder, showLabelText, spread, unfloatLabel, unfocus, updateLabel, value

Methods inherited from class org.dominokit.domino.ui.forms.BasicFormElement

addValidator, getErrorLabels, getErrors, getHelperText, getLabel, getName, getRequiredErrorMessage, groupBy, hasValidator, isDisabled, isFixErrorsPosition, isRequired, isShowRequiredIndicator, isValidationDisabled, makeErrorLabel, removeValidator, setHelperText, setName, setRequired, setRequired, setRequiredErrorMessage, setShowRequiredIndicator, setValidationDisabled, setValue, showErrors, ungroup, validate, withValidationDisabled

Methods inherited from class org.dominokit.domino.ui.utils.BaseDominoElement

add, add, addClickListener, addCss, addCss, addEventListener, addEventListener, addEventsListener, addHideListener, addShowListener, alignCenter, alignRight, appendChild, appendChild, apply, attr, blur, childNodes, clearElement, contains, contains, contains, containsCss, css, css, cssClassByIndex, cssClassesCount, cssText, elevate, elevate, firstChild, getAttachObserver, getAttribute, getBoundingClientRect, getChildElementCount, getClickableElement, getCollapsible, getCollapsibleElement, getDetachObserver, getDominoId, getElementsCount, getElevation, getFirstChild, getId, getTextContent, getTooltip, getWavesElement, hasAttribute, hasChildNodes, hasDirectChild, hide, hideOn, id, init, insertAfter, insertAfter, insertAfter, insertAfter, insertBefore, insertBefore, insertBefore, insertBefore, insertFirst, insertFirst, insertFirst, isAttached, isCollapsed, isEmptyElement, isEqualNode, isForceHidden, isHidden, item, lastChild, length, onAttached, onDetached, onResize, pullLeft, pullRight, querySelector, querySelectorAll, remove, removeAttachObserver, removeAttribute, removeChild, removeChild, removeCss, removeCss, removeCssProperty, removeDetachObserver, removeEventListener, removeEventListener, removeHideListener, removeHideOn, removeShowListener, removeShowOn, removeTooltip, removeWaves, replaceCss, setAlignItems, setAttribute, setAttribute, setAttribute, setBackgroundColor, setBackgroundColor, setBorder, setBorderColor, setBottom, setBottom, setBoxShadow, setCollapseStrategy, setColor, setColor, setContent, setContent, setCssProperty, setCssProperty, setCursor, setCursor, setDisabled, setDisplay, setDisplay, setDropMenu, setFlex, setFloat, setFloat, setFontSize, setFontSize, setForceHidden, setHeight, setHeight, setId, setInnerHtml, setLeft, setLeft, setLineHeight, setLineHeight, setMargin, setMargin, setMarginBottom, setMarginBottom, setMarginLeft, setMarginLeft, setMarginRight, setMarginRight, setMarginTop, setMarginTop, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setOpacity, setOpacity, setOverFlow, setOverFlow, setOverFlowY, setPadding, setPadding, setPaddingBottom, setPaddingBottom, setPaddingLeft, setPaddingLeft, setPaddingRight, setPaddingRight, setPaddingTop, setPaddingTop, setPointerEvents, setPosition, setPosition, setRight, setRight, setTabIndex, setTextAlign, setTextAlign, setTextContent, setTooltip, setTooltip, setTooltip, setTooltip, setTop, setTop, setTransitionDuration, setWidth, setWidth, setZIndex, show, showOn, style, style, styler, textContent, toggleDisplay, toggleDisplay, withWaves, withWaves

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.dominokit.domino.ui.utils.HasValidation

validateAll

Methods inherited from interface org.dominokit.domino.ui.utils.IsCollapsible

isExpanded

Methods inherited from interface org.dominokit.domino.ui.style.DominoStyle

add, add, remove, remove, removeProperty, replace, setProperty, setProperty

Field Detail

noneOption

protected SelectOption<V> noneOption

buttonValueContainer

protected DominoElement<elemental2.dom.HTMLElement> buttonValueContainer

valuesContainer

protected final DominoElement<elemental2.dom.HTMLElement> valuesContainer

options

protected LinkedList<SelectOption<V>> options

Constructor Detail

AbstractSelect

public AbstractSelect()

Creates an empty select

AbstractSelect

public AbstractSelect(String label)

Create an empty select with a lable

Parameters:

label - String

AbstractSelect

public AbstractSelect(String label,
                      List<SelectOption<V>> options)

Create a select field with a label and an initial options list

Parameters:

label - String

options - List of SelectOption

AbstractSelect

public AbstractSelect(List<SelectOption<V>> options)

Ceate a select with empty label and a list of initial options

Parameters:

options - List of SelectOption

Method Detail

setArrowIconSupplier

public void setArrowIconSupplier(Supplier<BaseIcon<?>> arrowIconSupplier)

Sets a supplier for an icon to use as the dropdown arrow

Parameters:

arrowIconSupplier - Supplier for BaseIcon

clear

public S clear(boolean silent)

Description copied from class: ValueBox

Clears the field value and only triggers the change handlers if silent flag is true

Specified by:

clear in interface HasGrouping<S extends AbstractSelect<T,V,S>>

Overrides:

clear in class ValueBox<S extends AbstractSelect<T,V,S>,elemental2.dom.HTMLElement,T>

Parameters:

silent - boolean, if false clear the value without triggering the change handlers

Returns:

same implementing component instance

open

public S open()

Opens the select dropdown menu

Returns:

same component instance

close

public S close()

Closes the select dropdown menu

divider

public S divider()

Adds a separator item between the select option in the dropdown menu

Returns:

same select instance

addGroup

public S addGroup(SelectOptionGroup<V> group)

Adds a select options group to the dropdown menu

Parameters:

group - SelectOptionGroup

Returns:

same select instance

addOptions

public S addOptions(List<SelectOption<V>> options)

Adds a List of options to the select dropdown menu

Parameters:

options - List of SelectOption

Returns:

same select instance

setPopupWidth

public S setPopupWidth(int width)

Sets the dropdown menu width

Parameters:

width - int

Returns:

same select instance

appendChild

public S appendChild(SelectOption<V> option)

Adds an option to the select dropdown menu

Parameters:

option - SelectOption

Returns:

same select instance

appendChild

public S appendChild(SelectOption<V> option,
                     Consumer<DropdownAction<SelectOption<V>>> andThen)

insertFirst

public S insertFirst(SelectOption<V> option)

Insert an option as the first option in the dropdown menu

Parameters:

option - SelectOption

Returns:

same select instance

selectAt

public S selectAt(int index)

Selects the option at the specified index if exists and set its value as the select value

Parameters:

index - int

Returns:

same select instance

selectAt

public S selectAt(int index,
                  boolean silent)

Selects the option at the specified index if exists and set its value as the select value

Parameters:

index - int

silent - boolean, true to avoid triggering change handlers

Returns:

same select instance

getOptionAt

public SelectOption<V> getOptionAt(int index)

Parameters:

index - int

Returns:

the SelectOption at the specified index if exists or else null

getOptions

public List<SelectOption<V>> getOptions()

Returns:

a List of all SelectOptions of this select component

select

public S select(SelectOption<V> option)

Selects the specified option if it is one of this select options

Parameters:

option - SelectOption

Returns:

same select instance

select

public abstract S select(SelectOption<V> option,
                         boolean silent)

Selects the option at the specified index if exists and set its value as the select value

Parameters:

option - SelectOption

silent - boolean, true to avoid triggering change handlers

Returns:

same select instance

isSelected

public abstract boolean isSelected()

Returns:

boolean, true if the select has a selected option

onSelection

protected void onSelection(SelectOption<V> option)

By default this will call the Selection Handlers and the Change handlers

Parameters:

option - the new selected SelectOption

addSelectionHandler

public S addSelectionHandler(AbstractSelect.SelectionHandler<V> selectionHandler)

Parameters:

selectionHandler - AbstractSelect.SelectionHandler

Returns:

same select instance

enable

public S enable()

Specified by:

enable in interface Switchable<S extends AbstractSelect<T,V,S>>

Overrides:

enable in class ValueBox<S extends AbstractSelect<T,V,S>,elemental2.dom.HTMLElement,T>

Returns:

same implementing component

disable

public S disable()

Specified by:

disable in interface Switchable<S extends AbstractSelect<T,V,S>>

Overrides:

disable in class ValueBox<S extends AbstractSelect<T,V,S>,elemental2.dom.HTMLElement,T>

Returns:

same implementing component

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface Switchable<S extends AbstractSelect<T,V,S>>

Overrides:

isEnabled in class BasicFormElement<S extends AbstractSelect<T,V,S>,T>

Returns:

boolean, true if component is enabled else false

dropup

public S dropup()

force open the select dropdown menu to open up by default

Returns:

same select instance

dropdown

public S dropdown()

force open the select dropdown menu to open down by default

Returns:

same select instance

value

public S value(T value)

set the filed value

Specified by:

value in interface HasValue<S extends AbstractSelect<T,V,S>,T>

Overrides:

value in class AbstractValueBox<S extends AbstractSelect<T,V,S>,elemental2.dom.HTMLElement,T>

Parameters:

value - V

Returns:

same component instance

setValue

public abstract S setValue(T value,
                           boolean silent)

Set the value with the ability to do so without triggering change handlers

Parameters:

value - T

silent - boolean, true to avoid triggering change handlers

Returns:

same select instance

removeSelectionHandler

public S removeSelectionHandler(AbstractSelect.SelectionHandler selectionHandler)

Parameters:

selectionHandler - AbstractSelect.SelectionHandler

Returns:

same select instance

removeOption

public S removeOption(SelectOption<V> option)

Removes an option from the select dropdown menu

Parameters:

option - SelectOption

Returns:

same select instance

removeOptions

public S removeOptions(Collection<SelectOption<V>> options)

Removes a list of options from the select dropdown menu

Parameters:

options - collection of SelectOption

Returns:

same select instance

removeAllOptions

public S removeAllOptions()

Removes all options from the select dropdown menu

Returns:

same select instance

setReadOnly

public S setReadOnly(boolean readOnly)

set the readonly attribute value

Specified by:

setReadOnly in interface IsReadOnly<S extends AbstractSelect<T,V,S>>

Overrides:

setReadOnly in class AbstractValueBox<S extends AbstractSelect<T,V,S>,elemental2.dom.HTMLElement,T>

Parameters:

readOnly - boolean, if true switch the component to readonly mode, otherwise switch out off readonly mode

Returns:

same instance of the implementing class

setOptionRenderer

public S setOptionRenderer(AbstractSelect.OptionRenderer<V> optionRenderer)

Sets the option renderer

Parameters:

optionRenderer - the AbstractSelect.OptionRenderer

Returns:

same instance

getSelectButton

public DominoElement<elemental2.dom.HTMLButtonElement> getSelectButton()

the select box is actually rendered with a button

Returns:

the HTMLButtonElement that is actually displaying the selected option

getSelectLabel

@Deprecated
public DominoElement<elemental2.dom.HTMLLabelElement> getSelectLabel()

Deprecated. use ValueBox.getLabelElement()

Returns:

the HTMLLabelElement of the select wrapped as DominoElement

createAutoValidator

protected ValueBox.AutoValidator createAutoValidator(ValueBox.AutoValidate autoValidate)

Create an AutoValidator that will automatically validate the component when it loses focus

Specified by:

createAutoValidator in class ValueBox<S extends AbstractSelect<T,V,S>,elemental2.dom.HTMLElement,T>

Parameters:

autoValidate - AutoValidate

Returns:

the AutoValidator implementation for the select which is SelectAutoValidator

getValues

public List<V> getValues()

Returns:

a List of all V values from all the options of this select

getKeys

public List<String> getKeys()

Returns:

a List of all String keys of all the options of this select

containsKey

public boolean containsKey(String key)

Check if the select has an option with the specified key

Parameters:

key - String

Returns:

boolean, true of option with that key exists

containsValue

public boolean containsValue(V value)

Check if the select has an option with the specified value

Parameters:

value - V

Returns:

boolean, true of option with that value exists

setSearchable

public S setSearchable(boolean searchable)

Disable/Enable search for the select.

Parameters:

searchable - boolean, if true a text box will show up in the dropdown menu to search for options

Returns:

same select instance

setCreatable

public S setCreatable(boolean creatable)

Enable/Disable on the fly option creation

Parameters:

creatable - boolean, if true a button will show up to allow the user to create a new select option and add it to the dropdown list

Returns:

same select instance

setOnAddOptionHandler

public S setOnAddOptionHandler(AbstractSelect.OnAddOptionHandler<V> onAddOptionHandler)

Adds a handler that will be called whenever we add a new option to the select using the setCreatable(boolean) feature

Parameters:

onAddOptionHandler - AbstractSelect.OnAddOptionHandler

Returns:

same select instance

closeMenu

public S closeMenu(AbstractSelect.CloseMenuHandler closeMenuHandler)

Closes the dropdown menu and call the handler

Parameters:

closeMenuHandler - AbstractSelect.CloseMenuHandler

Returns:

same select instance

isSearchable

public boolean isSearchable()

Returns:

boolean, true if search is enabled on this select

isCreatable

public boolean isCreatable()

Returns:

boolean, true is creatable feature is enabled on this select

closeAllSelects

public static void closeAllSelects()

closes all currently opened selects dropdown menus

selectByKey

public S selectByKey(String key)

Selects an option by its key if exists

Parameters:

key - String

Returns:

same select instance

selectByKey

public S selectByKey(String key,
                     boolean silent)

Selects an option by its key if exists with ability to avoid triggering change handlers

Parameters:

key - String

silent - boolean, true to avoid triggering change handlers

Returns:

same select instance

setClearable

public S setClearable(boolean clearable)

Enable/Disable the none option in the field

Parameters:

clearable - boolean, if true a none option will added to the select as the first option, when selected it actually nulls the select value

Returns:

same select instance

isClearable

public boolean isClearable()

Returns:

boolean, true if this select value can be cleared

setClearableText

public S setClearableText(String clearableText)

sets the text display for the none option from the setClearable(boolean)

Parameters:

clearableText - String

Returns:

same select instance

getClearableText

public String getClearableText()

Returns:

String display value of the none option when setClearable(boolean) is enabled

getDropDirection

public String getDropDirection()

Returns:

String dropdown direction up or down

getButtonValueContainer

public DominoElement<elemental2.dom.HTMLElement> getButtonValueContainer()

Returns:

the HTMLElement that contains the button of this select

setDropPosition

public S setDropPosition(DropDownPosition dropPosition)

Sets a custom dropdown position for this select

Parameters:

dropPosition - DropDownPosition

Returns:

same select instance

createInputElement

protected elemental2.dom.HTMLElement createInputElement(String type)

Creates an input element with the specified type for the select this will create a button element

Specified by:

createInputElement in class ValueBox<S extends AbstractSelect<T,V,S>,elemental2.dom.HTMLElement,T>

Parameters:

type - String the input element type

Returns:

E the input html element

showPlaceholder

protected void showPlaceholder()

Overrides:

showPlaceholder in class ValueBox<S extends AbstractSelect<T,V,S>,elemental2.dom.HTMLElement,T>

hidePlaceholder

protected void hidePlaceholder()

Overrides:

hidePlaceholder in class ValueBox<S extends AbstractSelect<T,V,S>,elemental2.dom.HTMLElement,T>

createMandatoryAddOn

protected DominoElement<elemental2.dom.HTMLDivElement> createMandatoryAddOn()

for thes select this creates the dropdown menu arrow

Overrides:

createMandatoryAddOn in class ValueBox<S extends AbstractSelect<T,V,S>,elemental2.dom.HTMLElement,T>

Returns:

the FlexItem that contains the mandatory addons

doSetValue

protected void doSetValue(T value)

Specified by:

doSetValue in class ValueBox<S extends AbstractSelect<T,V,S>,elemental2.dom.HTMLElement,T>

Parameters:

value - V the value to set for this field

setSearchFilter

public S setSearchFilter(DropDownMenu.SearchFilter searchFilter)

Sets a custom search filter to be used when setSearchable(boolean) is enabled

Parameters:

searchFilter - DropDownMenu.SearchFilter

Returns:

same select instance

getOptionsMenu

public DropDownMenu getOptionsMenu()

Returns:

the DropDownMenu of this select

isClosePopOverOnOpen

public boolean isClosePopOverOnOpen()

Returns:

boolean, true if closePopOverOnOpen is enabled

setClosePopOverOnOpen

public S setClosePopOverOnOpen(boolean closePopOverOnOpen)

Enable/Disable closing other popups in the screen when opens the select dropdown menu

Parameters:

closePopOverOnOpen - boolean, true to close other popups

Returns:

same select instance

isAutoCloseOnSelect

public boolean isAutoCloseOnSelect()

Returns:

boolean, true if the dropdown menu should close after selecting an option

setAutoCloseOnSelect

public S setAutoCloseOnSelect(boolean autoCloseOnSelect)

Parameters:

autoCloseOnSelect - boolean, if true the dropdown menu will close after selecting an option otherwise it remains open

Returns:

same select instance

scrollToSelectedOption

protected abstract void scrollToSelectedOption()

implementation of this method will determine how the select will scroll to the selected option when opens the dropdown menu