Package com.amalgamasimulation.desktop.ui.editor.builders

Class ContainerSpinnerSectionBuilder.Builder<T,V,R>

java.lang.Object

com.amalgamasimulation.desktop.ui.editor.builders.ContainerSpinnerSectionBuilder.Builder<T,V,R>

Type Parameters:

T - type of the object in the container

V - type of the value

R - step after the label, chosen by the factory

All Implemented Interfaces:

ContainerSpinnerSectionBuilder.ConverterBuilder<T,V>, ContainerSpinnerSectionBuilder.DigitsBuilder<T,V>, ContainerSpinnerSectionBuilder.DigitsRangeBuilder<T,V>, ContainerSpinnerSectionBuilder.FinalBuilder<T,V>, ContainerSpinnerSectionBuilder.HandlerBuilder<T,V>, ContainerSpinnerSectionBuilder.LabelBuilder<T,R>, ContainerSpinnerSectionBuilder.ParentBuilder<T,V,R>, ContainerSpinnerSectionBuilder.RangeBuilder<T,V>, ContainerSpinnerSectionBuilder.ValueExtractorBuilder<T,V,R>, ICanBeNullBuilder<ContainerSpinnerSectionBuilder.FinalBuilder<T,V>>, IContainerButtonBuilder<ContainerSpinnerSectionBuilder.FinalBuilder<T,V>>, IContainerHandlerBuilder<T,V,ContainerSpinnerSectionBuilder.FinalBuilder<T,V>>, IContainerLabelBuilder<T,R>, IContainerVisibleEnableBuilder<T,ContainerSpinnerSectionBuilder.FinalBuilder<T,V>>, IConverterBuilder<V,ContainerSpinnerSectionBuilder.DigitsRangeBuilder<T,V>>, ICreateBuilder<ISpinnerSection<V>>, IDigitsBuilder<ContainerSpinnerSectionBuilder.HandlerBuilder<T,V>>, ILabelBuilder<R>, ILabelPropertiesBuilder<ContainerSpinnerSectionBuilder.FinalBuilder<T,V>>, IParentBuilder<ContainerSpinnerSectionBuilder.ValueExtractorBuilder<T,V,R>>, ISpinnerPropertiesBuilder<V,ContainerSpinnerSectionBuilder.FinalBuilder<T,V>>, IToolTipBuilder<ContainerSpinnerSectionBuilder.FinalBuilder<T,V>>, IValidationBuilder<V,ContainerSpinnerSectionBuilder.FinalBuilder<T,V>>, IValueExtractorBuilder<T,V,ContainerSpinnerSectionBuilder.LabelBuilder<T,R>>

Enclosing class:

ContainerSpinnerSectionBuilder

public static class ContainerSpinnerSectionBuilder.Builder<T,V,R>
extends Object
implements ContainerSpinnerSectionBuilder.ParentBuilder<T,V,R>, ContainerSpinnerSectionBuilder.ValueExtractorBuilder<T,V,R>, ContainerSpinnerSectionBuilder.LabelBuilder<T,R>, ContainerSpinnerSectionBuilder.ConverterBuilder<T,V>, ContainerSpinnerSectionBuilder.RangeBuilder<T,V>, ContainerSpinnerSectionBuilder.DigitsRangeBuilder<T,V>, ContainerSpinnerSectionBuilder.DigitsBuilder<T,V>, ContainerSpinnerSectionBuilder.HandlerBuilder<T,V>, ContainerSpinnerSectionBuilder.FinalBuilder<T,V>

Builder that implements all steps.

Field Summary

Fields

Modifier and Type	Field	Description
protected BiConsumer<Integer,com.amalgamasimulation.desktop.ui.editor.sections.internal.Section>	actionAfterCreateSectionInProperty
protected int	index
protected final LabelProperties	labelProperties
protected final ContainerSpinnerSection<T,V>	section

Method Summary

