com.flowingcode.vaadin.addons.twincolgrid

Class TwinColGrid<T>

java.lang.Object

com.vaadin.server.AbstractClientConnector

com.vaadin.ui.AbstractComponent

com.vaadin.ui.CustomComponent

com.flowingcode.vaadin.addons.twincolgrid.TwinColGrid<T>

All Implemented Interfaces:

com.vaadin.data.HasValue<Set<T>>, com.vaadin.event.ContextClickEvent.ContextClickNotifier, com.vaadin.event.MethodEventSource, com.vaadin.server.ClientConnector, com.vaadin.server.Sizeable, com.vaadin.shared.Connector, com.vaadin.ui.Component, com.vaadin.ui.HasComponents, Serializable, Iterable<com.vaadin.ui.Component>

public class TwinColGrid<T>
extends com.vaadin.ui.CustomComponent
implements com.vaadin.data.HasValue<Set<T>>

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.vaadin.data.HasValue

com.vaadin.data.HasValue.ValueChangeEvent<V>, com.vaadin.data.HasValue.ValueChangeListener<V>

Nested classes/interfaces inherited from interface com.vaadin.ui.HasComponents

com.vaadin.ui.HasComponents.ComponentAttachDetachNotifier, com.vaadin.ui.HasComponents.ComponentAttachEvent, com.vaadin.ui.HasComponents.ComponentAttachListener, com.vaadin.ui.HasComponents.ComponentDetachEvent, com.vaadin.ui.HasComponents.ComponentDetachListener

Nested classes/interfaces inherited from interface com.vaadin.ui.Component

com.vaadin.ui.Component.ErrorEvent, com.vaadin.ui.Component.Event, com.vaadin.ui.Component.Focusable, com.vaadin.ui.Component.Listener

Nested classes/interfaces inherited from interface com.vaadin.server.ClientConnector

com.vaadin.server.ClientConnector.AttachEvent, com.vaadin.server.ClientConnector.AttachListener, com.vaadin.server.ClientConnector.ConnectorErrorEvent, com.vaadin.server.ClientConnector.DetachEvent, com.vaadin.server.ClientConnector.DetachListener

Nested classes/interfaces inherited from interface com.vaadin.server.Sizeable

com.vaadin.server.Sizeable.Unit

Field Summary

Fields

Modifier and Type	Field and Description
protected com.vaadin.ui.Grid<T>	leftGrid
protected com.vaadin.data.provider.ListDataProvider<T>	leftGridDataProvider
protected com.vaadin.ui.Grid<T>	rightGrid
protected com.vaadin.data.provider.ListDataProvider<T>	rightGridDataProvider

Fields inherited from class com.vaadin.ui.AbstractComponent

DESIGN_ATTR_PLAIN_TEXT

Fields inherited from interface com.vaadin.server.Sizeable

SIZE_UNDEFINED, UNITS_CM, UNITS_EM, UNITS_EX, UNITS_INCH, UNITS_MM, UNITS_PERCENTAGE, UNITS_PICAS, UNITS_PIXELS, UNITS_POINTS

Constructor Summary

Constructors

Constructor and Description
TwinColGrid() Constructs a new TwinColGrid with an empty ListDataProvider.
TwinColGrid(Collection<T> options) Constructs a new TwinColGrid with the given options.
TwinColGrid(com.vaadin.data.provider.ListDataProvider<T> dataProvider) Constructs a new TwinColGrid with data provider for options.
TwinColGrid(String caption, Collection<T> options) Constructs a new TwinColGrid with caption and the given options.
TwinColGrid(String caption, com.vaadin.data.provider.ListDataProvider<T> dataProvider) Constructs a new TwinColGrid with caption and data provider for options.

Method Summary

Modifier and Type	Method and Description
<V> TwinColGrid<T>	addColumn(com.vaadin.data.ValueProvider<T,V> valueProvider, String caption) Adds a new text column to this Grid with a value provider.
com.vaadin.shared.Registration	addLeftGridSelectionListener(com.vaadin.event.selection.SelectionListener<T> listener)
com.vaadin.shared.Registration	addRightGridSelectionListener(com.vaadin.event.selection.SelectionListener<T> listener)
com.vaadin.shared.Registration	addValueChangeListener(com.vaadin.data.HasValue.ValueChangeListener<Set<T>> listener)
String	getLeftColumnCaption() Returns the text shown above the left column.
String	getRightColumnCaption() Returns the text shown above the right column.
int	getRows() Returns the number of rows in the selects.
Set<T>	getValue() Returns the current value of this object which is an immutable set of the currently selected items.
boolean	isReadOnly()
boolean	isRequiredIndicatorVisible()
void	setItems(Collection<T> items)
void	setItems(Stream<T> items)
void	setReadOnly(boolean readOnly)
void	setRequiredIndicatorVisible(boolean visible)
void	setValue(Set<T> value)
TwinColGrid<T>	showAddAllButton()
TwinColGrid<T>	showRemoveAllButton()
TwinColGrid<T>	withDragAndDropSupport() Adds drag n drop support between grids.
TwinColGrid<T>	withLeftColumnCaption(String leftColumnCaption) Sets the text shown above the left column.
TwinColGrid<T>	withRightColumnCaption(String rightColumnCaption) Sets the text shown above the right column.
TwinColGrid<T>	withRows(int rows) Sets the number of rows in the selects.
TwinColGrid<T>	withSizeFull()

