gwt.material.design.client.ui

Class MaterialListValueBox<T>

java.lang.Object

com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.Widget

com.google.gwt.user.client.ui.Panel

com.google.gwt.user.client.ui.ComplexPanel

gwt.material.design.client.base.MaterialWidget

gwt.material.design.client.base.AbstractValueWidget<T>

gwt.material.design.client.ui.MaterialListValueBox<T>

All Implemented Interfaces:

com.google.gwt.editor.client.Editor<T>, com.google.gwt.editor.client.HasEditorErrors<T>, com.google.gwt.editor.client.LeafValueEditor<T>, com.google.gwt.event.dom.client.HasAllFocusHandlers, com.google.gwt.event.dom.client.HasAllGestureHandlers, com.google.gwt.event.dom.client.HasAllKeyHandlers, com.google.gwt.event.dom.client.HasAllMouseHandlers, com.google.gwt.event.dom.client.HasAllTouchHandlers, com.google.gwt.event.dom.client.HasBlurHandlers, com.google.gwt.event.dom.client.HasClickHandlers, com.google.gwt.event.dom.client.HasDoubleClickHandlers, com.google.gwt.event.dom.client.HasFocusHandlers, com.google.gwt.event.dom.client.HasGestureChangeHandlers, com.google.gwt.event.dom.client.HasGestureEndHandlers, com.google.gwt.event.dom.client.HasGestureStartHandlers, com.google.gwt.event.dom.client.HasKeyDownHandlers, com.google.gwt.event.dom.client.HasKeyPressHandlers, com.google.gwt.event.dom.client.HasKeyUpHandlers, com.google.gwt.event.dom.client.HasMouseDownHandlers, com.google.gwt.event.dom.client.HasMouseMoveHandlers, com.google.gwt.event.dom.client.HasMouseOutHandlers, com.google.gwt.event.dom.client.HasMouseOverHandlers, com.google.gwt.event.dom.client.HasMouseUpHandlers, com.google.gwt.event.dom.client.HasMouseWheelHandlers, com.google.gwt.event.dom.client.HasTouchCancelHandlers, com.google.gwt.event.dom.client.HasTouchEndHandlers, com.google.gwt.event.dom.client.HasTouchMoveHandlers, com.google.gwt.event.dom.client.HasTouchStartHandlers, com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.logical.shared.HasValueChangeHandlers<T>, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.TakesValue<T>, com.google.gwt.user.client.ui.Focusable, com.google.gwt.user.client.ui.HasConstrainedValue<T>, com.google.gwt.user.client.ui.HasEnabled, com.google.gwt.user.client.ui.HasValue<T>, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.HasWidgets, com.google.gwt.user.client.ui.HasWidgets.ForIsWidget, com.google.gwt.user.client.ui.IndexedPanel, com.google.gwt.user.client.ui.IndexedPanel.ForIsWidget, com.google.gwt.user.client.ui.IsWidget, HasErrorHandler, HasAllDragAndDropHandlers, HasBorder, HasCenterOn, HasCircle, HasColors, HasDataAttributes, HasDepth, HasDimension, HasDraggableHandlers, HasDroppableHandlers, HasError, HasFlexbox, HasFloat, HasFontSize, HasFontWeight, HasGrid, HasHideOn, HasHoverable, HasId, HasInitialClasses, HasInlineStyle, HasInteractionHandlers, HasOpacity, HasOrientation, HasOrientationChangeHandler, HasPlaceholder, HasReadOnly, HasReload, HasScrollspy, HasSeparator, HasShadow, HasShowOn, HasTextAlign, HasTooltip, HasTransform, HasVerticalAlign, HasWaves, JsLoader, HasValidators<T>, ValidationChangedEvent.HasValidationChangedHandlers, Iterable<com.google.gwt.user.client.ui.Widget>

Direct Known Subclasses:

MaterialListBox

public class MaterialListValueBox<T>
extends AbstractValueWidget<T>
implements JsLoader, HasPlaceholder, com.google.gwt.user.client.ui.HasConstrainedValue<T>, HasReadOnly

Material ListBox is another dropdown component that will set / get the value depends on the selected index

