com.flowingcode.vaadin.addons.twincolgrid

Class TwinColGrid<T>

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.orderedlayout.VerticalLayout

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

All Implemented Interfaces:

com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.ClickNotifier<com.vaadin.flow.component.orderedlayout.VerticalLayout>, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.HasComponents, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasEnabled, com.vaadin.flow.component.HasOrderedComponents<com.vaadin.flow.component.orderedlayout.VerticalLayout>, com.vaadin.flow.component.HasSize, com.vaadin.flow.component.HasStyle, com.vaadin.flow.component.HasValue<com.vaadin.flow.component.HasValue.ValueChangeEvent<Set<T>>,Set<T>>, com.vaadin.flow.component.orderedlayout.FlexComponent<com.vaadin.flow.component.orderedlayout.VerticalLayout>, com.vaadin.flow.component.orderedlayout.ThemableLayout, Serializable

public final class TwinColGrid<T>
extends com.vaadin.flow.component.orderedlayout.VerticalLayout
implements com.vaadin.flow.component.HasValue<com.vaadin.flow.component.HasValue.ValueChangeEvent<Set<T>>,Set<T>>, com.vaadin.flow.component.HasComponents, com.vaadin.flow.component.HasSize

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.vaadin.flow.component.HasValue

com.vaadin.flow.component.HasValue.ValueChangeEvent<V>, com.vaadin.flow.component.HasValue.ValueChangeListener<E extends com.vaadin.flow.component.HasValue.ValueChangeEvent<?>>

Nested classes/interfaces inherited from interface com.vaadin.flow.component.orderedlayout.FlexComponent

com.vaadin.flow.component.orderedlayout.FlexComponent.Alignment, com.vaadin.flow.component.orderedlayout.FlexComponent.JustifyContentMode

Field Summary

Fields

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

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(Collection<T> options, String caption) Constructs a new TwinColGrid with caption and the given options.
TwinColGrid(com.vaadin.flow.data.provider.ListDataProvider<T> dataProvider, String caption) Constructs a new TwinColGrid with data provider for options.

Method Summary

Modifier and Type	Method and Description
TwinColGrid<T>	addColumn(com.vaadin.flow.component.ItemLabelGenerator<T> itemLabelGenerator, String header) Adds a new text column to this Grid with a value provider.
void	addLeftGridSelectionListener(com.vaadin.flow.data.selection.SelectionListener<com.vaadin.flow.component.grid.Grid<T>,T> listener)
void	addRightGridSelectionListener(com.vaadin.flow.data.selection.SelectionListener<com.vaadin.flow.component.grid.Grid<T>,T> listener)
com.vaadin.flow.shared.Registration	addValueChangeListener(com.vaadin.flow.component.HasValue.ValueChangeListener<? super com.vaadin.flow.component.HasValue.ValueChangeEvent<Set<T>>> listener)
String	getLeftColumnCaption() Returns the text shown above the left column.
String	getRightColumnCaption() Returns the text shown above the right column.
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>	withDragAndDropSupport() Adds drag n drop support between grids.
TwinColGrid<T>	withLeftColumnCaption(String leftColumnCaption) Sets the text shown above the left column.
TwinColGrid<T>	withoutAddAllButton()
TwinColGrid<T>	withoutAddButton()
TwinColGrid<T>	withoutRemoveAllButton()
TwinColGrid<T>	withoutRemoveButton()
TwinColGrid<T>	withRightColumnCaption(String rightColumnCaption) Sets the text shown above the right column.
TwinColGrid<T>	withSizeFull()

Methods inherited from class com.vaadin.flow.component.orderedlayout.VerticalLayout

addAndExpand, getAlignItems, getAlignSelf, getDefaultHorizontalComponentAlignment, getHorizontalComponentAlignment, setAlignItems, setAlignSelf, setDefaultHorizontalComponentAlignment, setHorizontalComponentAlignment, setPadding, setSpacing

Methods inherited from class com.vaadin.flow.component.Component

addListener, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getLocale, getParent, getTranslation, getTranslation, getUI, hasListener, isTemplateMapped, isVisible, onAttach, onDetach, onEnabledStateChanged, set, setElement, setId, setVisible

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vaadin.flow.component.HasValue

clear, getEmptyValue, getOptionalValue, isEmpty

Methods inherited from interface com.vaadin.flow.component.HasComponents

add, add, addComponentAsFirst, addComponentAtIndex, remove, removeAll

