com.sencha.gxt.widget.core.client.form
Class DualListField<M,T>

java.lang.Object
  com.google.gwt.user.client.ui.UIObject
      com.google.gwt.user.client.ui.Widget
          com.sencha.gxt.widget.core.client.Component
              com.sencha.gxt.widget.core.client.container.Container
                  com.sencha.gxt.widget.core.client.container.ResizeContainer
                      com.sencha.gxt.widget.core.client.container.SimpleContainer
                          com.sencha.gxt.widget.core.client.form.AdapterField<java.util.List<M>>
                              com.sencha.gxt.widget.core.client.form.DualListField<M,T>

Type Parameters:

M - the model type

T - the type displayed in the list view

All Implemented Interfaces:

Editor<java.util.List<M>>, HasEditorDelegate<java.util.List<M>>, HasEditorErrors<java.util.List<M>>, LeafValueEditor<java.util.List<M>>, HasAttachHandlers, HasResizeHandlers, HasHandlers, EventListener, TakesValue<java.util.List<M>>, AcceptsOneWidget, HasEnabled, HasOneWidget, HasVisibility, HasWidgets, HasWidgets.ForIsWidget, IndexedPanel, IndexedPanel.ForIsWidget, IsWidget, ProvidesResize, RequiresResize, HasLayout, AddEvent.HasAddHandlers, BeforeAddEvent.HasBeforeAddHandlers, BeforeHideEvent.HasBeforeHideHandlers, BeforeRemoveEvent.HasBeforeRemoveHandlers, BeforeShowContextMenuEvent.HasBeforeShowContextMenuHandler, BeforeShowEvent.HasBeforeShowHandlers, BlurEvent.HasBlurHandlers, ContainerHandler.HasContainerHandlers, DisableEvent.HasDisableHandlers, EnableEvent.HasEnableHandlers, FocusEvent.HasFocusHandlers, HideEvent.HasHideHandlers, InvalidEvent.HasInvalidHandlers, MoveEvent.HasMoveHandlers, RemoveEvent.HasRemoveHandlers, ShowContextMenuEvent.HasShowContextMenuHandler, ShowEvent.HasShowHandlers, ValidEvent.HasValidHandlers, IsField<java.util.List<M>>, HasFocusSupport, HasItemId, java.lang.Iterable<Widget>

public class DualListField<M,T>
extends AdapterField<java.util.List<M>>

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

Nested Class Summary

static interface	DualListField.DualListFieldAppearance
static interface	DualListField.DualListFieldMessages The locale-sensitive messages used by this class.
static class	DualListField.Mode The DND mode enumeration.

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

UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled

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

Editor.Ignore, Editor.Path

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

HasWidgets.ForIsWidget

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

IndexedPanel.ForIsWidget

Field Summary

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

DEBUG_ID_PREFIX

Constructor Summary

DualListField(ListStore<M> fromStore, ListStore<M> toStore, ValueProvider<? super M,T> valueProvider, Cell<T> cell)
Creates a dual list field that allows selections to be moved between two list views using buttons or by dragging and dropping selections.

Method Summary

java.lang.String	getDndGroup() Returns the DND group name.
ListViewDragSource<M>	getDragSourceFromField() Returns the from field's drag source instance.
ListViewDragSource<M>	getDragSourceToField() Returns the to field's drag source instance.
ListViewDropTarget<M>	getDropTargetFromField() Returns the from field's drop target instance.
ListViewDropTarget<M>	getDropTargetToField() Returns the to field's drop target instance.
ListView<M,T>	getFromView() Returns the list view that provides the source of selectable items.
DualListField.DualListFieldMessages	getMessages() Returns the locale-sensitive messages used by this class.
DualListField.Mode	getMode() Returns the list field's mode.
ListView<M,T>	getToView() Returns the list view that provides the destination for selectable items.
java.util.List<M>	getValue()
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	setMessages(DualListField.DualListFieldMessages messages) Sets the local-sensitive messages used by this class.
void	setMode(DualListField.Mode mode) Specifies if selections are either inserted or appended when moving between lists.
void	setValue(java.util.List<M> value)

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

addInvalidHandler, addValidator, addValidHandler, clear, clearInvalid, disable, enable, forceInvalid, getErrorSupport, getValidators, isValid, isValid, markInvalid, removeValidator, reset, setDelegate, setErrorSupport, showErrors, validate, validate