UiBinder Usage:

 
    <m:MaterialListBox ui:field="lstBox" />
 
 

Java Usage:

 
     // functions
    lstBox.setSelectedIndex(2);
    lstBox.getSelectedIndex();
    lstBox.addValueChangeHandler(handler);
 
 

Author:

kevzlou7979, Ben Dol

See Also:

Material ListBox, Material Design Specification

Nested Class Summary

Nested classes/interfaces inherited from class gwt.material.design.client.base.MaterialWidget

MaterialWidget.Feature

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

Nested classes/interfaces inherited from interface com.google.gwt.editor.client.Editor

com.google.gwt.editor.client.Editor.Ignore, com.google.gwt.editor.client.Editor.Path

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.IndexedPanel

com.google.gwt.user.client.ui.IndexedPanel.ForIsWidget

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.HasWidgets

com.google.gwt.user.client.ui.HasWidgets.ForIsWidget

Field Summary

Fields

Modifier and Type	Field and Description
protected List<T>	values

Fields inherited from class gwt.material.design.client.base.MaterialWidget

$this

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
MaterialListValueBox()

Method Summary

Modifier and Type	Method and Description
void	add(T value)
void	addItem(T value) Adds an item to the list box.
void	addItem(T value, boolean reload) Adds an item to the list box.
void	addItem(T value, com.google.gwt.i18n.client.HasDirection.Direction dir) Adds an item to the list box, specifying its direction.
void	addItem(T value, com.google.gwt.i18n.client.HasDirection.Direction dir, boolean reload) Adds an item to the list box, specifying its direction.
void	addItem(T value, com.google.gwt.i18n.client.HasDirection.Direction dir, String text) Adds an item to the list box, specifying its direction and an initial value for the item.
void	addItem(T value, com.google.gwt.i18n.client.HasDirection.Direction dir, String text, boolean reload) Adds an item to the list box, specifying its direction and an initial value for the item.
void	addItem(T value, String text) Adds an item to the list box, specifying an initial value for the item.
void	addItem(T value, String text, boolean reload) Adds an item to the list box, specifying an initial value for the item.
void	clear() Removes all items from the list box.
String	getEmptyPlaceHolder()
MaterialLabel	getErrorLabel()
ErrorMixin<AbstractValueWidget,MaterialLabel>	getErrorMixin()
int	getIndex(T value) Gets the index of the specified value.
protected int	getIndexOffset()
int	getItemCount() Gets the number of items present in the list box.
String[]	getItemsSelected() Returns all selected values of the list box, or empty array if none.
String	getItemText(int index) Gets the text associated with the item at the specified index.
Label	getLabel()
com.google.gwt.user.client.ui.ListBox	getListBox()
String	getName()
com.google.gwt.dom.client.OptionElement	getOptionElement(int index)
String	getPlaceholder()
ReadOnlyMixin<MaterialListValueBox<T>,com.google.gwt.user.client.ui.ListBox>	getReadOnlyMixin()
int	getSelectedIndex() Gets the currently-selected item.
protected int	getSelectedIndexInternal()
String	getSelectedItemText() Gets the text for currently selected item.
T	getSelectedValue() Gets the value for currently selected item.
protected com.google.gwt.dom.client.SelectElement	getSelectElement()
protected ToggleStyleMixin<com.google.gwt.user.client.ui.ListBox>	getToggleOldMixin()
T	getValue()
T	getValue(int index) Gets the value associated with the item at a given index.
protected T	getValueInternal(int index)
int	getVisibleItemCount() Gets the number of items that are visible.
protected void	insertEmptyPlaceHolder(String emptyPlaceHolder)
void	insertItem(T value, com.google.gwt.i18n.client.HasDirection.Direction dir, int index) Inserts an item into the list box, specifying its direction.
void	insertItem(T value, com.google.gwt.i18n.client.HasDirection.Direction dir, int index, boolean reload) Inserts an item into the list box, specifying its direction.
void	insertItem(T value, com.google.gwt.i18n.client.HasDirection.Direction dir, String text, int index) Inserts an item into the list box, specifying its direction and an initial value for the item.
void	insertItem(T value, com.google.gwt.i18n.client.HasDirection.Direction dir, String text, int index, boolean reload) Inserts an item into the list box, specifying its direction and an initial value for the item.
void	insertItem(T value, int index) Inserts an item into the list box.
void	insertItem(T value, int index, boolean reload) Inserts an item into the list box.
void	insertItem(T value, String text, int index) Inserts an item into the list box, specifying an initial value for the item.
void	insertItem(T value, String text, int index, boolean reload) Inserts an item into the list box, specifying an initial value for the item.
protected void	insertItemInternal(T value, com.google.gwt.i18n.client.HasDirection.Direction dir, int index, boolean reload)
protected void	insertItemInternal(T value, com.google.gwt.i18n.client.HasDirection.Direction dir, String text, int index, boolean reload)
protected void	insertItemInternal(T value, int index, boolean reload)
protected void	insertItemInternal(T value, String text, int index, boolean reload)
protected boolean	isEmptyPlaceHolderListed() Checks whether emptyPlaceHolder is added/present in both listBox and values at 0 index.
boolean	isEnabled()
boolean	isItemSelected(int index) Determines whether an individual list item is selected.
boolean	isMultipleSelect() Gets whether this list allows multiple selection.
boolean	isOld()
boolean	isReadOnly()
boolean	isToggleReadOnly()
void	load()
protected void	onLoad()
protected void	onUnload()
void	reload()
protected void	removeEmptyPlaceHolder()
void	removeItem(int index) Removes the item at the specified index.
void	removeItem(int index, boolean reload) Removes the item at the specified index.
protected void	removeItemInternal(int index, boolean reload)
void	removeValue(T value) Removes a value from the list box.
void	removeValue(T value, boolean reload) Removes a value from the list box.
void	reset() Reset the form element to blank and clear error messages.
void	setAcceptableValues(Collection<T> values)
void	setEmptyPlaceHolder(String value)
void	setEnabled(boolean enabled)
void	setItemSelected(int index, boolean selected) Sets whether an individual list item is selected.
void	setItemText(int index, String text) Sets the text associated with the item at a given index.
void	setItemText(int index, String text, com.google.gwt.i18n.client.HasDirection.Direction dir) Sets the text associated with the item at a given index.
void	setKeyFactory(KeyFactory<T,String> keyFactory) Use your own key factory for value keys.
void	setMultipleSelect(boolean multipleSelect) Sets whether this list allows multiple selections.
void	setName(String name)
void	setOld(boolean old)
void	setPlaceholder(String placeholder)
void	setReadOnly(boolean value)
void	setSelectedIndex(int index) Sets the currently selected index.
protected void	setSelectedIndexInternal(int index)
void	setSelectedValue(T value) Sets the currently selected value.
void	setTitle(String title)
void	setToggleReadOnly(boolean toggle)
void	setValue(int index, String value) Sets the value associated with the item at a given index.
void	setValue(T value)
void	setValue(T value, boolean fireEvents)
void	setValueSelected(T value, boolean selected) Sets whether an individual list value is selected.
void	setVisibleItemCount(int visibleItems) Sets the number of items that are visible.
void	unload()

