com.extjs.gxt.ui.client.widget.form
Class DualListField<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.MultiField<Field<?>>
                          com.extjs.gxt.ui.client.widget.form.DualListField<D>

Type Parameters:

D - the model type

All Implemented Interfaces:

Observable, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener

public class DualListField<D extends ModelData>
extends MultiField<Field<?>>

Combines two list fields and allows selections to be moved between fields either using buttons or by dragging and dropping selections.

Nested Class Summary

class	DualListField.DualListFieldMessages The dual list field messages.
static class	DualListField.Mode

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

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

DEBUG_ID_PREFIX

Constructor Summary

DualListField()

Method Summary

java.lang.String	getDNDGroup()
ListField<D>	getFromList() Returns the from list field.
DualListField.DualListFieldMessages	getMessages() Returns the field's messages.
DualListField.Mode	getMode() Returns the list field's mode.
ListField<D>	getToList() Returns the to list field.
boolean	isEnableDND() Returns true if drag and drop is enabled.
void	setDNDGroup(java.lang.String group) Sets the drag and drop group name.
void	setEnableDND(boolean enableDND) True to allow selections to be dragged and dropped between lists (defaults to true).
void	setMode(DualListField.Mode mode) Specifies if selections are either inserted or appended when moving between lists.

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

add, disable, enable, get, getAll, getOrientation, getSpacing, getValidator, isResizeFields, isValid, onBrowserEvent, onComponentEvent, reset, setOrientation, setReadOnly, setResizeFields, setSpacing, setValidator

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

addInputStyleName, addKeyListener, clearInvalid, focus, forceInvalid, getAutoValidate, getEmptyText, getErrorMessage, getFieldLabel, getImages, getLabelSeparator, getLabelStyle, getMessageTarget, getName, getOriginalValue, getPropertyEditor, getRawValue, getValidateOnBlur, getValidationDelay, getValue, isDirty, isFireChangeEventOnSetValue, isHideLabel, isInEditor, isReadOnly, isValid, markInvalid, removeInputStyleName, removeKeyListener, setAutoValidate, setEmptyText, setFieldLabel, setFireChangeEventOnSetValue, setHideLabel, setImages, setInEditor, setLabelSeparator, setLabelStyle, setMessages, setMessageTarget, setName, setOriginalValue, setPropertyEditor, setRawValue, setTabIndex, setValidateOnBlur, setValidationDelay, setValue, updateOriginalValue, validate, validate

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

getBounds, getHeight, getHeight, getPosition, getShadow, getShadowOffset, getShadowPosition, getSize, getWidth, getWidth, isAutoHeight, isAutoWidth, isDeferHeight, isShim, 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

addListener, addPlugin, addStyleName, addWidgetListener, clearState, disableEvents, disableTextSelection, el, enableEvents, fireEvent, fireEvent, fireEvent, fly, getBaseStyle, getBorders, getContextMenu, getData, getElement, getHideMode, getId, getItemId, getListeners, getModel, getState, getStateId, getToolTip, hasListeners, hasListeners, hide, hideToolTip, isDisabledEvents, isEnabled, isRendered, isStateful, isVisible, mask, mask, mask, recalculate, removeAllListeners, removeFromParent, removeListener, removeStyleName, removeSwallow, removeToolTip, removeWidgetListener, render, render, repaint, saveState, setBorders, setContextMenu, setData, setElement, setEnabled, setHideMode, setId, setIntStyleAttribute, setItemId, setStateful, setStateId, setStyleAttribute, setStyleName, setTitle, setToolTip, setToolTip, setVisible, setZIndex, show, sinkEvents, swallowEvent, swallowEvent, toString, unmask

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

fireEvent, getParent, isAttached

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

addStyleDependentName, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getOffsetHeight, getOffsetWidth, getStyleName, getStylePrimaryName, getTitle, isVisible, removeStyleDependentName, setStylePrimaryName, setVisible, unsinkEvents

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DualListField

public DualListField()

Method Detail

getDNDGroup

public java.lang.String getDNDGroup()

getFromList

public ListField<D> getFromList()

Returns the from list field.

Returns:

the field

getMessages

public DualListField.DualListFieldMessages getMessages()

Description copied from class: Field

Returns the field's messages.

Overrides:

getMessages in class Field<Field<?>>

Returns:

the messages

getMode

public DualListField.Mode getMode()

Returns the list field's mode.

Returns:

the mode

getToList

public ListField<D> getToList()

Returns the to list field.

Returns:

the field

isEnableDND

public boolean isEnableDND()

Returns true if drag and drop is enabled.

Returns:

true if drag and drop is enabled

setDNDGroup

public void setDNDGroup(java.lang.String group)

Sets the drag and drop group name. A group name will be generated if none is specified.

Parameters:

group - the group name

setEnableDND

public void setEnableDND(boolean enableDND)

True to allow selections to be dragged and dropped between lists (defaults to true).

Parameters:

enableDND - true to enable drag and drop

setMode

public void setMode(DualListField.Mode mode)

Specifies if selections are either inserted or appended when moving between lists.

Parameters:

mode - the mode