Methods inherited from interface com.vaadin.flow.component.HasEnabled

isEnabled, setEnabled

Methods inherited from interface com.vaadin.flow.component.HasElement

getElement

Methods inherited from interface com.vaadin.flow.component.HasSize

getHeight, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getWidth, setHeight, setHeightFull, setMaxHeight, setMaxWidth, setMinHeight, setMinWidth, setSizeFull, setSizeUndefined, setWidth, setWidthFull

Methods inherited from interface com.vaadin.flow.component.orderedlayout.ThemableLayout

getBoxSizing, getThemeList, isMargin, isPadding, isSpacing, setBoxSizing, setMargin

Methods inherited from interface com.vaadin.flow.component.orderedlayout.FlexComponent

expand, getFlexGrow, getJustifyContentMode, replace, setFlexGrow, setJustifyContentMode

Methods inherited from interface com.vaadin.flow.component.HasOrderedComponents

getComponentAt, getComponentCount, indexOf

Methods inherited from interface com.vaadin.flow.component.HasStyle

addClassName, addClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassName

Methods inherited from interface com.vaadin.flow.component.ClickNotifier

addClickListener, addClickShortcut

Methods inherited from interface com.vaadin.flow.component.AttachNotifier

addAttachListener

Methods inherited from interface com.vaadin.flow.component.DetachNotifier

addDetachListener

Field Detail

leftGrid

protected final com.vaadin.flow.component.grid.Grid<T> leftGrid

rightGrid

protected final com.vaadin.flow.component.grid.Grid<T> rightGrid

leftGridDataProvider

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

rightGridDataProvider

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

Constructor Detail

TwinColGrid

public TwinColGrid()

Constructs a new TwinColGrid with an empty ListDataProvider.

TwinColGrid

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

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(Collection<T> options,
                   String caption)

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)

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

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

addColumn

public TwinColGrid<T> addColumn(com.vaadin.flow.component.ItemLabelGenerator<T> itemLabelGenerator,
                                String header)

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

withoutAddAllButton

public TwinColGrid<T> withoutAddAllButton()

withoutRemoveAllButton

public TwinColGrid<T> withoutRemoveAllButton()

withoutAddButton

public TwinColGrid<T> withoutAddButton()

withoutRemoveButton

public TwinColGrid<T> withoutRemoveButton()

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.

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.flow.component.HasValue<com.vaadin.flow.component.HasValue.ValueChangeEvent<Set<T>>,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.flow.component.HasValue<com.vaadin.flow.component.HasValue.ValueChangeEvent<Set<T>>,Set<T>>

Returns:

the current selection

addValueChangeListener

public com.vaadin.flow.shared.Registration addValueChangeListener(com.vaadin.flow.component.HasValue.ValueChangeListener<? super com.vaadin.flow.component.HasValue.ValueChangeEvent<Set<T>>> listener)

Specified by:

addValueChangeListener in interface com.vaadin.flow.component.HasValue<com.vaadin.flow.component.HasValue.ValueChangeEvent<Set<T>>,Set<T>>

isReadOnly

public boolean isReadOnly()

Specified by:

isReadOnly in interface com.vaadin.flow.component.HasValue<com.vaadin.flow.component.HasValue.ValueChangeEvent<Set<T>>,Set<T>>

isRequiredIndicatorVisible

public boolean isRequiredIndicatorVisible()

Specified by:

isRequiredIndicatorVisible in interface com.vaadin.flow.component.HasValue<com.vaadin.flow.component.HasValue.ValueChangeEvent<Set<T>>,Set<T>>

setReadOnly

public void setReadOnly(boolean readOnly)

Specified by:

setReadOnly in interface com.vaadin.flow.component.HasValue<com.vaadin.flow.component.HasValue.ValueChangeEvent<Set<T>>,Set<T>>

setRequiredIndicatorVisible

public void setRequiredIndicatorVisible(boolean visible)

Specified by:

setRequiredIndicatorVisible in interface com.vaadin.flow.component.HasValue<com.vaadin.flow.component.HasValue.ValueChangeEvent<Set<T>>,Set<T>>

addLeftGridSelectionListener

public void addLeftGridSelectionListener(com.vaadin.flow.data.selection.SelectionListener<com.vaadin.flow.component.grid.Grid<T>,T> listener)

addRightGridSelectionListener

public void addRightGridSelectionListener(com.vaadin.flow.data.selection.SelectionListener<com.vaadin.flow.component.grid.Grid<T>,T> listener)