Methods inherited from class gwt.material.design.client.base.AbstractValueWidget

addValidationChangedHandler, addValidator, addValueChangeHandler, clearErrorOrSuccess, createBlankValidator, getErrorHandler, getErrorHandlerMixin, getErrorHandlerType, getValidatorMixin, isAllowBlank, isValidateOnBlur, removeValidator, setAllowBlank, setError, setErrorHandler, setErrorHandlerType, setHelperText, setSuccess, setupBlurValidation, setValidateOnBlur, setValidators, setValue, showErrors, validate, validate

Methods inherited from class gwt.material.design.client.base.MaterialWidget

$this, add, add, addAttachHandler, addBlurHandler, addClickHandler, addDoubleClickHandler, addDragEndHandler, addDragEnterHandler, addDragLeaveHandler, addDragMoveHandler, addDragOverHandler, addDragStartHandler, addDropActivateHandler, addDropDeactivateHandler, addDropHandler, addFocusHandler, addGestureChangeHandler, addGestureEndHandler, addGestureStartHandler, addKeyDownHandler, addKeyPressHandler, addKeyUpHandler, addMouseDownHandler, addMouseMoveHandler, addMouseOutHandler, addMouseOverHandler, addMouseUpHandler, addMouseWheelHandler, addOrientationChangeHandler, addTouchCancelHandler, addTouchEndHandler, addTouchMoveHandler, addTouchStartHandler, body, clearActiveClass, enableFeature, getBackfaceVisibility, getBackgroundColor, getBorder, getBorderBottom, getBorderLeft, getBorderMixin, getBorderRadius, getBorderRight, getBorderTop, getCenterOn, getCenterOnMixin, getChildren, getChildrenList, getCircleMixin, getColorsMixin, getDataAttribute, getDepth, getDimensionMixin, getEnabledMixin, getFlexboxMixin, getFloat, getFloatMixin, getFocusableMixin, getFontSize, getFontSizeMixin, getFontWeight, getFontWeightMixin, getGridMixin, getHandlerRegistry, getHideOn, getHideOnMixin, getHoverableMixin, getId, getIdMixin, getInitialClasses, getLayoutPosition, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getOpacity, getOrientation, getOrientationMixin, getPerspective, getPerspectiveOrigin, getScrollspy, getScrollspyMixin, getSeparatorMixin, getShadow, getShadowMixin, getShowOn, getShowOnMixin, getTabIndex, getTextAlign, getTextAlignMixin, getTextColor, getTooltip, getTooltipDelayMs, getTooltipHTML, getTooltipMixin, getTooltipPosition, getTransform, getTransformMixin, getTransformOrigin, getTransformStyle, getTruncateMixin, getVerticalAlign, getVerticalAlignMixin, getWaves, getWavesMixin, getWidth, insert, insert, isCircle, isDetectOrientation, isFeatureEnabled, isHoverable, isSeparator, isTruncate, registerHandler, removeHandler, setAccessKey, setBackfaceVisibility, setBackgroundColor, setBorder, setBorderBottom, setBorderLeft, setBorderRadius, setBorderRight, setBorderTop, setBottom, setCenterOn, setCircle, setClass, setDataAttribute, setDepth, setDetectOrientation, setDisplay, setFlex, setFlexAlignContent, setFlexAlignItems, setFlexAlignSelf, setFlexBasis, setFlexDirection, setFlexGrow, setFlexJustifyContent, setFlexOrder, setFlexShrink, setFlexWrap, setFloat, setFocus, setFontSize, setFontSize, setFontWeight, setGrid, setGwtDisplay, setHideOn, setHoverable, setId, setInitialClasses, setLayoutPosition, setLeft, setLineHeight, setMargin, setMarginBottom, setMarginLeft, setMarginRight, setMarginTop, setMaxHeight, setMaxWidth, setMinHeight, setMinWidth, setOffset, setOpacity, setOrientation, setOverflow, setPadding, setPaddingBottom, setPaddingLeft, setPaddingRight, setPaddingTop, setPerspective, setPerspectiveOrigin, setRight, setScrollspy, setSeparator, setShadow, setShowOn, setStyle, setTabIndex, setTextAlign, setTextColor, setTooltip, setTooltipDelayMs, setTooltipHTML, setTooltipPosition, setTop, setTransform, setTransformOrigin, setTransformStyle, setTransition, setTruncate, setVerticalAlign, setVisibility, setWaves, stopTouchStartEvent, window

