net.officefloor.eclipse.ide.editor

Class AbstractItem<R extends net.officefloor.model.Model,O,P extends net.officefloor.model.Model,PE extends java.lang.Enum<PE>,M extends net.officefloor.model.Model,E extends java.lang.Enum<E>>

java.lang.Object

net.officefloor.eclipse.configurer.AbstractConfigurerRunnable

net.officefloor.eclipse.ide.editor.AbstractItem<R,O,P,PE,M,E>

All Implemented Interfaces:

java.lang.Runnable

Direct Known Subclasses:

AbstractConfigurableItem

public abstract class AbstractItem<R extends net.officefloor.model.Model,O,P extends net.officefloor.model.Model,PE extends java.lang.Enum<PE>,M extends net.officefloor.model.Model,E extends java.lang.Enum<E>>
extends AbstractConfigurerRunnable

Abstract child ConfigurationItem.

Author:

Daniel Sagenschneider

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AbstractItem.ConfigurableContext<R extends net.officefloor.model.Model,O> Context for the configurable parent.
class	AbstractItem.IdeChildrenGroup IDE ChildrenGroup.
class	AbstractItem.IdeConnection<C extends net.officefloor.model.ConnectionModel> IDE AdaptedConnectionBuilder.
class	AbstractItem.IdeConnectionTarget<C extends net.officefloor.model.ConnectionModel,T extends net.officefloor.model.Model,TE extends java.lang.Enum<TE>> IDE target AdaptedConnectionBuilder.
class	AbstractItem.IdeExtractor Extracts the Model instances.
class	AbstractItem.IdeLabeller Labels the configuration item.
class	AbstractItem.IdeStyle Convenience Class to build style.
static interface	AbstractItem.PreferenceListener Listener to change of a preference.

Field Summary

Fields

Modifier and Type	Field and Description
protected AdaptedChildBuilder<R,O,M,E>	builder AdaptedChildBuilder.

Constructor Summary

Constructors

Constructor and Description
AbstractItem()

Method Summary

Modifier and Type	Method and Description
protected void	children(java.util.List<AbstractItem.IdeChildrenGroup> childGroups) Loads the AbstractItem.IdeChildrenGroup instances.
protected void	connections(java.util.List<AbstractItem.IdeConnectionTarget<? extends net.officefloor.model.ConnectionModel,?,?>> connections) Loads the AbstractItem.IdeConnectionTarget instances (created from AbstractItem.IdeConnection instances).
AdaptedChildBuilder<R,O,M,E>	createChild(ChildrenGroupBuilder<R,O> childrenGroup) Creates the AdaptedChildBuilder.
abstract AbstractItem.IdeExtractor	extract() Obtains the AbstractItem.IdeExtractor to extract Model instances from the parent Model.
protected void	furtherAdapt(AdaptedChildBuilder<R,O,M,E> builder) Further adapt the AdaptedChildBuilder.
AdaptedChildBuilder<R,O,M,E>	getBuilder() Obtains the AdaptedChildBuilder for the AbstractItem.
AbstractItem.IdeChildrenGroup[]	getChildrenGroups() Obtains the AbstractItem.IdeChildrenGroup instances.
AbstractItem.ConfigurableContext<R,O>	getConfigurableContext() Obtains the AbstractItem.ConfigurableContext.
AbstractItem.IdeConnectionTarget<? extends net.officefloor.model.ConnectionModel,?,?>[]	getConnections() Obtains the AbstractItem.IdeConnection instances.
java.lang.String	getPreferenceStyleId() Obtains the IPreferenceStore identifier for styling this AbstractItem.
void	init(AbstractItem.ConfigurableContext<R,O> context) Initialise with AbstractItem.ConfigurableContext.
abstract AbstractItem.IdeLabeller	label() Obtains the AbstractItem.IdeLabeller for the Model.
protected void	loadConfiguration(org.eclipse.swt.widgets.Shell shell)
protected void	loadStyles(java.util.List<AbstractItem.IdeStyle> styles) Default implementation of style() will invoke this to load styles.
abstract void	loadToParent(P parentModel, M itemModel) Loads the Model to the parent Model.
abstract M	prototype() Creates the prototype for the item.
java.lang.String	style() Obtains the style for the display of the Model.
protected <CSVI> java.util.List<CSVI>	translateFromCommaSeparatedList(java.lang.String text, java.util.function.Function<java.lang.String,CSVI> getItem) Convenience method to translate comma separated text into a list.
protected <CSVI> java.lang.String	translateToCommaSeparateList(java.util.List<CSVI> items, java.util.function.Function<CSVI,java.lang.String> getValue) Convenience method to translate list of items to a comma separated list.
protected <I> java.util.Map<java.lang.String,java.lang.String>	translateToNameMappings(I[] items, java.util.function.Function<I,java.lang.String> getName) Translate the list of items to name mapping.
protected <PI> net.officefloor.compile.properties.PropertyList	translateToPropertyList(java.util.List<PI> properties, java.util.function.Function<PI,java.lang.String> getName, java.util.function.Function<PI,java.lang.String> getValue) Convenience method to translate list of property items to a PropertyList.
abstract javafx.scene.Node	visual(M model, AdaptedChildVisualFactoryContext<M> context) Creates the visual for the Model.

Methods inherited from class net.officefloor.eclipse.configurer.AbstractConfigurerRunnable

run

Methods inherited from class java.lang.Object

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

Field Detail

builder

protected AdaptedChildBuilder<R extends net.officefloor.model.Model,O,M extends net.officefloor.model.Model,E extends java.lang.Enum<E>> builder

AdaptedChildBuilder.

Constructor Detail

AbstractItem

public AbstractItem()

Method Detail