Modifier and Type	Method	Description
ContainerSpinnerSectionBuilder.FinalBuilder<T,V>	addButton(IContainerButtonProperties buttonProperties)
protected void	addToPage()	Passes the created section to the property page.
ContainerSpinnerSectionBuilder.FinalBuilder<T,V>	canBeNull(BooleanSupplier canBeNull)
ContainerSpinnerSectionBuilder.DigitsRangeBuilder<T,V>	converter(ToDoubleFunction<V> toNumber, DoubleFunction<V> fromNumber)	Sets how a value is turned into the number of the spinner and back.
ISpinnerSection<V>	create()
static <T1, V1> ContainerSpinnerSectionBuilder.ParentBuilder<T1,V1,ContainerSpinnerSectionBuilder.ConverterBuilder<T1,V1>>	create(org.eclipse.core.databinding.observable.value.IObservableValue<T1> containerObservable)	Creates the builder of a section for a value of any type; the converter step turns it into a number.
static <T1> ContainerSpinnerSectionBuilder.ParentBuilder<T1,Double,ContainerSpinnerSectionBuilder.DigitsRangeBuilder<T1,Double>>	createDouble(org.eclipse.core.databinding.observable.value.IObservableValue<T1> containerObservable)	Creates the builder of a section for a Double.
static <T1> ContainerSpinnerSectionBuilder.ParentBuilder<T1,Integer,ContainerSpinnerSectionBuilder.RangeBuilder<T1,Integer>>	createInteger(org.eclipse.core.databinding.observable.value.IObservableValue<T1> containerObservable)	Creates the builder of a section for an Integer.
ContainerSpinnerSectionBuilder.HandlerBuilder<T,V>	digits(int digits)	Sets the number of digits after the point; the spinner shows the value rounded to them.
ContainerSpinnerSectionBuilder.FinalBuilder<T,V>	enabled(Predicate<T> enabled)
protected org.eclipse.core.databinding.observable.value.IObservableValue<T>	getContainer()	Returns the container of the section.
protected ContainerSpinnerSectionBuilder.FinalBuilder<T,V>	getThis()	Returns this builder as its final step.
ContainerSpinnerSectionBuilder.FinalBuilder<T,V>	handler(BiConsumer<T,V> handler)
R	label(String label)
R	label(Function<T,String> label)
ContainerSpinnerSectionBuilder.FinalBuilder<T,V>	labelProperties(LabelProperties labelProperties)
ContainerSpinnerSectionBuilder.ValueExtractorBuilder<T,V,R>	parent(org.eclipse.swt.widgets.Composite parent)
ContainerSpinnerSectionBuilder.Builder<T,V,R>	range(V minimum, V maximum)	Sets the smallest and the largest value.
protected void	setEnabled(Predicate<T> enabled)
protected void	setLabel(String label)
protected void	setLabel(Function<T,String> label)
protected void	setPage(org.eclipse.swt.widgets.Composite parent, BiConsumer<Integer,com.amalgamasimulation.desktop.ui.editor.sections.internal.Section> actionAfterCreateSectionInProperty, int index)	Places the section on a property page: the page gives the parent, the position and the action that adds the section.
protected void	setParent(org.eclipse.swt.widgets.Composite parent)
protected void	setVisible(Predicate<T> visible)
ContainerSpinnerSectionBuilder.FinalBuilder<T,V>	spinnerProperties(SpinnerProperties<V> spinnerProperties)	Sets the spinner settings.
ContainerSpinnerSectionBuilder.FinalBuilder<T,V>	toolTip(ToolTipProperties tooltip)
ContainerSpinnerSectionBuilder.FinalBuilder<T,V>	toolTip(String tooltip)
ContainerSpinnerSectionBuilder.FinalBuilder<T,V>	validation(Predicate<V> validation, String message)	Sets a check of the value.
ContainerSpinnerSectionBuilder.LabelBuilder<T,R>	valueExtractor(Function<T,V> valueExtractor)
ContainerSpinnerSectionBuilder.FinalBuilder<T,V>	visible(Predicate<T> visible)

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.amalgamasimulation.desktop.ui.editor.builders.interfaces.IContainerButtonBuilder

