com.extjs.gxt.ui.client.widget.form
Class ListField<D extends 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:

Observable, 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 ModelData>
extends Field<D>
implements 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

Field.FieldImages, 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

protected ListView<D>	listView
protected 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

ListField()

Method Summary

void	addSelectionChangedListener(SelectionChangedListener<D> listener) Add a selection changed listener.
void	disable() Disable this component.
protected void	doAttachChildren()
protected void	doDetachChildren()
void	enable() Enable this component.
java.lang.String	getDisplayField() Returns the display field.
protected El	getInputEl() Provides support for wrapping the actual input element.
java.lang.String	getItemSelector() Returns the item selector.
ListView<D>	getListView() Returns the field's list view.
ListModelPropertyEditor<D>	getPropertyEditor() Returns the field's property editor.
java.lang.String	getRawValue() Returns the raw data value which may or may not be a valid, defined value.
java.util.List<D>	getSelection() Returns the current selection.
ListStore<D>	getStore() Returns the field's store.
XTemplate	getTemplate() Returns the custom template.
D	getValue() Returns the typed value of the field.
java.lang.String	getValueField()
protected void	onFocus(ComponentEvent ce)
protected void	onRender(com.google.gwt.user.client.Element parent, int index) Subclasses must override and ensure setElement is called for lazy rendered components.
protected void	onResize(int width, int height) Called after the component is resized, this method is empty by default but can be implemented by any subclass that needs to perform custom logic after a resize occurs.
protected void	onSelectionChange(java.util.List<D> sel)
void	removeSelectionListener(SelectionChangedListener<D> listener) Removes a selection changed listener.
void	setDisplayField(java.lang.String displayField) Sets the display field.
void	setItemSelector(java.lang.String itemSelector) This setting is required if a custom XTemplate has been specified.
void	setPropertyEditor(PropertyEditor<D> propertyEditor) Sets the field's property editor which is used to translate typed values to string, and string values back to typed values.
void	setSelection(java.util.List<D> selection) Sets the current selection for this selection provider.
void	setStore(ListStore<D> store) Sets the list field's list store.
void	setTemplate(java.lang.String html) Sets the field's template used to render the list.
void	setTemplate(XTemplate template) Sets the field's template used to render the list.
void	setValue(D value) Sets a data value into the field and validates it.
void	setValueField(java.lang.String valueField) Sets the field's value field.
protected boolean	validateValue(java.lang.String value) Subclasses should provide the validation implementation by overriding this.

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

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

Methods inherited from class java.lang.Object

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

Field Detail

listView

protected ListView<D extends ModelData> listView

store

protected ListStore<D extends ModelData> store

Constructor Detail

ListField

public ListField()

Method Detail

addSelectionChangedListener

public void addSelectionChangedListener(SelectionChangedListener<D> listener)

Description copied from interface: SelectionProvider

Add a selection changed listener.

Specified by:

addSelectionChangedListener in interface SelectionProvider<D extends ModelData>

Parameters:

listener - a selection changed listener

disable

public void disable()

Description copied from class: Component

Disable this component. Fires the Disable event.

Overrides:

disable in class Component

enable

public void enable()

Description copied from class: Component

Enable this component. Fires the Enable event.

Overrides:

enable in class Component

getDisplayField

public java.lang.String getDisplayField()

Returns the display field.

Returns:

the display field

getItemSelector

public java.lang.String getItemSelector()

Returns the item selector.

Returns:

the item selector

getListView

public ListView<D> getListView()

Returns the field's list view.

Returns:

the list view

getPropertyEditor

public ListModelPropertyEditor<D> getPropertyEditor()

Description copied from class: Field

Returns the field's property editor.

Overrides:

getPropertyEditor in class Field<D extends ModelData>

Returns:

the property editor

getRawValue

public java.lang.String getRawValue()

Description copied from class: Field

Returns the raw data value which may or may not be a valid, defined value. To return a normalized value see Field.getValue().