Methods inherited from class com.google.gwt.user.client.ui.ComplexPanel

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

Methods inherited from class com.google.gwt.user.client.ui.Panel

add, adopt, doAttachChildren, doDetachChildren, orphan, remove

Methods inherited from class com.google.gwt.user.client.ui.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 com.google.gwt.user.client.ui.UIObject

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.gwt.event.logical.shared.HasValueChangeHandlers

addValueChangeHandler

Methods inherited from interface com.google.gwt.event.shared.HasHandlers

fireEvent

Methods inherited from interface gwt.material.design.client.base.HasFlexbox

setVisible

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

values

protected final List<T> values

Constructor Detail

MaterialListValueBox

public MaterialListValueBox()

Method Detail

onLoad

protected void onLoad()

Overrides:

onLoad in class MaterialWidget

load

public void load()

Specified by:

load in interface JsLoader

onUnload

protected void onUnload()

Overrides:

onUnload in class MaterialWidget

unload

public void unload()

Specified by:

unload in interface JsLoader

reload

public void reload()

Specified by:

reload in interface HasReload

add

public void add(T value)

addItem

public void addItem(T value,
                    com.google.gwt.i18n.client.HasDirection.Direction dir)

Adds an item to the list box, specifying its direction. This method has the same effect as

addItem(value, dir, item)

