com.extjs.gxt.ui.client.widget.form

Class ListField<D extends com.extjs.gxt.ui.client.data.ModelData>

java.lang.Object

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

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

com.extjs.gxt.ui.client.widget.Component

com.extjs.gxt.ui.client.widget.BoxComponent

com.extjs.gxt.ui.client.widget.form.Field<D>

com.extjs.gxt.ui.client.widget.form.ListField<D>

Type Parameters:

D - the model type

All Implemented Interfaces:

com.extjs.gxt.ui.client.event.Observable, com.extjs.gxt.ui.client.event.SelectionProvider<D>, com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.IsWidget

public class ListField<D extends com.extjs.gxt.ui.client.data.ModelData>
extends com.extjs.gxt.ui.client.widget.form.Field<D>
implements com.extjs.gxt.ui.client.event.SelectionProvider<D>

A multi-select list field.

Inherited Events:

Field Focus

Field Blur

Field Change

Field Invalid

Field Valid

Field KeyPress

Field SpecialKey

BoxComponent Move

BoxComponent Resize

Component Enable

Component Disable

Component BeforeHide

Component Hide

Component BeforeShow

Component Show

Component Attach

Component Detach

Component BeforeRender

Component Render

Component BrowserEvent

Component BeforeStateRestore

Component StateRestore

Component BeforeStateSave

Component SaveState

Nested Class Summary

Nested classes/interfaces inherited from class com.extjs.gxt.ui.client.widget.form.Field

com.extjs.gxt.ui.client.widget.form.Field.FieldImages, com.extjs.gxt.ui.client.widget.form.Field.FieldMessages

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

Field Summary

Fields

Modifier and Type	Field and Description
protected com.extjs.gxt.ui.client.widget.ListView<D>	listView
protected com.extjs.gxt.ui.client.store.ListStore<D>	store

Fields inherited from class com.extjs.gxt.ui.client.widget.form.Field

autoValidate, emptyText, errorIcon, fieldStyle, focusStyle, focusValue, forceInvalidText, hasFocus, images, invalidStyle, messages, name, originalValue, preventMark, propertyEditor, readOnly, readOnlyFieldStyle, validationDelay, validationTask, value

Fields inherited from class com.extjs.gxt.ui.client.widget.BoxComponent

adjustSize, cacheSizes, ensureVisibilityOnSizing, height, lastSize, layer, shim, width

Fields inherited from class com.extjs.gxt.ui.client.widget.Component

afterRender, attachables, baseStyle, disabled, disabledStyle, disableTextSelection, dummy, focusable, hidden, mask, maskMessage, maskMessageStyleName, monitorWindowResize, rendered, resizeHandler, setElementRender, stateId, swallowEvents, toolTip, windowResizeDelay, windowResizeTask

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

DEBUG_ID_PREFIX

Constructor Summary

Constructors

Constructor and Description
ListField()

Method Summary

Modifier and Type	Method and Description
void	addSelectionChangedListener(com.extjs.gxt.ui.client.event.SelectionChangedListener<D> listener)
void	disable()
protected void	doAttachChildren()
protected void	doDetachChildren()
void	enable()
String	getDisplayField() Returns the display field.
protected El	getInputEl()
String	getItemSelector() Returns the item selector.
com.extjs.gxt.ui.client.widget.ListView<D>	getListView() Returns the field's list view.
com.extjs.gxt.ui.client.widget.form.ListModelPropertyEditor<D>	getPropertyEditor()
String	getRawValue()
List<D>	getSelection()
com.extjs.gxt.ui.client.store.ListStore<D>	getStore() Returns the field's store.
com.extjs.gxt.ui.client.core.XTemplate	getTemplate() Returns the custom template.
D	getValue()
String	getValueField()
protected void	onFocus(com.extjs.gxt.ui.client.event.ComponentEvent ce)
protected void	onRender(com.google.gwt.user.client.Element parent, int index)
protected void	onResize(int width, int height)
protected void	onSelectionChange(List<D> sel)
void	removeSelectionListener(com.extjs.gxt.ui.client.event.SelectionChangedListener<D> listener)
void	setDisplayField(String displayField) Sets the display field.
void	setItemSelector(String itemSelector) This setting is required if a custom XTemplate has been specified.
void	setPropertyEditor(com.extjs.gxt.ui.client.widget.form.PropertyEditor<D> propertyEditor)
void	setSelection(List<D> selection)
void	setStore(com.extjs.gxt.ui.client.store.ListStore<D> store) Sets the list field's list store.
void	setTemplate(String html) Sets the field's template used to render the list.
void	setTemplate(com.extjs.gxt.ui.client.core.XTemplate template) Sets the field's template used to render the list.
void	setValue(D value)
void	setValueField(String valueField) Sets the field's value field.
protected boolean	validateValue(String value)

Methods inherited from class com.extjs.gxt.ui.client.widget.form.Field