addButtonIf

Methods inherited from interface com.amalgamasimulation.desktop.ui.editor.builders.interfaces.IContainerVisibleEnableBuilder

enabled, visible

Methods inherited from interface com.amalgamasimulation.desktop.ui.editor.builders.interfaces.ILabelPropertiesBuilder

labelProperties

Methods inherited from interface com.amalgamasimulation.desktop.ui.editor.builders.interfaces.IToolTipBuilder

toolTip, toolTip

Field Details

section

protected final ContainerSpinnerSection<T,V> section

labelProperties

protected final LabelProperties labelProperties

actionAfterCreateSectionInProperty

protected BiConsumer<Integer,com.amalgamasimulation.desktop.ui.editor.sections.internal.Section> actionAfterCreateSectionInProperty

index

protected int index

Method Details

createInteger

public static <T1>
ContainerSpinnerSectionBuilder.ParentBuilder<T1,Integer,ContainerSpinnerSectionBuilder.RangeBuilder<T1,Integer>> createInteger(org.eclipse.core.databinding.observable.value.IObservableValue<T1> containerObservable)

Creates the builder of a section for an Integer.

Type Parameters:

T1 - type of the object in the container

Parameters:

containerObservable - container with the edited object

Returns:

the first step of the builder

createDouble

public static <T1>
ContainerSpinnerSectionBuilder.ParentBuilder<T1,Double,ContainerSpinnerSectionBuilder.DigitsRangeBuilder<T1,Double>> createDouble(org.eclipse.core.databinding.observable.value.IObservableValue<T1> containerObservable)

Creates the builder of a section for a Double.

Type Parameters:

T1 - type of the object in the container

Parameters:

containerObservable - container with the edited object

Returns:

the first step of the builder

create

public static <T1,
V1>
ContainerSpinnerSectionBuilder.ParentBuilder<T1,V1,ContainerSpinnerSectionBuilder.ConverterBuilder<T1,V1>> create(org.eclipse.core.databinding.observable.value.IObservableValue<T1> containerObservable)

Creates the builder of a section for a value of any type; the converter step turns it into a number.

Type Parameters:

T1 - type of the object in the container

V1 - type of the value

Parameters:

containerObservable - container with the edited object

Returns:

the first step of the builder

getThis

protected ContainerSpinnerSectionBuilder.FinalBuilder<T,V> getThis()

Returns this builder as its final step.

getContainer

protected org.eclipse.core.databinding.observable.value.IObservableValue<T> getContainer()

Returns the container of the section.

setVisible

protected void setVisible(Predicate<T> visible)

setEnabled

protected void setEnabled(Predicate<T> enabled)

parent

public ContainerSpinnerSectionBuilder.ValueExtractorBuilder<T,V,R> parent(org.eclipse.swt.widgets.Composite parent)

Specified by:

parent in interface IParentBuilder<T>

valueExtractor

public ContainerSpinnerSectionBuilder.LabelBuilder<T,R> valueExtractor(Function<T,V> valueExtractor)

Specified by:

valueExtractor in interface IValueExtractorBuilder<T,V,R>

label

public R label(String label)

Specified by:

label in interface ILabelBuilder<T>

label

public R label(Function<T,String> label)

Specified by:

label in interface IContainerLabelBuilder<T,V>

converter

public ContainerSpinnerSectionBuilder.DigitsRangeBuilder<T,V> converter(ToDoubleFunction<V> toNumber,
 DoubleFunction<V> fromNumber)

Description copied from interface: IConverterBuilder

Sets how a value is turned into the number of the spinner and back.

Specified by:

converter in interface IConverterBuilder<T,V>

Parameters:

toNumber - turns a value into a number; gets a value that is not null

fromNumber - turns a number of the spinner back into a value