Parameters:

value - the item's value, to be submitted if it is part of a FormPanel; cannot be null

dir - the item's direction

addItem

public void addItem(T value,
                    com.google.gwt.i18n.client.HasDirection.Direction dir,
                    boolean reload)

Adds an item to the list box, specifying its direction. This method has the same effect as

addItem(value, dir, item)

Parameters:

value - the item's value, to be submitted if it is part of a FormPanel; cannot be null

dir - the item's direction

reload - perform a 'material select' reload to update the DOM.

addItem

public void addItem(T value)

Adds an item to the list box. This method has the same effect as

addItem(value, item)

Parameters:

value - the item's value, to be submitted if it is part of a FormPanel; cannot be null

addItem

public void addItem(T value,
                    boolean reload)

Adds an item to the list box. This method has the same effect as

addItem(value, item)

Parameters:

value - the item's value, to be submitted if it is part of a FormPanel; cannot be null

reload - perform a 'material select' reload to update the DOM.

addItem

public void addItem(T value,
                    String text)

Adds an item to the list box, specifying an initial value for the item.

Parameters:

value - the item's value, to be submitted if it is part of a FormPanel; cannot be null

text - the text of the item to be added

addItem

public void addItem(T value,
                    String text,
                    boolean reload)

Adds an item to the list box, specifying an initial value for the item.

Parameters:

value - the item's value, to be submitted if it is part of a FormPanel; cannot be null

text - the text of the item to be added

reload - perform a 'material select' reload to update the DOM.

addItem

public void addItem(T value,
                    com.google.gwt.i18n.client.HasDirection.Direction dir,
                    String text)

Adds an item to the list box, specifying its direction and an initial value for the item.

Parameters:

value - the item's value, to be submitted if it is part of a FormPanel; cannot be null

dir - the item's direction

text - the text of the item to be added

addItem

public void addItem(T value,
                    com.google.gwt.i18n.client.HasDirection.Direction dir,
                    String text,
                    boolean reload)

Adds an item to the list box, specifying its direction and an initial value for the item.

Parameters:

value - the item's value, to be submitted if it is part of a FormPanel; cannot be null

dir - the item's direction

text - the text of the item to be added

reload - perform a 'material select' reload to update the DOM.

insertItem

public void insertItem(T value,
                       int index)

Inserts an item into the list box. Has the same effect as

insertItem(value, item, index)

Parameters:

value - the item's value, to be submitted if it is part of a FormPanel.

index - the index at which to insert it

insertItem

public void insertItem(T value,
                       int index,
                       boolean reload)

Inserts an item into the list box. Has the same effect as

insertItem(value, item, index)

Parameters:

value - the item's value, to be submitted if it is part of a FormPanel.

index - the index at which to insert it

reload - perform a 'material select' reload to update the DOM.

insertItemInternal

protected void insertItemInternal(T value,
                                  int index,
                                  boolean reload)

insertItem

public void insertItem(T value,
                       com.google.gwt.i18n.client.HasDirection.Direction dir,
                       int index)

Inserts an item into the list box, specifying its direction. Has the same effect as

insertItem(value, dir, item, index)

Parameters:

value - the item's value, to be submitted if it is part of a FormPanel.

dir - the item's direction

index - the index at which to insert it

insertItem

public void insertItem(T value,
                       com.google.gwt.i18n.client.HasDirection.Direction dir,
                       int index,
                       boolean reload)

