Package com.amalgamasimulation.desktop.ui.builders

Class EMFAutoCompleteTextEditingSupport.Builder<T,E,R extends IEMFColumn<T,E,R>>

java.lang.Object

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

Type Parameters:

T - type of row value

E - type of column value (cell value)

R - column type

All Implemented Interfaces:

EMFAutoCompleteTextEditingSupport.EditedFeatureBuilder<T,E,R>, EMFAutoCompleteTextEditingSupport.ElementsBuilder<T,E,R>, EMFAutoCompleteTextEditingSupport.FinalBuilder<T,E,R>, EMFAutoCompleteTextEditingSupport.NameBuilder<T,E,R>

Enclosing class:

EMFAutoCompleteTextEditingSupport

public static class EMFAutoCompleteTextEditingSupport.Builder<T,E,R extends IEMFColumn<T,E,R>>
extends Object
implements EMFAutoCompleteTextEditingSupport.ElementsBuilder<T,E,R>, EMFAutoCompleteTextEditingSupport.EditedFeatureBuilder<T,E,R>, EMFAutoCompleteTextEditingSupport.NameBuilder<T,E,R>, EMFAutoCompleteTextEditingSupport.FinalBuilder<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 EmfColumn 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 EMFAutoCompleteTextEditingSupport<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.
EMFAutoCompleteTextEditingSupport.FinalBuilder<T,E,R>	canEdit(Predicate<T> canEdit)	Set function that returns a value that indicates whether the cell can be edited
EMFAutoCompleteTextEditingSupport.FinalBuilder<T,E,R>	comparator(Comparator<E> comparator)	Add a comparator that is used to sort combobox values.
static <T1, E1, R1 extends IEMFColumn<T1, E1, R1>> EMFAutoCompleteTextEditingSupport.ElementsBuilder<T1,E1,R1>	create(R1 columnDescriptor)
EMFAutoCompleteTextEditingSupport.EditedFeatureBuilder<T,E,R>	elements(org.eclipse.core.databinding.observable.list.IObservableList<E> elements)	Set the elements to be shown in the combobox
EMFAutoCompleteTextEditingSupport.FinalBuilder<T,E,R>	enableNullElement(String notSetLiteral)	Add an element on top of other elements in the combobox to clear the table cell value.
EMFAutoCompleteTextEditingSupport.NameBuilder<T,E,R>	feature(org.eclipse.emf.ecore.EStructuralFeature feature)	Set the feature pointing to the field that is being edited (a field in template class )
EMFAutoCompleteTextEditingSupport.FinalBuilder<T,E,R>	filter(BiPredicate<T,E> filter)	Add a filter.
EMFAutoCompleteTextEditingSupport.FinalBuilder<T,E,R>	filter(Predicate<E> filter)	Add a filter.
EMFAutoCompleteTextEditingSupport.FinalBuilder<T,E,R>	format(Function<E,String> nameExtractor)	Set up the combobox elements naming.
EMFAutoCompleteTextEditingSupport.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
EMFAutoCompleteTextEditingSupport.FinalBuilder<T,E,R>	nameFeature(org.eclipse.emf.ecore.EStructuralFeature nameFeature)	Set up the combobox elements naming.
EMFAutoCompleteTextEditingSupport.FinalBuilder<T,E,R>	nameFeatures(org.eclipse.emf.ecore.EStructuralFeature nameFeature, org.eclipse.emf.ecore.EStructuralFeature idFeature)	Set up the combo box elements naming.
EMFAutoCompleteTextEditingSupport.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 IEMFColumn<T,E,R> columnDescriptor

editingSupport

protected EMFAutoCompleteTextEditingSupport<T,E> editingSupport

Constructor Details

Builder

protected Builder(R columnDescriptor)

Method Details

create

public static <T1,
E1,
R1 extends IEMFColumn<T1,
E1,
R1>>
EMFAutoCompleteTextEditingSupport.ElementsBuilder<T1,E1,R1> create(R1 columnDescriptor)

elements

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

Description copied from interface: EMFAutoCompleteTextEditingSupport.ElementsBuilder

Set the elements to be shown in the combobox

Specified by:

elements in interface EMFAutoCompleteTextEditingSupport.ElementsBuilder<T,E,R extends IEMFColumn<T,E,R>>

Parameters:

elements - list of elements

Returns:

builder object

feature

