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<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<List<M>>, HasEditorDelegate<List<M>>, HasEditorErrors<List<M>>, LeafValueEditor<List<M>>, ValueAwareEditor<List<M>>, HasAttachHandlers, HasResizeHandlers, HasValueChangeHandlers<List<M>>, HasHandlers, EventListener, TakesValue<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<List<M>>, HasFocusSupport, HasItemId, Iterable<Widget>

public class DualListField<M,T>
extends AdapterField<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

Nested Classes

Modifier and Type	Class and Description
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.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

Constructors

Constructor and Description
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.
DualListField(ListStore<M> fromStore, ListStore<M> toStore, ValueProvider<? super M,T> valueProvider, Cell<T> cell, DualListField.DualListFieldAppearance appearance) Creates a dual list field that allows selections to be moved between two list views using buttons or by dragging and dropping selections.
DualListField(ModelKeyProvider<? super M> keyProvider, 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

Methods

Modifier and Type	Method and Description
IconButton	getAllLeftButton() Returns the all left button.
IconButton	getAllRightButton() Returns the all right button.
DualListField.DualListFieldAppearance	getAppearance()
String	getDndGroup() Returns the DND group name.
IconButton	getDownButton() Returns the down button.
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.
ListStore<M>	getFromStore() Returns the ListStore that manages the source of selectable items.
ListView<M,T>	getFromView() Returns the list view that provides the source of selectable items.
IconButton	getLeftButton() Returns the left icon button.
DualListField.DualListFieldMessages	getMessages() Returns the locale-sensitive messages used by this class.
DualListField.Mode	getMode() Returns the list field's mode.
IconButton	getRightButton() Returns the right button.
ListStore<M>	getToStore() Returns the ListStore that manages the destination for selectable items.
ListView<M,T>	getToView() Returns the list view that provides the destination for selectable items.
IconButton	getUpButton() Returns the up button.
List<M>	getValue()
boolean	isEnableDnd() Returns true if drag and drop is enabled.
void	setDndGroup(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(List<M> value)

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

addInvalidHandler, addValidator, addValidHandler, addValueChangeHandler, clear, clearInvalid, disable, enable, finishEditing, flush, forceInvalid, getErrors, getErrorSupport, getValidators, isValid, isValid, markInvalid, onPropertyChange, 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, getShadowPosition, getStateId, getTabIndex, 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, setShadowPosition, setSize, setStateful, setStateId, setTabIndex, setToolTip, 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, unsinkEvents

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

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

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

addBlurHandler

Methods inherited from interface com.google.gwt.event.shared.HasHandlers

fireEvent

Constructor Detail

DualListField

public DualListField(ModelKeyProvider<? super M> keyProvider,
             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:

keyProvider - the key provider to use to track items

valueProvider - the interface to <M>

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

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)

DualListField

public DualListField(ListStore<M> fromStore,
             ListStore<M> toStore,
             ValueProvider<? super M,T> valueProvider,
             Cell<T> cell,
             DualListField.DualListFieldAppearance appearance)

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)

appearance - the appearance instance to use when rendering this widget

Method Detail

getAppearance

public DualListField.DualListFieldAppearance getAppearance()

getDndGroup

public 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

getFromStore

public ListStore<M> getFromStore()

Returns the ListStore that manages the source of selectable items.

Returns:

the list store that manages 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

getToStore

public ListStore<M> getToStore()

Returns the ListStore that manages the destination for selectable items.

Returns:

the ListStore that manages the destination for selectable items

getValue

public List<M> getValue()

getLeftButton

public IconButton getLeftButton()

Returns the left icon button.

Returns:

the left button

getAllLeftButton

public IconButton getAllLeftButton()

Returns the all left button.

Returns:

the all left button

getRightButton

public IconButton getRightButton()

Returns the right button.

Returns:

the right button

getAllRightButton

public IconButton getAllRightButton()

Returns the all right button.

Returns:

the all right button

getUpButton

public IconButton getUpButton()

Returns the up button.

Returns:

the up button

getDownButton

public IconButton getDownButton()

Returns the down button.

Returns:

the down button

isEnableDnd

public boolean isEnableDnd()

Returns true if drag and drop is enabled.

Returns:

true if drag and drop is enabled

setDndGroup

public void setDndGroup(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(List<M> value)