Methods inherited from class com.sencha.gxt.widget.core.client.container.SimpleContainer

add, add, getWidget, isResize, setResize, setWidget, setWidget

Methods inherited from class com.sencha.gxt.widget.core.client.container.ResizeContainer

forceLayout, isLayoutRunning, isOrWasLayoutRunning, onResize

Methods inherited from class com.sencha.gxt.widget.core.client.container.Container

add, addAddHandler, addBeforeAddHandler, addBeforeRemoveHandler, addContainerHandler, addRemoveHandler, findWidget, getItemByItemId, getWidget, getWidgetCount, getWidgetIndex, getWidgetIndex, iterator, remove, remove, remove

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

addBeforeHideHandler, addBeforeShowContextMenuHandler, addBeforeShowHandler, addBlurHandler, addDisableHandler, addEnableHandler, addFocusHandler, addHideHandler, addMoveHandler, addResizeHandler, addShowContextMenuHandler, addShowHandler, addStyleOnOver, clearSizeCache, disableEvents, enableEvents, fireEvent, focus, getData, getElement, getFocusSupport, getHideMode, getId, getItemId, getOffsetHeight, getOffsetWidth, getShadow, getStateId, getToolTip, hide, hideToolTip, isAllowTextSelection, isAutoHeight, isAutoWidth, isDeferHeight, isEnabled, isRendered, isStateful, isVisible, isVisible, mask, mask, onBrowserEvent, removeToolTip, setAllowTextSelection, setBorders, setBounds, setBounds, setContextMenu, setData, setDeferHeight, setEnabled, setHeight, setHeight, setHideMode, setId, setItemId, setPagePosition, setPixelSize, setPosition, setShadow, setSize, setStateful, setStateId, setTabIndex, setToolTip, setToolTipConfig, setVisible, setWidth, setWidth, show, sync, syncSize, unmask

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

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, getLayoutData, getParent, isAttached, removeFromParent, setLayoutData, sinkEvents

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

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getOffsetHeight, getOffsetWidth, getStyleName, getStylePrimaryName, getTitle, isVisible, removeStyleDependentName, removeStyleName, setStyleDependentName, setStyleName, setStyleName, setStylePrimaryName, setTitle, setVisible, sinkBitlessEvent, toString, unsinkEvents

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.google.gwt.user.client.ui.IsWidget

asWidget

Constructor Detail

DualListField

@UiConstructor
public DualListField(ListStore<M> fromStore,
                                   ListStore<M> toStore,
                                   ValueProvider<? super M,T> valueProvider,
                                   Cell<T> cell)

Creates a dual list field that allows selections to be moved between two list views using buttons or by dragging and dropping selections.

Parameters:

fromStore - the store containing the base set of items

toStore - the store containing the items selected by the user

valueProvider - the interface to <M>

cell - displays the data in the list view (e.g. TextCell).

Method Detail

getDndGroup

public java.lang.String getDndGroup()

Returns the DND group name.

Returns:

the group name

getDragSourceFromField

public ListViewDragSource<M> getDragSourceFromField()

Returns the from field's drag source instance.

Returns:

the drag source

getDragSourceToField

public ListViewDragSource<M> getDragSourceToField()

Returns the to field's drag source instance.

Returns:

the drag source

getDropTargetFromField

public ListViewDropTarget<M> getDropTargetFromField()

Returns the from field's drop target instance.

Returns:

the drag source

getDropTargetToField

public ListViewDropTarget<M> getDropTargetToField()

Returns the to field's drop target instance.

Returns:

the drag source

getFromView

public ListView<M,T> getFromView()

Returns the list view that provides the source of selectable items.

Returns:

the list view that provides the source of selectable items

getMessages

public DualListField.DualListFieldMessages getMessages()

Returns the locale-sensitive messages used by this class.

Returns:

the local-sensitive messages used by this class.

getMode

public DualListField.Mode getMode()

Returns the list field's mode.

Returns:

the mode

getToView

public ListView<M,T> getToView()

Returns the list view that provides the destination for selectable items.

Returns:

the list view that provides the destination for selectable items

getValue

public java.util.List<M> getValue()

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

setMessages

public void setMessages(DualListField.DualListFieldMessages messages)

Sets the local-sensitive messages used by this class.

Parameters:

messages - the locale sensitive messages used by this class.

setMode

public void setMode(DualListField.Mode mode)

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

Parameters:

mode - the mode

setValue

public void setValue(java.util.List<M> value)