init

public final void init(AbstractItem.ConfigurableContext<R,O> context)

Initialise with AbstractItem.ConfigurableContext.

Parameters:

context - AbstractItem.ConfigurableContext.

getConfigurableContext

public final AbstractItem.ConfigurableContext<R,O> getConfigurableContext()

Obtains the AbstractItem.ConfigurableContext.

Returns:

AbstractItem.ConfigurableContext.

translateToPropertyList

protected final <PI> net.officefloor.compile.properties.PropertyList translateToPropertyList(java.util.List<PI> properties,
                                                                                             java.util.function.Function<PI,java.lang.String> getName,
                                                                                             java.util.function.Function<PI,java.lang.String> getValue)

Convenience method to translate list of property items to a PropertyList.

Type Parameters:

PI - Property item type.

Parameters:

properties - Property items.

getName - Function to extract the name from the property item.

getValue - Function to extract the value from the property item.

Returns:

PropertyList.

translateToCommaSeparateList

protected final <CSVI> java.lang.String translateToCommaSeparateList(java.util.List<CSVI> items,
                                                                     java.util.function.Function<CSVI,java.lang.String> getValue)

Convenience method to translate list of items to a comma separated list.

Type Parameters:

CSVI - Comma separated item type.

Parameters:

items - Items.

getValue - Obtains the value for the comma separate list from the item.

Returns:

Comma separate text for the items.

translateFromCommaSeparatedList

protected final <CSVI> java.util.List<CSVI> translateFromCommaSeparatedList(java.lang.String text,
                                                                            java.util.function.Function<java.lang.String,CSVI> getItem)

Convenience method to translate comma separated text into a list.

Type Parameters:

CSVI - Comma separated item type.

Parameters:

text - Comma separated text.

getItem - Creates the item from the comma separated value.

Returns:

List of items.

translateToNameMappings

protected final <I> java.util.Map<java.lang.String,java.lang.String> translateToNameMappings(I[] items,
                                                                                             java.util.function.Function<I,java.lang.String> getName)

Translate the list of items to name mapping.

Type Parameters:

I - Item types.

Parameters:

items - Items.

getName - Function to extract the name from the item.

Returns:

Name mapping.

prototype

public abstract M prototype()

Creates the prototype for the item.

Returns:

Prototype.

extract

public abstract AbstractItem.IdeExtractor extract()

Obtains the AbstractItem.IdeExtractor to extract Model instances from the parent Model.

Returns:

AbstractItem.IdeExtractor.

loadToParent

public abstract void loadToParent(P parentModel,
                                  M itemModel)

Loads the Model to the parent Model. This allows for constructing a prototype model for editing preferences of the AbstractIdeEditor.

Parameters:

parentModel - Parent Model.

itemModel - Item Model.

visual

public abstract javafx.scene.Node visual(M model,
                                         AdaptedChildVisualFactoryContext<M> context)

Creates the visual for the Model.

Parameters:

model - Model.

context - AdaptedChildVisualFactoryContext.

Returns:

Node for the visual.

label

public abstract AbstractItem.IdeLabeller label()

Obtains the AbstractItem.IdeLabeller for the Model.

Returns:

AbstractItem.IdeLabeller.

style

public java.lang.String style()

Obtains the style for the display of the Model.

Returns:

Style for the display of the Model.

loadStyles

protected void loadStyles(java.util.List<AbstractItem.IdeStyle> styles)

Default implementation of style() will invoke this to load styles.

Parameters:

styles - List to be loaded with the AbstractItem.IdeStyle instances.

furtherAdapt

protected void furtherAdapt(AdaptedChildBuilder<R,O,M,E> builder)

Further adapt the AdaptedChildBuilder.

Parameters:

builder - AdaptedChildBuilder.

getChildrenGroups

public final AbstractItem.IdeChildrenGroup[] getChildrenGroups()

Obtains the AbstractItem.IdeChildrenGroup instances.

Returns:

AbstractItem.IdeChildrenGroup instances.

children

protected void children(java.util.List<AbstractItem.IdeChildrenGroup> childGroups)

Loads the AbstractItem.IdeChildrenGroup instances.

Parameters:

childGroups - AbstractItem.IdeChildrenGroup instances.

getConnections

public final AbstractItem.IdeConnectionTarget<? extends net.officefloor.model.ConnectionModel,?,?>[] getConnections()

Obtains the AbstractItem.IdeConnection instances.

Returns:

AbstractItem.IdeConnection instances.

connections

protected void connections(java.util.List<AbstractItem.IdeConnectionTarget<? extends net.officefloor.model.ConnectionModel,?,?>> connections)

Loads the AbstractItem.IdeConnectionTarget instances (created from AbstractItem.IdeConnection instances).

Parameters:

connections - AbstractItem.IdeConnection instances.

createChild

public final AdaptedChildBuilder<R,O,M,E> createChild(ChildrenGroupBuilder<R,O> childrenGroup)

Creates the AdaptedChildBuilder.

Parameters:

childrenGroup - ChildrenGroupBuilder.

Returns:

Child AdaptedChildBuilder.

getBuilder

public final AdaptedChildBuilder<R,O,M,E> getBuilder()

Obtains the AdaptedChildBuilder for the AbstractItem.

Returns:

AdaptedChildBuilder for the AbstractItem.

getPreferenceStyleId

public final java.lang.String getPreferenceStyleId()

Obtains the IPreferenceStore identifier for styling this AbstractItem.

Returns:

IPreferenceStore identifier for styling this AbstractItem.

loadConfiguration

protected void loadConfiguration(org.eclipse.swt.widgets.Shell shell)

Specified by:

loadConfiguration in class AbstractConfigurerRunnable