Inserts an item into the list box, specifying its direction. Has the same effect as

insertItem(value, dir, item, index)

Parameters:

value - the item's value, to be submitted if it is part of a FormPanel.

dir - the item's direction

index - the index at which to insert it

reload - perform a 'material select' reload to update the DOM.

insertItemInternal

protected void insertItemInternal(T value,
                                  com.google.gwt.i18n.client.HasDirection.Direction dir,
                                  int index,
                                  boolean reload)

insertItem

public void insertItem(T value,
                       String text,
                       int index)

Inserts an item into the list box, specifying an initial value for the item. Has the same effect as

insertItem(value, null, item, index)

Parameters:

value - the item's value, to be submitted if it is part of a FormPanel.

text - the text of the item to be inserted

index - the index at which to insert it

insertItem

public void insertItem(T value,
                       String text,
                       int index,
                       boolean reload)

Inserts an item into the list box, specifying an initial value for the item. Has the same effect as

insertItem(value, null, item, index)

Parameters:

value - the item's value, to be submitted if it is part of a FormPanel.

text - the text of the item to be inserted

index - the index at which to insert it

reload - perform a 'material select' reload to update the DOM.

insertItemInternal

protected void insertItemInternal(T value,
                                  String text,
                                  int index,
                                  boolean reload)

insertItem

public void insertItem(T value,
                       com.google.gwt.i18n.client.HasDirection.Direction dir,
                       String text,
                       int index)

Inserts an item into the list box, specifying its direction and an initial value for the item. If the index is less than zero, or greater than or equal to the length of the list, then the item will be appended to the end of the list.

Parameters:

value - the item's value, to be submitted if it is part of a FormPanel.

dir - the item's direction. If null, the item is displayed in the widget's overall direction, or, if a direction estimator has been set, in the item's estimated direction.

text - the text of the item to be inserted

index - the index at which to insert it

insertItem

public void insertItem(T value,
                       com.google.gwt.i18n.client.HasDirection.Direction dir,
                       String text,
                       int index,
                       boolean reload)

Inserts an item into the list box, specifying its direction and an initial value for the item. If the index is less than zero, or greater than or equal to the length of the list, then the item will be appended to the end of the list.

Parameters:

value - the item's value, to be submitted if it is part of a FormPanel.

dir - the item's direction. If null, the item is displayed in the widget's overall direction, or, if a direction estimator has been set, in the item's estimated direction.

text - the text of the item to be inserted

index - the index at which to insert it

reload - perform a 'material select' reload to update the DOM.

insertItemInternal

protected void insertItemInternal(T value,
                                  com.google.gwt.i18n.client.HasDirection.Direction dir,
                                  String text,
                                  int index,
                                  boolean reload)

removeItem

public void removeItem(int index)

Removes the item at the specified index.

Parameters:

index - the index of the item to be removed

Throws:

IndexOutOfBoundsException - if the index is out of range

removeItem

public void removeItem(int index,
                       boolean reload)

Removes the item at the specified index.

Parameters:

index - the index of the item to be removed

reload - perform a 'material select' reload to update the DOM.

Throws:

IndexOutOfBoundsException - if the index is out of range

removeItemInternal

protected void removeItemInternal(int index,
                                  boolean reload)

removeValue

public void removeValue(T value)

Removes a value from the list box. Nothing is done if the value isn't on the list box.

Parameters:

value - the value to be removed from the list

removeValue

public void removeValue(T value,
                        boolean reload)

Removes a value from the list box. Nothing is done if the value isn't on the list box.

Parameters:

value - the value to be removed from the list

reload - perform a 'material select' reload to update the DOM.

reset

public void reset()

Description copied from interface: HasValidators

Reset the form element to blank and clear error messages.

Specified by:

reset in interface HasValidators<T>

Overrides:

reset in class AbstractValueWidget<T>

clear

public void clear()

Removes all items from the list box.

Specified by:

clear in interface com.google.gwt.user.client.ui.HasWidgets

Overrides:

clear in class com.google.gwt.user.client.ui.Panel

setPlaceholder

public void setPlaceholder(String placeholder)

Specified by:

setPlaceholder in interface HasPlaceholder

getPlaceholder

public String getPlaceholder()

Specified by:

getPlaceholder in interface HasPlaceholder

getOptionElement

public com.google.gwt.dom.client.OptionElement getOptionElement(int index)

getSelectElement

protected com.google.gwt.dom.client.SelectElement getSelectElement()

setMultipleSelect

public void setMultipleSelect(boolean multipleSelect)

Sets whether this list allows multiple selections.

Parameters:

multipleSelect - true to allow multiple selections

isMultipleSelect

public boolean isMultipleSelect()

Gets whether this list allows multiple selection.

Returns:

true if multiple selection is allowed

setEmptyPlaceHolder

public void setEmptyPlaceHolder(String value)

getEmptyPlaceHolder

public String getEmptyPlaceHolder()

setAcceptableValues

public void setAcceptableValues(Collection<T> values)

Specified by:

setAcceptableValues in interface com.google.gwt.user.client.ui.HasConstrainedValue<T>

getValue

public T getValue()

Specified by:

getValue in interface com.google.gwt.user.client.TakesValue<T>

Specified by:

getValue in interface com.google.gwt.user.client.ui.HasValue<T>

setValue

public void setValue(T value)

Specified by:

setValue in interface com.google.gwt.user.client.TakesValue<T>

Specified by:

setValue in interface com.google.gwt.user.client.ui.HasValue<T>

Overrides:

setValue in class AbstractValueWidget<T>

setValue

public void setValue(T value,
                     boolean fireEvents)

Specified by:

setValue in interface com.google.gwt.user.client.ui.HasValue<T>

Overrides:

setValue in class AbstractValueWidget<T>

isOld

public boolean isOld()

setOld

public void setOld(boolean old)

setValue

public void setValue(int index,
                     String value)

Sets the value associated with the item at a given index. This value can be used for any purpose, but is also what is passed to the server when the list box is submitted as part of a FormPanel.

Parameters:

index - the index of the item to be set

value - the item's new value; cannot be null

Throws:

IndexOutOfBoundsException - if the index is out of range

setTitle

public void setTitle(String title)

Overrides:

setTitle in class com.google.gwt.user.client.ui.UIObject

setItemSelected

public void setItemSelected(int index,
                            boolean selected)

Sets whether an individual list item is selected.

Parameters:

index - the index of the item to be selected or unselected

selected - true to select the item

Throws:

IndexOutOfBoundsException - if the index is out of range

setItemText

public void setItemText(int index,
                        String text)

Sets the text associated with the item at a given index.

Parameters:

index - the index of the item to be set

text - the item's new text

Throws:

IndexOutOfBoundsException - if the index is out of range

setItemText

public void setItemText(int index,
                        String text,
                        com.google.gwt.i18n.client.HasDirection.Direction dir)

Sets the text associated with the item at a given index.

Parameters:

index - the index of the item to be set

text - the item's new text

dir - the item's direction.

Throws:

IndexOutOfBoundsException - if the index is out of range

setName

public void setName(String name)

setSelectedIndex

public void setSelectedIndex(int index)

Sets the currently selected index.

After calling this method, only the specified item in the list will remain selected. For a ListBox with multiple selection enabled, see setItemSelected(int, boolean) to select multiple items at a time.

Parameters:

index - the index of the item to be selected

setSelectedIndexInternal

protected void setSelectedIndexInternal(int index)

setVisibleItemCount

public void setVisibleItemCount(int visibleItems)

Sets the number of items that are visible. If only one item is visible, then the box will be displayed as a drop-down list.

Parameters:

visibleItems - the visible item count

getItemCount

public int getItemCount()

Gets the number of items present in the list box.

Returns:

the number of items

getItemText

public String getItemText(int index)

Gets the text associated with the item at the specified index.

Parameters:

index - the index of the item whose text is to be retrieved

Returns:

the text associated with the item

Throws:

IndexOutOfBoundsException - if the index is out of range

getSelectedItemText

public String getSelectedItemText()

Gets the text for currently selected item. If multiple items are selected, this method will return the text of the first selected item.

Returns:

the text for selected item, or null if none is selected