public EMFAutoCompleteTextEditingSupport.NameBuilder<T,E,R> feature(org.eclipse.emf.ecore.EStructuralFeature feature)

Description copied from interface: EMFAutoCompleteTextEditingSupport.EditedFeatureBuilder

Set the feature pointing to the field that is being edited (a field in template class )

Specified by:

feature in interface EMFAutoCompleteTextEditingSupport.EditedFeatureBuilder<T,E,R extends IEMFColumn<T,E,R>>

Parameters:

feature - structural feature

Returns:

builder object

nameFeature

public EMFAutoCompleteTextEditingSupport.FinalBuilder<T,E,R> nameFeature(org.eclipse.emf.ecore.EStructuralFeature nameFeature)

Description copied from interface: EMFAutoCompleteTextEditingSupport.NameBuilder

Set up the combobox elements naming. The structural feature value is used.

Specified by:

nameFeature in interface EMFAutoCompleteTextEditingSupport.NameBuilder<T,E,R extends IEMFColumn<T,E,R>>

Parameters:

nameFeature - feature of the combobox elements whose value will be displayed in the combobox

Returns:

builder object

nameFeatures

public EMFAutoCompleteTextEditingSupport.FinalBuilder<T,E,R> nameFeatures(org.eclipse.emf.ecore.EStructuralFeature nameFeature,
 org.eclipse.emf.ecore.EStructuralFeature idFeature)

Description copied from interface: EMFAutoCompleteTextEditingSupport.NameBuilder

Set up the combo box elements naming. The structural feature value is used.

Specified by:

nameFeatures in interface EMFAutoCompleteTextEditingSupport.NameBuilder<T,E,R extends IEMFColumn<T,E,R>>

Parameters:

idFeature - feature of the combo box elements whose value will be displayed in the combo box

Returns:

this object

format

public EMFAutoCompleteTextEditingSupport.FinalBuilder<T,E,R> format(Function<E,String> nameExtractor)

Description copied from interface: EMFAutoCompleteTextEditingSupport.NameBuilder

Set up the combobox elements naming. The name extractor.

Specified by:

format in interface EMFAutoCompleteTextEditingSupport.NameBuilder<T,E,R extends IEMFColumn<T,E,R>>

Parameters:

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

Returns:

builder object

handler

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

Description copied from interface: EMFAutoCompleteTextEditingSupport.FinalBuilder

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 EMFAutoCompleteTextEditingSupport.FinalBuilder<T,E,R extends IEMFColumn<T,E,R>>

Parameters:

listener -

Returns:

builder object

strategy

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

Description copied from interface: EMFAutoCompleteTextEditingSupport.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.

Specified by:

strategy in interface EMFAutoCompleteTextEditingSupport.FinalBuilder<T,E,R extends IEMFColumn<T,E,R>>

Parameters:

strategy -

Returns:

builder object

enableNullElement

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

Description copied from interface: EMFAutoCompleteTextEditingSupport.FinalBuilder

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

Specified by:

enableNullElement in interface EMFAutoCompleteTextEditingSupport.FinalBuilder<T,E,R extends IEMFColumn<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 EMFAutoCompleteTextEditingSupport.FinalBuilder<T,E,R> filter(Predicate<E> filter)

Description copied from interface: EMFAutoCompleteTextEditingSupport.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 EMFAutoCompleteTextEditingSupport.FinalBuilder<T,E,R extends IEMFColumn<T,E,R>>

filter

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

Description copied from interface: EMFAutoCompleteTextEditingSupport.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 EMFAutoCompleteTextEditingSupport.FinalBuilder<T,E,R extends IEMFColumn<T,E,R>>

comparator

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

Description copied from interface: EMFAutoCompleteTextEditingSupport.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 EMFAutoCompleteTextEditingSupport.FinalBuilder<T,E,R extends IEMFColumn<T,E,R>>

canEdit

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

Description copied from interface: EMFAutoCompleteTextEditingSupport.FinalBuilder

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

Specified by:

canEdit in interface EMFAutoCompleteTextEditingSupport.FinalBuilder<T,E,R extends IEMFColumn<T,E,R>>

Parameters:

canEdit -

Returns:

builder object

build

public R build()

Description copied from interface: EMFAutoCompleteTextEditingSupport.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 EMFAutoCompleteTextEditingSupport.FinalBuilder<T,E,R extends IEMFColumn<T,E,R>>