Package com.amalgamasimulation.desktop.ui.builders

Class AutoCompleteTextEditingSupport.Builder<T,E,R extends IEditableColumn<T,E,R>>

java.lang.Object

com.amalgamasimulation.desktop.ui.builders.AutoCompleteTextEditingSupport.Builder<T,E,R>

Type Parameters:

T - type of row value

E - type of column value (cell value)

R - column type

All Implemented Interfaces:

AutoCompleteTextEditingSupport.ButtonListenerBuilder<T,E,R>, AutoCompleteTextEditingSupport.ElementsBuilder<T,E,R>, AutoCompleteTextEditingSupport.FinalBuilder<T,E,R>, AutoCompleteTextEditingSupport.NameBuilder<T,E,R>

Enclosing class:

AutoCompleteTextEditingSupport

public static class AutoCompleteTextEditingSupport.Builder<T,E,R extends IEditableColumn<T,E,R>>
extends Object
implements AutoCompleteTextEditingSupport.ElementsBuilder<T,E,R>, AutoCompleteTextEditingSupport.NameBuilder<T,E,R>, AutoCompleteTextEditingSupport.FinalBuilder<T,E,R>, AutoCompleteTextEditingSupport.ButtonListenerBuilder<T,E,R>

A builder class to set up the properties of an auto-complete text editing support. Instances of this class are created by EditableColumn objects.

The build() method is used to actually set the properties to the column.

Field Summary

Fields

Modifier and Type	Field	Description
protected final R	columnDescriptor
protected AutoCompleteTextEditingSupport<T,E>	editingSupport

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Builder(R columnDescriptor)

Method Summary

Modifier and Type	Method	Description
R	build()	This is the finalization method.
AutoCompleteTextEditingSupport.FinalBuilder<T,E,R>	canEdit(Predicate<T> canEdit)	Set function that returns a value that indicates whether the cell can be edited
AutoCompleteTextEditingSupport.FinalBuilder<T,E,R>	comparator(Comparator<E> comparator)	Add a comparator that is used to sort combobox values.
static <T1, E1, R1 extends IEditableColumn<T1, E1, R1>> AutoCompleteTextEditingSupport.ElementsBuilder<T1,E1,R1>	create(R1 columnDescriptor)
AutoCompleteTextEditingSupport.NameBuilder<T,E,R>	elements(org.eclipse.core.databinding.observable.list.IObservableList<E> elements)	Set the elements to be shown in the combobox
AutoCompleteTextEditingSupport.FinalBuilder<T,E,R>	enableNullElement(String notSetLiteral)	Add an element on top of other elements in the combobox to clear the table cell value.
AutoCompleteTextEditingSupport.FinalBuilder<T,E,R>	filter(BiPredicate<T,E> filter)	Add a filter.
AutoCompleteTextEditingSupport.FinalBuilder<T,E,R>	filter(Predicate<E> filter)	Add a filter.
AutoCompleteTextEditingSupport.ButtonListenerBuilder<T,E,R>	format(Function<E,String> nameExtractor)	Set up the combobox elements naming.
AutoCompleteTextEditingSupport.FinalBuilder<T,E,R>	handler(BiConsumer<T,E> listener)	Set function that will be executed after losing focus on the combo box editor or after pressing the Enter button
AutoCompleteTextEditingSupport.FinalBuilder<T,E,R>	strategy(ValidationStrategy<E,String> strategy)	Set a strategy that firstly validates the entered value before placing it in the object, and secondly processes the value from the object before displaying it in the editor.

Methods inherited from class java.lang.Object

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

Field Details

columnDescriptor

protected final R extends IEditableColumn<T,E,R> columnDescriptor

editingSupport

protected AutoCompleteTextEditingSupport<T,E> editingSupport

Constructor Details

Builder

protected Builder(R columnDescriptor)

Method Details

create

public static <T1,
E1,
R1 extends IEditableColumn<T1,
E1,
R1>>
AutoCompleteTextEditingSupport.ElementsBuilder<T1,E1,R1> create(R1 columnDescriptor)

elements

public AutoCompleteTextEditingSupport.NameBuilder<T,E,R> elements(org.eclipse.core.databinding.observable.list.IObservableList<E> elements)

Description copied from interface: AutoCompleteTextEditingSupport.ElementsBuilder

Set the elements to be shown in the combobox

Specified by:

elements in interface AutoCompleteTextEditingSupport.ElementsBuilder<T,E,R extends IEditableColumn<T,E,R>>

Parameters:

elements - list of elements

Returns:

builder object

format

public AutoCompleteTextEditingSupport.ButtonListenerBuilder<T,E,R> format(Function<E,String> nameExtractor)

Description copied from interface: AutoCompleteTextEditingSupport.NameBuilder

Set up the combobox elements naming. The name extractor.

Specified by:

format in interface AutoCompleteTextEditingSupport.NameBuilder<T,E,R extends IEditableColumn<T,E,R>>

Parameters:

nameExtractor - function that converts a combobox element to a String displayed in the combobox

Returns:

builder object

handler

public AutoCompleteTextEditingSupport.FinalBuilder<T,E,R> handler(BiConsumer<T,E> listener)

Description copied from interface: AutoCompleteTextEditingSupport.ButtonListenerBuilder

Set function that will be executed after losing focus on the combo box editor or after pressing the Enter button

Specified by:

handler in interface AutoCompleteTextEditingSupport.ButtonListenerBuilder<T,E,R extends IEditableColumn<T,E,R>>

Parameters:

listener -

Returns:

builder object

strategy

public AutoCompleteTextEditingSupport.FinalBuilder<T,E,R> strategy(ValidationStrategy<E,String> strategy)

Description copied from interface: AutoCompleteTextEditingSupport.FinalBuilder

Set a strategy that firstly validates the entered value before placing it in the object, and secondly processes the value from the object before displaying it in the editor. The default strategy checks the input value against the value extract from the elements using the nameExtractor.

Specified by:

strategy in interface AutoCompleteTextEditingSupport.FinalBuilder<T,E,R extends IEditableColumn<T,E,R>>

Parameters:

strategy -

Returns:

builder object

enableNullElement

public AutoCompleteTextEditingSupport.FinalBuilder<T,E,R> enableNullElement(String notSetLiteral)

Description copied from interface: AutoCompleteTextEditingSupport.FinalBuilder

Add an element on top of other elements in the combobox to clear the table cell value.

Specified by:

enableNullElement in interface AutoCompleteTextEditingSupport.FinalBuilder<T,E,R extends IEditableColumn<T,E,R>>

Parameters:

notSetLiteral - the label of the new combobox element that clears the cell value (typical values are: "", etc.)

Returns:

the builder object

filter

public AutoCompleteTextEditingSupport.FinalBuilder<T,E,R> filter(Predicate<E> filter)

Description copied from interface: AutoCompleteTextEditingSupport.FinalBuilder

Add a filter. Only matching items will be displayed in the combobox.
Note that there may be at most one filter. If you call this method several times, only the last method call will be effective.

Specified by:

filter in interface AutoCompleteTextEditingSupport.FinalBuilder<T,E,R extends IEditableColumn<T,E,R>>

filter

public AutoCompleteTextEditingSupport.FinalBuilder<T,E,R> filter(BiPredicate<T,E> filter)

Description copied from interface: AutoCompleteTextEditingSupport.FinalBuilder

Add a filter. Only matching items will be displayed in the combobox.
Note that there may be at most one filter. If you call this method several times, only the last method call will be effective.

Specified by:

filter in interface AutoCompleteTextEditingSupport.FinalBuilder<T,E,R extends IEditableColumn<T,E,R>>

comparator

public AutoCompleteTextEditingSupport.FinalBuilder<T,E,R> comparator(Comparator<E> comparator)

Description copied from interface: AutoCompleteTextEditingSupport.FinalBuilder

Add a comparator that is used to sort combobox values.
Note that there may be at most one comparator. If you call this method several times, only the last method call will be effective.

Specified by:

comparator in interface AutoCompleteTextEditingSupport.FinalBuilder<T,E,R extends IEditableColumn<T,E,R>>

canEdit

public AutoCompleteTextEditingSupport.FinalBuilder<T,E,R> canEdit(Predicate<T> canEdit)

Description copied from interface: AutoCompleteTextEditingSupport.FinalBuilder

Set function that returns a value that indicates whether the cell can be edited

Specified by:

canEdit in interface AutoCompleteTextEditingSupport.FinalBuilder<T,E,R extends IEditableColumn<T,E,R>>

Parameters:

canEdit -

Returns:

builder object

build

public R build()

Description copied from interface: AutoCompleteTextEditingSupport.FinalBuilder

This is the finalization method. Call this method to install the auto-complete combobox editing support on a table column.

Specified by:

build in interface AutoCompleteTextEditingSupport.FinalBuilder<T,E,R extends IEditableColumn<T,E,R>>