getName

public String getName()

getSelectedIndex

public int getSelectedIndex()

Gets the currently-selected item. If multiple items are selected, this method will return the first selected item (isItemSelected(int) can be used to query individual items).

Returns:

the selected index, or -1 if none is selected

getSelectedIndexInternal

protected int getSelectedIndexInternal()

getValue

public T getValue(int index)

Gets the value associated with the item at a given index.

Parameters:

index - the index of the item to be retrieved

Returns:

the item's associated value

Throws:

IndexOutOfBoundsException - if the index is out of range

getValueInternal

protected T getValueInternal(int index)

getSelectedValue

public T getSelectedValue()

Gets the value for currently selected item. If multiple items are selected, this method will return the value of the first selected item.

Returns:

the value for selected item, or null if none is selected

getVisibleItemCount

public int getVisibleItemCount()

Gets the number of items that are visible. If only one item is visible, then the box will be displayed as a drop-down list.

Returns:

the visible item count

isItemSelected

public boolean isItemSelected(int index)

Determines whether an individual list item is selected.

Parameters:

index - the index of the item to be tested

Returns:

true if the item is selected

Throws:

IndexOutOfBoundsException - if the index is out of range

setEnabled

public void setEnabled(boolean enabled)

Specified by:

setEnabled in interface com.google.gwt.user.client.ui.HasEnabled

Overrides:

setEnabled in class MaterialWidget

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface com.google.gwt.user.client.ui.HasEnabled

Overrides:

isEnabled in class MaterialWidget

setKeyFactory

public void setKeyFactory(KeyFactory<T,String> keyFactory)

Use your own key factory for value keys.

setReadOnly

public void setReadOnly(boolean value)

Specified by:

setReadOnly in interface HasReadOnly

isReadOnly

public boolean isReadOnly()

Specified by:

isReadOnly in interface HasReadOnly

setToggleReadOnly

public void setToggleReadOnly(boolean toggle)

Specified by:

setToggleReadOnly in interface HasReadOnly

isToggleReadOnly

public boolean isToggleReadOnly()

Specified by:

isToggleReadOnly in interface HasReadOnly

getListBox

public com.google.gwt.user.client.ui.ListBox getListBox()

getErrorMixin

public ErrorMixin<AbstractValueWidget,MaterialLabel> getErrorMixin()

Overrides:

getErrorMixin in class AbstractValueWidget<T>

getLabel

public Label getLabel()

getErrorLabel

public MaterialLabel getErrorLabel()

getItemsSelected

public String[] getItemsSelected()

Returns all selected values of the list box, or empty array if none.

Returns:

the selected values of the list box

setSelectedValue

public void setSelectedValue(T value)

Sets the currently selected value.

After calling this method, only the specified item in the list will remain selected. For a ListBox with multiple selection enabled, see #setValueSelected(T, boolean) to select multiple items at a time.

Parameters:

value - the value of the item to be selected

setValueSelected

public void setValueSelected(T value,
                             boolean selected)

Sets whether an individual list value is selected.

Parameters:

value - the value of the item to be selected or unselected

selected - true to select the item

getIndex

public int getIndex(T value)

Gets the index of the specified value.

Parameters:

value - the value of the item to be found

Returns:

the index of the value

getReadOnlyMixin

public ReadOnlyMixin<MaterialListValueBox<T>,com.google.gwt.user.client.ui.ListBox> getReadOnlyMixin()

getToggleOldMixin

protected ToggleStyleMixin<com.google.gwt.user.client.ui.ListBox> getToggleOldMixin()

isEmptyPlaceHolderListed

protected boolean isEmptyPlaceHolderListed()

Checks whether emptyPlaceHolder is added/present in both listBox and values at 0 index.

Returns:

is emptyPlaceHolder added/present in both listBox and values?

insertEmptyPlaceHolder

protected void insertEmptyPlaceHolder(String emptyPlaceHolder)

removeEmptyPlaceHolder

protected void removeEmptyPlaceHolder()

getIndexOffset

protected int getIndexOffset()

Returns:

index increased by number of special items/values at the start (e.g. emptyPlaceHolder)