Package com.flowingcode.vaadin.addons.twincolgrid

Class FilterableTwinColumn<T>

java.lang.Object

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

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

public class FilterableTwinColumn<T>
extends TwinColumn<T>

Fluent helper object that delegates setters on both columns.

Constructor Summary

Constructors

Constructor	Description
FilterableTwinColumn(Grid.Column<T> availableColumn, Grid.Column<T> selectionColumn)

Method Summary

Modifier and Type	Method	Description
FilterableTwinColumn<T>	setAutoWidth(boolean autoWidth)	Enables or disables automatic width for the columns.
FilterableTwinColumn<T>	setClassNameGenerator(SerializableFunction<T,String> classNameGenerator)	Sets the function that is used for generating CSS class names for cells in both columns.
FilterableTwinColumn<T>	setClearButtonVisible(boolean clearButtonVisible)	Set to false to hide the clear button which clears the filter text field.
<V extends Comparable<? super V>> TwinColumn<T>	setComparator(ValueProvider<T,V> keyExtractor)	Sets a comparator to use with in-memory sorting with both columns based on the return type of the given ValueProvider.
FilterableTwinColumn<T>	setComparator(Comparator<T> comparator)	Sets a comparator to use with in-memory sorting with both columns.
FilterableTwinColumn<T>	setFilterPlaceholder(String filterPlaceholder)	Set the placeholder of the filter text field on both columns.
FilterableTwinColumn<T>	setFlexGrow(int flexGrow)	Sets the flex grow ratio for the columns.
FilterableTwinColumn<T>	setFooter(String labelText)	Sets a footer text to both columns.
FilterableTwinColumn<T>	setFooter(Supplier<Component> footerComponentSupplier)	Sets a footer component to both columns.
FilterableTwinColumn<T>	setHeader(String labelText)	Sets a header text to both columns.
FilterableTwinColumn<T>	setHeader(Supplier<Component> footerComponentSupplier)	Sets a header component to both columns.
FilterableTwinColumn<T>	setKey(String key)	Sets the user-defined identifier to map the columns.
FilterableTwinColumn<T>	setSortable(boolean sortable)	Sets whether the user can sort the columns or not.
FilterableTwinColumn<T>	setSortOrderProvider(SortOrderProvider provider)	Sets the sort orders when sorting the columns.
FilterableTwinColumn<T>	setSortProperty(String... properties)	Sets strings describing back end properties to be used when sorting the columns.
FilterableTwinColumn<T>	setWidth(String width)	Sets the width of the columns as a CSS-string.

Methods inherited from class java.lang.Object

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

Constructor Details

FilterableTwinColumn

public FilterableTwinColumn(Grid.Column<T> availableColumn,
 Grid.Column<T> selectionColumn)

Method Details

setFilterPlaceholder

public FilterableTwinColumn<T> setFilterPlaceholder(String filterPlaceholder)

Set the placeholder of the filter text field on both columns.

See Also:

• TextField.setPlaceholder(String)

setClearButtonVisible

public FilterableTwinColumn<T> setClearButtonVisible(boolean clearButtonVisible)

Set to false to hide the clear button which clears the filter text field.

See Also:

• TextField.setClearButtonVisible(boolean)

setWidth

public FilterableTwinColumn<T> setWidth(String width)

Description copied from class: TwinColumn

Sets the width of the columns as a CSS-string.

Overrides:

setWidth in class TwinColumn<T>

Parameters:

width - the width to set both columns to, as a CSS-string, not null

Returns:

this instance, for method chaining

See Also:

• Grid.Column.setWidth(String)

setFlexGrow

public FilterableTwinColumn<T> setFlexGrow(int flexGrow)

Description copied from class: TwinColumn

Sets the flex grow ratio for the columns. When set to 0, column width is fixed.

Overrides:

setFlexGrow in class TwinColumn<T>

Parameters:

flexGrow - the flex grow ratio

Returns:

this instance, for method chaining

See Also:

• Grid.Column.setFlexGrow(int)

setAutoWidth

public FilterableTwinColumn<T> setAutoWidth(boolean autoWidth)

Description copied from class: TwinColumn

Enables or disables automatic width for the columns.

Overrides:

setAutoWidth in class TwinColumn<T>

Parameters:

autoWidth - whether to enable or disable automatic width on both columns

Returns:

this instance, for method chaining

See Also:

• Grid.Column.setAutoWidth(boolean)

setKey

public FilterableTwinColumn<T> setKey(String key)

Description copied from class: TwinColumn

