com.sencha.gxt.widget.core.client.form

Class StringComboBox

java.lang.Object

Widget

com.sencha.gxt.widget.core.client.Component

com.sencha.gxt.widget.core.client.cell.CellComponent<T>

com.sencha.gxt.widget.core.client.form.Field<T>

com.sencha.gxt.widget.core.client.form.ValueBaseField<T>

com.sencha.gxt.widget.core.client.form.TriggerField<T>

com.sencha.gxt.widget.core.client.form.ComboBox<T>

com.sencha.gxt.widget.core.client.form.SimpleComboBox<String>

com.sencha.gxt.widget.core.client.form.StringComboBox

All Implemented Interfaces:

BeforeHideEvent.HasBeforeHideHandlers, BeforeQueryEvent.HasBeforeQueryHandlers<String>, BeforeShowContextMenuEvent.HasBeforeShowContextMenuHandler, BeforeShowEvent.HasBeforeShowHandlers, BlurEvent.HasBlurHandlers, CollapseEvent.HasCollapseHandlers, DisableEvent.HasDisableHandlers, EnableEvent.HasEnableHandlers, ExpandEvent.HasExpandHandlers, FocusEvent.HasFocusHandlers, HideEvent.HasHideHandlers, InvalidEvent.HasInvalidHandlers, MoveEvent.HasMoveHandlers, ParseErrorEvent.HasParseErrorHandlers, ShowContextMenuEvent.HasShowContextMenuHandler, ShowEvent.HasShowHandlers, TriggerClickEvent.HasTriggerClickHandlers, ValidEvent.HasValidHandlers, HasErrorHandler, IsField<String>, HasFocusSupport, HasItemId

public class StringComboBox
extends SimpleComboBox<String>

A combo box that displays a drop down list of Strings, optionally allowing the user to type arbitrary values in the combo box text field and adding these to the drop down list. This can be useful for saving user entered search history, recent URLs, etc.

To allow users to enter arbitrary values in the combo box text field, set the force selection property to false using ComboBox.setForceSelection(boolean).

To add user values to the drop down list, set the add user values property to true using setAddUserValues(boolean).

User values that are added to the drop down list can be retrieved with getUserValues() and removed with clearUserValues().

NOTE: User values are added to the drop down list when the combo box loses focus.

Nested Class Summary

Nested classes/interfaces inherited from class com.sencha.gxt.widget.core.client.form.Field

Field.FieldStyles

Field Summary

Fields inherited from class com.sencha.gxt.widget.core.client.form.ComboBox

autoComplete

Fields inherited from class com.sencha.gxt.widget.core.client.form.ValueBaseField

impl

Fields inherited from class com.sencha.gxt.widget.core.client.form.Field

forceInvalidText, hasFocus, name, originalValue, parseError, preventMark, validationTask

Fields inherited from class com.sencha.gxt.widget.core.client.cell.CellComponent

valueUpdater

Fields inherited from class com.sencha.gxt.widget.core.client.Component

adjustSize, allowTextSelection, cacheSizes, disableContextMenu, disabled, disabledStyle, ensureVisibilityOnSizing, height, hidden, lastSize, layer, left, mask, maskMessage, monitorWindowResize, pageX, pageY, resizeHandler, shim, tabIndex, toolTip, toolTipConfig, top, width, windowResizeDelay, windowResizeTask

Constructor Summary

Constructors

Constructor and Description
StringComboBox() Creates an empty combo box in preparation for values to be added to the selection list using SimpleComboBox.add(java.util.List<T>).
StringComboBox(List<String> values) Creates a combo box containing the specified values.
StringComboBox(TriggerFieldCell.TriggerFieldAppearance appearance) Creates an empty combo box with a given appearance - values can be added to the selection list with SimpleComboBox.add(java.util.List<T>).

Method Summary

Modifier and Type	Method and Description
void	clearUserValues() Clears the list of values typed by the user.
StringComboBoxCell	getCell() Get the Cell wrapped by this widget.
List<String>	getUserValues() Returns a list containing values typed by the user in the combo box text field.
boolean	isAddUserValues() Returns true to indicate that arbitrary values typed by the user will be added to the drop down list.
void	setAddUserValues(boolean isAddUserValues) Set to true to add arbitrary values typed by the user to the drop down list; be sure to also set force selection to false.

Methods inherited from class com.sencha.gxt.widget.core.client.form.SimpleComboBox

add, add, getSelectedIndex, remove

Methods inherited from class com.sencha.gxt.widget.core.client.form.ComboBox

addBeforeQueryHandler, addBeforeSelectionHandler, addCollapseHandler, addExpandHandler, addSelectionHandler, clear, collapse, doQuery, expand, getAllQuery, getLabelProvider, getListView, getLoader, getMaxHeight, getMinChars, getMinListWidth, getPageSize, getQueryDelay, getStore, getTriggerAction, getTypeAheadDelay, isExpanded, isForceSelection, isTypeAhead, isUseQueryCache, onAfterFirstAttach, onCellParseError, onDetach, select, select, setAllQuery, setExpanded, setForceSelection, setLoader, setLoadingHtml, setLoadingText, setMaxHeight, setMinChars, setMinListWidth, setPageSize, setQueryDelay, setStore, setTriggerAction, setTypeAhead, setTypeAheadDelay, setUseQueryCache

Methods inherited from class com.sencha.gxt.widget.core.client.form.TriggerField

addTriggerClickHandler, isEditable, isFinishEditOnEnter, isMonitorTab, onBlur, setEditable, setFinishEditOnEnter, setHideTrigger, setMonitorTab