Returns:

the next step of the builder

range

public ContainerSpinnerSectionBuilder.Builder<T,V,R> range(V minimum,
 V maximum)

Description copied from interface: ContainerSpinnerSectionBuilder.RangeBuilder

Sets the smallest and the largest value. If minimum is greater than maximum, create() throws IllegalArgumentException.

Specified by:

range in interface ContainerSpinnerSectionBuilder.DigitsRangeBuilder<T,V>

Specified by:

range in interface ContainerSpinnerSectionBuilder.RangeBuilder<T,V>

Parameters:

minimum - the smallest value

maximum - the largest value

Returns:

the next step of the builder

digits

public ContainerSpinnerSectionBuilder.HandlerBuilder<T,V> digits(int digits)

Description copied from interface: IDigitsBuilder

Sets the number of digits after the point; the spinner shows the value rounded to them. If digits is below 0, create() throws IllegalArgumentException.

Specified by:

digits in interface IDigitsBuilder<T>

Parameters:

digits - the number of digits after the point

Returns:

the next step of the builder

handler

public ContainerSpinnerSectionBuilder.FinalBuilder<T,V> handler(BiConsumer<T,V> handler)

Specified by:

handler in interface IContainerHandlerBuilder<T,V,R>

spinnerProperties

public ContainerSpinnerSectionBuilder.FinalBuilder<T,V> spinnerProperties(SpinnerProperties<V> spinnerProperties)

Description copied from interface: ISpinnerPropertiesBuilder

Sets the spinner settings. A second call replaces the settings of the first one.

Specified by:

spinnerProperties in interface ISpinnerPropertiesBuilder<T,V>

Parameters:

spinnerProperties - the spinner settings

Returns:

the next step of the builder

addButton

public ContainerSpinnerSectionBuilder.FinalBuilder<T,V> addButton(IContainerButtonProperties buttonProperties)

Specified by:

addButton in interface IContainerButtonBuilder<T>

validation

public ContainerSpinnerSectionBuilder.FinalBuilder<T,V> validation(Predicate<V> validation,
 String message)

Description copied from interface: IValidationBuilder

Sets a check of the value. A value that fails it is not written, and an error icon with the message as its tooltip is shown next to the spinner.

Specified by:

validation in interface IValidationBuilder<T,V>

Parameters:

validation - the check; gets a value that is not null

message - the tooltip of the error icon

Returns:

the next step of the builder

canBeNull

public ContainerSpinnerSectionBuilder.FinalBuilder<T,V> canBeNull(BooleanSupplier canBeNull)

Specified by:

canBeNull in interface ICanBeNullBuilder<T>

create

public ISpinnerSection<V> create()

Specified by:

create in interface ICreateBuilder<T>

labelProperties

public ContainerSpinnerSectionBuilder.FinalBuilder<T,V> labelProperties(LabelProperties labelProperties)

toolTip

public ContainerSpinnerSectionBuilder.FinalBuilder<T,V> toolTip(String tooltip)

toolTip

public ContainerSpinnerSectionBuilder.FinalBuilder<T,V> toolTip(ToolTipProperties tooltip)

visible

public ContainerSpinnerSectionBuilder.FinalBuilder<T,V> visible(Predicate<T> visible)

enabled

public ContainerSpinnerSectionBuilder.FinalBuilder<T,V> enabled(Predicate<T> enabled)

setParent

protected void setParent(org.eclipse.swt.widgets.Composite parent)

setPage

protected void setPage(org.eclipse.swt.widgets.Composite parent,
 BiConsumer<Integer,com.amalgamasimulation.desktop.ui.editor.sections.internal.Section> actionAfterCreateSectionInProperty,
 int index)

Places the section on a property page: the page gives the parent, the position and the action that adds the section.

setLabel

protected void setLabel(String label)

setLabel

protected void setLabel(Function<T,String> label)

addToPage

protected void addToPage()

Passes the created section to the property page. Does nothing outside a page.