Package com.amalgamasimulation.desktop.ui.builders

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

java.lang.Object

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

Type Parameters:

T - type of row value

E - type of column value (cell value)

R - column type

All Implemented Interfaces:

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

Enclosing class:

EMFEnumComboEditingSupport

public static class EMFEnumComboEditingSupport.Builder<T,E,R extends IEMFColumn<T,E,R>>
extends Object
implements EMFEnumComboEditingSupport.ElementsBuilder<T,E,R>, EMFEnumComboEditingSupport.EditedFeatureBuilder<T,E,R>, EMFEnumComboEditingSupport.NameBuilder<T,E,R>, EMFEnumComboEditingSupport.FinalBuilder<T,E,R>

A builder class to set up the properties of an enum combobox editing support. Instances of this class are created by EmfColumn objects.

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

Method Summary

Modifier and Type	Method	Description
R	build()	This is the finalization method.
EMFEnumComboEditingSupport.FinalBuilder<T,E,R>	canEdit(Predicate<T> canEdit)	Set function that returns a value that indicates whether the cell can be edited
EMFEnumComboEditingSupport.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>> EMFEnumComboEditingSupport.ElementsBuilder<T1,E1,R1>	create(R1 columnDescriptor)
EMFEnumComboEditingSupport.EditedFeatureBuilder<T,E,R>	elements(E[] elements)	Set the elements to be shown in the combobox
EMFEnumComboEditingSupport.FinalBuilder<T,E,R>	enableNullElement(String notSetLiteral)	Add an element on top of other elements in the combobox to clear the table cell value.
EMFEnumComboEditingSupport.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 )
EMFEnumComboEditingSupport.FinalBuilder<T,E,R>	filter(BiPredicate<T,E> filter)	Add a filter.
EMFEnumComboEditingSupport.FinalBuilder<T,E,R>	filter(Predicate<E> filter)	Add a filter.
EMFEnumComboEditingSupport.FinalBuilder<T,E,R>	format(Function<E,String> nameExtractor)	Set up the combobox elements naming.
EMFEnumComboEditingSupport.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
EMFEnumComboEditingSupport.FinalBuilder<T,E,R>	maxComboBoxElementsCount(int maxComboBoxElementsCount)	Set up a maxComboBoxElementsCount that limits the number of values in the combo box

Methods inherited from class java.lang.Object

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

Method Details

create

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

elements

public EMFEnumComboEditingSupport.EditedFeatureBuilder<T,E,R> elements(E[] elements)

Description copied from interface: EMFEnumComboEditingSupport.ElementsBuilder

Set the elements to be shown in the combobox

Specified by:

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

Parameters:

elements - list of elements

Returns:

builder object

feature

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

Description copied from interface: EMFEnumComboEditingSupport.EditedFeatureBuilder

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

Specified by:

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

Parameters:

feature - structural feature

Returns:

builder object

format

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

Description copied from interface: EMFEnumComboEditingSupport.NameBuilder

Set up the combobox elements naming. The name extractor.

Specified by:

format in interface EMFEnumComboEditingSupport.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

enableNullElement

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

Description copied from interface: EMFEnumComboEditingSupport.FinalBuilder

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

Specified by:

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

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

filter

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

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

comparator

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

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

maxComboBoxElementsCount

public EMFEnumComboEditingSupport.FinalBuilder<T,E,R> maxComboBoxElementsCount(int maxComboBoxElementsCount)

Description copied from interface: EMFEnumComboEditingSupport.FinalBuilder

Set up a maxComboBoxElementsCount that limits the number of values in the combo box

Specified by:

maxComboBoxElementsCount in interface EMFEnumComboEditingSupport.FinalBuilder<T,E,R extends IEMFColumn<T,E,R>>

Parameters:

maxComboBoxElementsCount - limitation on the number of elements in the combo box

handler

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

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

Parameters:

listener -

Returns:

builder object

canEdit

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

Description copied from interface: EMFEnumComboEditingSupport.FinalBuilder

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

Specified by:

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

Parameters:

canEdit -

Returns:

builder object

build

public R build()

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