Methods inherited from class com.vaadin.ui.CustomComponent

getComponentCount, getCompositionRoot, getState, getState, iterator, setCompositionRoot

Methods inherited from class com.vaadin.ui.AbstractComponent

addContextClickListener, addListener, addShortcutListener, addStyleName, attach, beforeClientResponse, detach, findAncestor, fireComponentErrorEvent, fireComponentEvent, focus, getActionManager, getCaption, getComponentError, getCustomAttributes, getData, getDebugId, getDescription, getErrorMessage, getHeight, getHeightUnits, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getWidth, getWidthUnits, isCaptionAsHtml, isConnectorEnabled, isEnabled, isOrHasAncestor, isResponsive, isVisible, readDesign, removeContextClickListener, removeListener, removeShortcutListener, removeStyleName, setCaption, setCaptionAsHtml, setComponentError, setData, setDebugId, setDescription, setDescription, setEnabled, setHeight, setHeight, setHeightUndefined, setIcon, setId, setLocale, setParent, setPrimaryStyleName, setResponsive, setSizeFull, setSizeUndefined, setStyleName, setStyleName, setVisible, setWidth, setWidth, setWidthUndefined, writeDesign

Methods inherited from class com.vaadin.server.AbstractClientConnector

addAttachListener, addDetachListener, addExtension, addListener, addListener, addListener, addMethodInvocationToQueue, createState, encodeState, equals, fireEvent, getAllChildrenIterable, getConnectorId, getErrorHandler, getExtensions, getListeners, getResource, getRpcManager, getRpcProxy, getSession, getStateType, getUI, handleConnectorRequest, hashCode, hasListeners, isAttached, isThis, markAsDirty, markAsDirtyRecursive, registerRpc, registerRpc, removeAttachListener, removeDetachListener, removeExtension, removeListener, removeListener, removeListener, removeListener, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler, setResource, updateDiffstate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.vaadin.data.HasValue

clear, getDefaultValidator, getEmptyValue, getOptionalValue, isEmpty

Methods inherited from interface com.vaadin.ui.Component

addListener, addStyleName, addStyleNames, attach, getCaption, getDescription, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getUI, isEnabled, isVisible, readDesign, removeListener, removeStyleName, removeStyleNames, setCaption, setEnabled, setIcon, setId, setParent, setPrimaryStyleName, setStyleName, setVisible, writeDesign

Methods inherited from interface com.vaadin.server.ClientConnector

addAttachListener, addDetachListener, beforeClientResponse, detach, encodeState, getErrorHandler, getExtensions, getRpcManager, getStateType, handleConnectorRequest, isAttached, isConnectorEnabled, markAsDirty, markAsDirtyRecursive, removeAttachListener, removeDetachListener, removeExtension, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler

Methods inherited from interface com.vaadin.shared.Connector

getConnectorId

Methods inherited from interface com.vaadin.server.Sizeable

getHeight, getHeightUnits, getWidth, getWidthUnits, setHeight, setHeight, setHeightUndefined, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthUndefined

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

leftGrid

protected final com.vaadin.ui.Grid<T> leftGrid

rightGrid

protected final com.vaadin.ui.Grid<T> rightGrid

leftGridDataProvider

protected com.vaadin.data.provider.ListDataProvider<T> leftGridDataProvider

rightGridDataProvider

protected com.vaadin.data.provider.ListDataProvider<T> rightGridDataProvider

Constructor Detail

TwinColGrid

public TwinColGrid()

Constructs a new TwinColGrid with an empty ListDataProvider.

TwinColGrid

public TwinColGrid(com.vaadin.data.provider.ListDataProvider<T> dataProvider)

Constructs a new TwinColGrid with data provider for options.

Parameters:

dataProvider - the data provider, not null

TwinColGrid

public TwinColGrid(Collection<T> options)