addInputStyleName, addKeyListener, afterRender, alignErrorIcon, clear, clearInvalid, createComponentEvent, findLabelElement, fireChangeEvent, fireKey, focus, forceInvalid, getAutoValidate, getEmptyText, getErrorMessage, getFieldLabel, getImages, getLabelSeparator, getLabelStyle, getMessages, getMessageTarget, getName, getOriginalValue, getStyleEl, getValidateOnBlur, getValidationDelay, initValue, isDirty, isFireChangeEventOnSetValue, isHideLabel, isInEditor, isReadOnly, isValid, isValid, markInvalid, onBlur, onClick, onComponentEvent, onDetach, onDisable, onEnable, onHide, onKeyDown, onKeyPress, onKeyUp, onShow, removeInputStyleName, removeKeyListener, reset, setAutoValidate, setEmptyText, setFieldLabel, setFireChangeEventOnSetValue, setHideLabel, setImages, setInEditor, setInputStyleAttribute, setLabelSeparator, setLabelStyle, setMessages, setMessageTarget, setName, setOriginalValue, setRawValue, setReadOnly, setTabIndex, setValidateOnBlur, setValidationDelay, updateOriginalValue, validate, validate

Methods inherited from class com.extjs.gxt.ui.client.widget.BoxComponent

adjustPosition, adjustSize, getBounds, getHeight, getHeight, getPosition, getPositionEl, getResizeEl, getShadow, getShadowOffset, getShadowPosition, getSize, getWidth, getWidth, hideShadow, hideShim, hideUnders, isAutoHeight, isAutoWidth, isDeferHeight, isShim, onPosition, onUnload, setAutoHeight, setAutoWidth, setBounds, setBounds, setDeferHeight, setHeight, setHeight, setPagePosition, setPagePosition, setPixelSize, setPosition, setShadow, setShadowOffset, setShadowPosition, setShim, setSize, setSize, setWidth, setWidth, sync, syncSize

Methods inherited from class com.extjs.gxt.ui.client.widget.Component

addAttachable, addListener, addPlugin, addStyleName, addStyleOnOver, addWidgetListener, applyState, assertAfterRender, assertPreRender, beforeRender, blur, clearState, createObservable, createStyles, disableContextMenu, disableEvents, disableTextSelection, el, enableEvents, fireEvent, fireEvent, fireEvent, fly, frame, getAriaSupport, getBaseStyle, getBorders, getContextMenu, getData, getElement, getFocusEl, getFocusSupport, getHideMode, getId, getItemId, getListeners, getModel, getObservable, getPlugins, getState, getStateId, getTabIndex, getTitle, getToolTip, getWindowResizeDelay, hasListeners, hasListeners, hide, hideToolTip, initState, isDisabledEvents, isDisableTextSelection, isEnabled, isMasked, isMonitorWindowResize, isRendered, isStateful, isVisible, isVisible, mask, mask, mask, notifyHide, notifyShow, onAttach, onBrowserEvent, onDetachHelper, onEnsureDebugId, onHideContextMenu, onLoad, onRightClick, onShowContextMenu, onWindowResize, previewEvent, recalculate, removeAllListeners, removeAttachagle, removeFromParent, removeListener, removeStyleName, removeStyleOnOver, removeSwallow, removeToolTip, removeWidgetListener, render, render, repaint, saveState, setAriaRole, setAriaState, setAriaSupport, setBorders, setContextMenu, setData, setEl, setElement, setElement, setEnabled, setFiresEvents, setHideMode, setId, setIntStyleAttribute, setItemId, setModel, setMonitorWindowResize, setParent, setStateful, setStateId, setStyleAttribute, setStyleName, setTitle, setToolTip, setToolTip, setVisible, setWindowResizeDelay, setZIndex, show, sinkEvents, swallowEvent, swallowEvent, toString, unframe, unmask

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, setLayoutData, unsinkEvents

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

addStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, removeStyleDependentName, resolvePotentialElement, setElement, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEvent

Methods inherited from class java.lang.Object

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

Field Detail

listView

protected com.extjs.gxt.ui.client.widget.ListView<D extends com.extjs.gxt.ui.client.data.ModelData> listView

store

protected com.extjs.gxt.ui.client.store.ListStore<D extends com.extjs.gxt.ui.client.data.ModelData> store

Constructor Detail

ListField

public ListField()

Method Detail

addSelectionChangedListener

public void addSelectionChangedListener(com.extjs.gxt.ui.client.event.SelectionChangedListener<D> listener)

Specified by:

addSelectionChangedListener in interface com.extjs.gxt.ui.client.event.SelectionProvider<D extends com.extjs.gxt.ui.client.data.ModelData>

disable

public void disable()

Overrides:

disable in class com.extjs.gxt.ui.client.widget.Component

enable

public void enable()

Overrides:

enable in class com.extjs.gxt.ui.client.widget.Component

getDisplayField

public String getDisplayField()

Returns the display field.

Returns:

the display field

getItemSelector

public String getItemSelector()

Returns the item selector.

Returns:

the item selector

getListView

public com.extjs.gxt.ui.client.widget.ListView<D> getListView()

Returns the field's list view.

Returns:

the list view

getPropertyEditor

public com.extjs.gxt.ui.client.widget.form.ListModelPropertyEditor<D> getPropertyEditor()

Overrides:

getPropertyEditor in class com.extjs.gxt.ui.client.widget.form.Field<D extends com.extjs.gxt.ui.client.data.ModelData>

getRawValue

public String getRawValue()

Overrides:

getRawValue in class com.extjs.gxt.ui.client.widget.form.Field<D extends com.extjs.gxt.ui.client.data.ModelData>

getSelection

public List<D> getSelection()

Specified by:

getSelection in interface com.extjs.gxt.ui.client.event.SelectionProvider<D extends com.extjs.gxt.ui.client.data.ModelData>

getStore

public com.extjs.gxt.ui.client.store.ListStore<D> getStore()

Returns the field's store.

Returns:

the store

getTemplate

public com.extjs.gxt.ui.client.core.XTemplate getTemplate()

Returns the custom template.

Returns:

the template

getValue

public D getValue()

Overrides:

getValue in class com.extjs.gxt.ui.client.widget.form.Field<D extends com.extjs.gxt.ui.client.data.ModelData>

getValueField

public String getValueField()

removeSelectionListener

public void removeSelectionListener(com.extjs.gxt.ui.client.event.SelectionChangedListener<D> listener)

Specified by:

removeSelectionListener in interface com.extjs.gxt.ui.client.event.SelectionProvider<D extends com.extjs.gxt.ui.client.data.ModelData>

setDisplayField

public void setDisplayField(String displayField)

Sets the display field.

Parameters:

displayField - the display field

setItemSelector

public void setItemSelector(String itemSelector)

This setting is required if a custom XTemplate has been specified.

Parameters:

itemSelector - the item selector

setPropertyEditor

public void setPropertyEditor(com.extjs.gxt.ui.client.widget.form.PropertyEditor<D> propertyEditor)

Overrides:

setPropertyEditor in class com.extjs.gxt.ui.client.widget.form.Field<D extends com.extjs.gxt.ui.client.data.ModelData>

setSelection

public void setSelection(List<D> selection)

Specified by:

setSelection in interface com.extjs.gxt.ui.client.event.SelectionProvider<D extends com.extjs.gxt.ui.client.data.ModelData>

setValue

public void setValue(D value)

Overrides:

setValue in class com.extjs.gxt.ui.client.widget.form.Field<D extends com.extjs.gxt.ui.client.data.ModelData>

setStore

public void setStore(com.extjs.gxt.ui.client.store.ListStore<D> store)

Sets the list field's list store.

Parameters:

store - the store

setTemplate

public void setTemplate(String html)

Sets the field's template used to render the list.

Parameters:

html - the html frament

setTemplate

public void setTemplate(com.extjs.gxt.ui.client.core.XTemplate template)

Sets the field's template used to render the list.

Parameters:

template -

setValueField

public void setValueField(String valueField)

Sets the field's value field.

Parameters:

valueField - the value field

doAttachChildren

protected void doAttachChildren()

Overrides:

doAttachChildren in class com.extjs.gxt.ui.client.widget.Component

doDetachChildren

protected void doDetachChildren()

Overrides:

doDetachChildren in class com.extjs.gxt.ui.client.widget.form.Field<D extends com.extjs.gxt.ui.client.data.ModelData>

getInputEl

protected El getInputEl()

Overrides:

getInputEl in class com.extjs.gxt.ui.client.widget.form.Field<D extends com.extjs.gxt.ui.client.data.ModelData>

onFocus

protected void onFocus(com.extjs.gxt.ui.client.event.ComponentEvent ce)

Overrides:

onFocus in class com.extjs.gxt.ui.client.widget.form.Field<D extends com.extjs.gxt.ui.client.data.ModelData>

onRender

protected void onRender(com.google.gwt.user.client.Element parent,
                        int index)

Overrides:

onRender in class com.extjs.gxt.ui.client.widget.form.Field<D extends com.extjs.gxt.ui.client.data.ModelData>

onResize

protected void onResize(int width,
                        int height)

Overrides:

onResize in class com.extjs.gxt.ui.client.widget.form.Field<D extends com.extjs.gxt.ui.client.data.ModelData>

onSelectionChange

protected void onSelectionChange(List<D> sel)

validateValue

protected boolean validateValue(String value)

Overrides:

validateValue in class com.extjs.gxt.ui.client.widget.form.Field<D extends com.extjs.gxt.ui.client.data.ModelData>