Overrides:

getRawValue in class Field<D extends ModelData>

Returns:

the raw value

getSelection

public java.util.List<D> getSelection()

Description copied from interface: SelectionProvider

Returns the current selection.

Specified by:

getSelection in interface SelectionProvider<D extends ModelData>

Returns:

the current selection

getStore

public ListStore<D> getStore()

Returns the field's store.

Returns:

the store

getTemplate

public XTemplate getTemplate()

Returns the custom template.

Returns:

the template

getValue

public D getValue()

Description copied from class: Field

Returns the typed value of the field.

Overrides:

getValue in class Field<D extends ModelData>

Returns:

the fields value

getValueField

public java.lang.String getValueField()

removeSelectionListener

public void removeSelectionListener(SelectionChangedListener<D> listener)

Description copied from interface: SelectionProvider

Removes a selection changed listener.

Specified by:

removeSelectionListener in interface SelectionProvider<D extends ModelData>

Parameters:

listener - a selection changed listener

setDisplayField

public void setDisplayField(java.lang.String displayField)

Sets the display field.

Parameters:

displayField - the display field

setItemSelector

public void setItemSelector(java.lang.String itemSelector)

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

Parameters:

itemSelector - the item selector

setPropertyEditor

public void setPropertyEditor(PropertyEditor<D> propertyEditor)

Description copied from class: Field

Sets the field's property editor which is used to translate typed values to string, and string values back to typed values.

Overrides:

setPropertyEditor in class Field<D extends ModelData>

Parameters:

propertyEditor - the property editor

setSelection

public void setSelection(java.util.List<D> selection)

Description copied from interface: SelectionProvider

Sets the current selection for this selection provider.

Specified by:

setSelection in interface SelectionProvider<D extends ModelData>

Parameters:

selection - the new selection

setValue

public void setValue(D value)

Description copied from class: Field

Sets a data value into the field and validates it. If the field is rendered, To set the value directly without validation see Field.setRawValue(java.lang.String).

Overrides:

setValue in class Field<D extends ModelData>

Parameters:

value - the value to set

setStore

public void setStore(ListStore<D> store)

Sets the list field's list store.

Parameters:

store - the store

setTemplate

public void setTemplate(java.lang.String html)

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

Parameters:

html - the html frament

setTemplate

public void setTemplate(XTemplate template)

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

Parameters:

template -

setValueField

public void setValueField(java.lang.String valueField)

Sets the field's value field.

Parameters:

valueField - the value field

doAttachChildren

protected void doAttachChildren()

Overrides:

doAttachChildren in class Component

doDetachChildren

protected void doDetachChildren()

Overrides:

doDetachChildren in class Field<D extends ModelData>

getInputEl

protected El getInputEl()

Description copied from class: Field

Provides support for wrapping the actual input element.

Overrides:

getInputEl in class Field<D extends ModelData>

Returns:

the input element

onFocus

protected void onFocus(ComponentEvent ce)

Overrides:

onFocus in class Field<D extends ModelData>

onRender

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

Description copied from class: Component

Subclasses must override and ensure setElement is called for lazy rendered components.

Overrides:

onRender in class Field<D extends ModelData>

Parameters:

parent - the target element

index - the insert location

onResize

protected void onResize(int width,
                        int height)

Description copied from class: BoxComponent

Called after the component is resized, this method is empty by default but can be implemented by any subclass that needs to perform custom logic after a resize occurs.

Overrides:

onResize in class Field<D extends ModelData>

Parameters:

width - the width

height - the height

onSelectionChange

protected void onSelectionChange(java.util.List<D> sel)

validateValue

protected boolean validateValue(java.lang.String value)

Description copied from class: Field

Subclasses should provide the validation implementation by overriding this.

Overrides:

validateValue in class Field<D extends ModelData>

Parameters:

value - the value to validate

Returns:

true for valid