Constructs a new TwinColGrid with the given options.

Parameters:

options - the options, cannot be null

TwinColGrid

public TwinColGrid(String caption,
                   com.vaadin.data.provider.ListDataProvider<T> dataProvider)

Constructs a new TwinColGrid with caption and data provider for options.

Parameters:

caption - the caption to set, can be null

dataProvider - the data provider, not null

TwinColGrid

public TwinColGrid(String caption,
                   Collection<T> options)

Constructs a new TwinColGrid with caption and the given options.

Parameters:

caption - the caption to set, can be null

options - the options, cannot be null

Method Detail

setItems

public void setItems(Collection<T> items)

setItems

public void setItems(Stream<T> items)

getRows

public int getRows()

Returns the number of rows in the selects.

Returns:

the number of rows visible

withRows

public TwinColGrid<T> withRows(int rows)

Sets the number of rows in the selects. If the number of rows is set to 0 or less, the actual number of displayed rows is determined implicitly by the selects.

If a height if set (using AbstractComponent.setHeight(String) or Sizeable.setHeight(float, Unit)) it overrides the number of rows. Leave the height undefined to use this method.

Parameters:

rows - the number of rows to set.

withRightColumnCaption

public TwinColGrid<T> withRightColumnCaption(String rightColumnCaption)

Sets the text shown above the right column. null clears the caption.

Parameters:

rightColumnCaption - The text to show, null to clear

addColumn

public <V> TwinColGrid<T> addColumn(com.vaadin.data.ValueProvider<T,V> valueProvider,
                                    String caption)

Adds a new text column to this Grid with a value provider. The column will use a TextRenderer. The value is converted to a String using Object.toString(). In-memory sorting will use the natural ordering of elements if they are mutually comparable and otherwise fall back to comparing the string representations of the values.

Parameters:

valueProvider - the value provider

Returns:

the new column

showAddAllButton

public TwinColGrid<T> showAddAllButton()

showRemoveAllButton

public TwinColGrid<T> showRemoveAllButton()

withSizeFull

public TwinColGrid<T> withSizeFull()

withDragAndDropSupport

public TwinColGrid<T> withDragAndDropSupport()

Adds drag n drop support between grids.

Returns:

getRightColumnCaption

public String getRightColumnCaption()

Returns the text shown above the right column.

Returns:

The text shown or null if not set.

withLeftColumnCaption

public TwinColGrid<T> withLeftColumnCaption(String leftColumnCaption)

Sets the text shown above the left column. null clears the caption.

Parameters:

leftColumnCaption - The text to show, null to clear

getLeftColumnCaption

public String getLeftColumnCaption()

Returns the text shown above the left column.

Returns:

The text shown or null if not set.

setValue

public void setValue(Set<T> value)

Specified by:

setValue in interface com.vaadin.data.HasValue<Set<T>>

getValue

public Set<T> getValue()

Returns the current value of this object which is an immutable set of the currently selected items.

Specified by:

getValue in interface com.vaadin.data.HasValue<Set<T>>

Returns:

the current selection

addValueChangeListener

public com.vaadin.shared.Registration addValueChangeListener(com.vaadin.data.HasValue.ValueChangeListener<Set<T>> listener)

Specified by:

addValueChangeListener in interface com.vaadin.data.HasValue<Set<T>>

isReadOnly

public boolean isReadOnly()

Specified by:

isReadOnly in interface com.vaadin.data.HasValue<Set<T>>

Overrides:

isReadOnly in class com.vaadin.ui.AbstractComponent

isRequiredIndicatorVisible

public boolean isRequiredIndicatorVisible()

Specified by:

isRequiredIndicatorVisible in interface com.vaadin.data.HasValue<Set<T>>

Overrides:

isRequiredIndicatorVisible in class com.vaadin.ui.AbstractComponent

setReadOnly

public void setReadOnly(boolean readOnly)

Specified by:

setReadOnly in interface com.vaadin.data.HasValue<Set<T>>

Overrides:

setReadOnly in class com.vaadin.ui.AbstractComponent

setRequiredIndicatorVisible

public void setRequiredIndicatorVisible(boolean visible)

Specified by:

setRequiredIndicatorVisible in interface com.vaadin.data.HasValue<Set<T>>

Overrides:

setRequiredIndicatorVisible in class com.vaadin.ui.AbstractComponent

addLeftGridSelectionListener

public com.vaadin.shared.Registration addLeftGridSelectionListener(com.vaadin.event.selection.SelectionListener<T> listener)

addRightGridSelectionListener

public com.vaadin.shared.Registration addRightGridSelectionListener(com.vaadin.event.selection.SelectionListener<T> listener)