Methods inherited from class com.sencha.gxt.widget.core.client.form.ValueBaseField

addChangeHandler, addKeyDownHandler, addKeyPressHandler, addKeyUpHandler, addParseErrorHandler, doAutoValidate, getCurrentValue, getCursorPos, getDirection, getDirectionEstimator, getEmptyText, getFocusEl, getImpl, getInputEl, getPropertyEditor, getSelectedText, getSelectionLength, getText, getValueOrThrow, isAllowBlank, isClearValueOnParseError, isCurrentValid, isCurrentValid, isReadOnly, isSelectOnFocus, onRedraw, select, selectAll, setAllowBlank, setClearValueOnParseError, setCursorPos, setDirection, setDirectionEstimator, setDirectionEstimator, setEmptyText, setId, setPropertyEditor, setReadOnly, setSelectionRange, setSelectOnFocus, setTabIndex, setText, setValue, validateCurrent

Methods inherited from class com.sencha.gxt.widget.core.client.form.Field

addInvalidHandler, addValidator, addValidHandler, addValueChangeHandler, clearInvalid, finishEditing, flush, forceInvalid, getErrors, getErrorSupport, getName, getOriginalValue, getValidateOnBlur, getValidationDelay, getValidators, isAutoValidate, isEditing, isValid, isValid, markInvalid, markInvalid, onBrowserEvent, onDisable, onEnable, onFocus, onKeyDown, onKeyPress, onKeyUp, onLogicalBlur, onLogicalFocus, onNavigationKey, onPropertyChange, removeValidator, reset, setAutoValidate, setDelegate, setErrors, setErrorSupport, setName, setOriginalValue, setValidateOnBlur, setValidationDelay, setValue, showErrors, validate, validate, validateValue

Methods inherited from class com.sencha.gxt.widget.core.client.cell.CellComponent

createContext, getElement, getKey, getKeyProvider, getValue, onResize, redraw, redraw, setKeyProvider, setValue

Methods inherited from class com.sencha.gxt.widget.core.client.Component

addBeforeHideHandler, addBeforeShowContextMenuHandler, addBeforeShowHandler, addBlurHandler, addDisableHandler, addEnableHandler, addFocusHandler, addHideHandler, addMoveHandler, addResizeHandler, addShowContextMenuHandler, addShowHandler, addStyleDependentName, addStyleOnOver, adjustPosition, adjustSize, applyState, assertAfterRender, assertPreRender, blur, clearSizeCache, disable, disableContextMenu, disableEvents, enable, enableEvents, fireCancellableEvent, fireEvent, focus, getData, getFocusSupport, getHideMode, getId, getItemId, getOffsetHeight, getOffsetWidth, getPositionEl, getShadow, getShadowPosition, getStateId, getTabIndex, getToolTip, hide, hideShadow, hideToolTip, isAllowTextSelection, isAutoHeight, isAutoWidth, isDeferHeight, isEnabled, isMonitorWindowResize, isRendered, isStateful, isVisible, isVisible, mask, mask, notifyHide, notifyShow, onAttach, onHide, onHideContextMenu, onLoad, onPosition, onRightClick, onShow, onShowContextMenu, onUnload, onWindowResize, removeStyleDependentName, removeStyleOnOver, removeToolTip, setAllowTextSelection, setBorders, setBounds, setBounds, setContextMenu, setData, setDeferHeight, setEnabled, setHeight, setHeight, setHideMode, setItemId, setMonitorWindowResize, setPagePosition, setPixelSize, setPosition, setShadow, setShadowPosition, setSize, setStateful, setStateId, setStyleDependentName, setToolTip, setToolTipConfig, setVisible, setWidth, setWidth, show, sync, syncSize, unmask

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.sencha.gxt.widget.core.client.event.BlurEvent.HasBlurHandlers

addBlurHandler

Constructor Detail

StringComboBox

public StringComboBox()

Creates an empty combo box in preparation for values to be added to the selection list using SimpleComboBox.add(java.util.List<T>).

StringComboBox

public StringComboBox(TriggerFieldCell.TriggerFieldAppearance appearance)

Creates an empty combo box with a given appearance - values can be added to the selection list with SimpleComboBox.add(java.util.List<T>).

Parameters:

appearance - the appearance to use when drawing the combo box

StringComboBox

public StringComboBox(List<String> values)

Creates a combo box containing the specified values.

Parameters:

values - values to include in the combo box

Method Detail

clearUserValues

public void clearUserValues()

Clears the list of values typed by the user.

getCell

public StringComboBoxCell getCell()

Description copied from class: CellComponent

Get the Cell wrapped by this widget.

Overrides:

getCell in class ComboBox<String>

Returns:

the Cell being wrapped

getUserValues

public List<String> getUserValues()

Returns a list containing values typed by the user in the combo box text field. These values are saved when the focus leaves the combo box if the force selection property is false and the add user values property is true.

Returns:

a list of values typed by the user

isAddUserValues

public boolean isAddUserValues()

Returns true to indicate that arbitrary values typed by the user will be added to the drop down list.

Returns:

true to indicate values typed by user will be saved in drop down list

setAddUserValues

public void setAddUserValues(boolean isAddUserValues)

Set to true to add arbitrary values typed by the user to the drop down list; be sure to also set force selection to false.

This value is false by default (i.e. user values are not added to the drop down list).

Parameters:

isAddUserValues - true to add arbitrary values typed by the user to the drop down list