Sets the user-defined identifier to map the columns.

Overrides:

setKey in class TwinColumn<T>

Parameters:

key - the identifier key, can't be null

Returns:

this instance, for method chaining

See Also:

• Grid.Column.setKey(String)

setComparator

public FilterableTwinColumn<T> setComparator(Comparator<T> comparator)

Description copied from class: TwinColumn

Sets a comparator to use with in-memory sorting with both columns.

Overrides:

setComparator in class TwinColumn<T>

Parameters:

comparator - the comparator to use when sorting data in both columns

Returns:

this instance, for method chaining

See Also:

• Grid.Column.setComparator(Comparator)

setComparator

public <V extends Comparable<? super V>>
TwinColumn<T> setComparator(ValueProvider<T,V> keyExtractor)

Description copied from class: TwinColumn

Sets a comparator to use with in-memory sorting with both columns based on the return type of the given ValueProvider.

Overrides:

setComparator in class TwinColumn<T>

Type Parameters:

V - the value of the column

Parameters:

keyExtractor - the value provider used to extract the Comparable sort key

Returns:

this instance, for method chaining

See Also:

• Grid.Column.setComparator(ValueProvider)
• Comparator.comparing(java.util.function.Function)

setSortProperty

public FilterableTwinColumn<T> setSortProperty(String... properties)

Description copied from class: TwinColumn

Sets strings describing back end properties to be used when sorting the columns.

Overrides:

setSortProperty in class TwinColumn<T>

Parameters:

properties - the array of strings describing backend properties

Returns:

this instance, for method chaining

See Also:

• Grid.Column.setSortProperty(String...)

setSortOrderProvider

public FilterableTwinColumn<T> setSortOrderProvider(SortOrderProvider provider)

Description copied from class: TwinColumn

Sets the sort orders when sorting the columns. The sort order provider is a function which provides QuerySortOrder objects to describe how to sort by the columns.

Overrides:

setSortOrderProvider in class TwinColumn<T>

Parameters:

provider - the function to use when generating sort orders with the given direction

Returns:

this instance, for method chaining

See Also:

• Grid.Column.setSortOrderProvider(SortOrderProvider)

setSortable

public FilterableTwinColumn<T> setSortable(boolean sortable)

Description copied from class: TwinColumn

Sets whether the user can sort the columns or not.

Overrides:

setSortable in class TwinColumn<T>

Parameters:

sortable - true if the columns can be sorted by the user; false if not

Returns:

this instance, for method chaining

See Also:

• Grid.Column.setSortable(boolean)

setHeader

public FilterableTwinColumn<T> setHeader(String labelText)

Description copied from class: TwinColumn

Sets a header text to both columns.

Overrides:

setHeader in class TwinColumn<T>

Parameters:

labelText - the text to be shown at the columns headers

Returns:

this instance, for method chaining

See Also:

• Grid.Column.setHeader(String)

setFooter

public FilterableTwinColumn<T> setFooter(String labelText)

Description copied from class: TwinColumn

Sets a footer text to both columns.

Overrides:

setFooter in class TwinColumn<T>

Parameters:

labelText - the text to be shown at the columns footers

Returns:

this instance, for method chaining

See Also:

• Grid.Column.setFooter(String)

setHeader

public FilterableTwinColumn<T> setHeader(Supplier<Component> footerComponentSupplier)

Description copied from class: TwinColumn

Sets a header component to both columns.

Overrides:

setHeader in class TwinColumn<T>

Parameters:

footerComponentSupplier - a supplier that instantiates the component to be used in the header of each column

Returns:

this instance, for method chaining

See Also:

• Grid.Column.setHeader(String)

setFooter

public FilterableTwinColumn<T> setFooter(Supplier<Component> footerComponentSupplier)

Description copied from class: TwinColumn

Sets a footer component to both columns.

Overrides:

setFooter in class TwinColumn<T>

Parameters:

footerComponentSupplier - a supplier that instantiates the component to be used in the footer of each column

Returns:

this instance, for method chaining

See Also:

• Grid.Column.setFooter(String)

setClassNameGenerator

public FilterableTwinColumn<T> setClassNameGenerator(SerializableFunction<T,String> classNameGenerator)

Description copied from class: TwinColumn

Sets the function that is used for generating CSS class names for cells in both columns.

Overrides:

setClassNameGenerator in class TwinColumn<T>

Parameters:

classNameGenerator - the class name generator to set, not null

Returns:

this instance, for method chaining

See Also:

• Grid.Column.setClassNameGenerator(SerializableFunction)