Package net.officefloor.gef.editor.internal.parts

Class OfficeFloorContentPartFactory<R extends Model,O>

java.lang.Object

net.officefloor.gef.editor.internal.parts.OfficeFloorContentPartFactory<R,O>

All Implemented Interfaces:

AdaptedBuilderContext, AdaptedRootBuilder<R,O>, EditorStyler, PaletteIndicatorStyler, PaletteStyler, org.eclipse.gef.mvc.fx.parts.IContentPartFactory

@Singleton
public class OfficeFloorContentPartFactory<R extends Model,O>
extends java.lang.Object
implements org.eclipse.gef.mvc.fx.parts.IContentPartFactory, AdaptedRootBuilder<R,O>, AdaptedBuilderContext, PaletteIndicatorStyler, PaletteStyler

Field Summary

Fields

Modifier and Type	Field	Description
static int	DEFAULT_DRAG_LATENCY	Default drag latency.

Constructor Summary

Constructors

Constructor	Description
OfficeFloorContentPartFactory()

Method Summary

Modifier and Type	Method	Description
<S extends Model,T extends Model,C extends ConnectionModel> void	addConnection(S source, T target, AdaptedConnectionManagementBuilder.ConnectionFactory<R,O,S,C,T> createConnection)	Adds the ConnectionModel to the Model structure.
<M extends Model> AdaptedModel<M>	createAdaptedModel(M model, AdaptedModel<?> parentAdaptedModel)	Creates the wrapper for the Model.
org.eclipse.gef.mvc.fx.parts.IContentPart<? extends javafx.scene.Node>	createContentPart(java.lang.Object content, java.util.Map<java.lang.Object,java.lang.Object> contextMap)
static java.util.List<org.eclipse.gef.mvc.fx.parts.IFeedbackPart<? extends javafx.scene.Node>>	createFeedbackParts(java.util.List<? extends org.eclipse.gef.mvc.fx.parts.IVisualPart<? extends javafx.scene.Node>> targets, java.util.function.Function<java.util.List<org.eclipse.gef.mvc.fx.parts.IVisualPart<? extends javafx.scene.Node>>,java.util.List<org.eclipse.gef.mvc.fx.parts.IFeedbackPart<? extends javafx.scene.Node>>> createFeedbackParts)	Indicates if contains an ConnectionModel.
javafx.beans.property.Property<java.lang.String>	editorStyle()	Obtains the Property to the style sheet rules for the Scene.
ChangeExecutor	getChangeExecutor()	Obtains the ChangeExecutor.
int	getDragLatency()	Obtains the drag latency.
javafx.scene.Parent	getEditor()	Obtains the root Parent for the editor.
AdaptedErrorHandler	getErrorHandler()	Obtains the AdaptedErrorHandler.
org.eclipse.gef.mvc.fx.models.GridModel	getGridModel()	Obtains the GridModel to configure the content grid.
javafx.scene.Node	getPalette()	Obtains the palette.
javafx.scene.Node	getPaletteIndicator()	Obtains the palette indicator.
SelectOnly	getSelectOnly()	Obtains the SelectOnly.
StyleRegistry	getStyleRegistry()	Obtains the StyleRegistry.
void	init(com.google.inject.Injector injector, javafx.scene.layout.Pane editorPane, org.eclipse.gef.mvc.fx.viewer.IViewer content, javafx.scene.layout.Pane paletteIndicator, org.eclipse.gef.mvc.fx.viewer.IViewer palette, AdaptedErrorHandler errorHandler, ChangeExecutor changeExecutor, StyleRegistry styleRegistry, int dragLatency, SelectOnly selectOnly)	Initialises.
boolean	isCreateParent()	Indicates if able to create an AdaptedParent.
void	loadContentModels()	Loads the content Model instances into the content IViewer.
javafx.beans.property.Property<R>	loadRootModel(R rootModel)	Loads the root Model.
void	overlay(double x, double y, OverlayVisualFactory overlayVisualFactory)	Allows adding an overlay.
javafx.beans.property.Property<java.lang.String>	paletteIndicatorStyle()	Obtains the Property to the style sheet rules for the palette indicator.
javafx.beans.property.Property<java.lang.String>	paletteStyle()	Obtains the Property to the style sheet rules for the palette.
<M extends Model,E extends java.lang.Enum<E>,RE extends java.lang.Enum<RE>> AdaptedParentBuilder<R,O,M,E>	parent(M modelPrototype, java.util.function.Function<R,java.util.List<M>> getParents, AdaptedChildVisualFactory<M> viewFactory, RE... changeParentEvents)	Adds an AdaptedParent.
<M extends Model,E extends java.lang.Enum<E>> void	registerModel(AbstractAdaptedFactory<R,O,M,E,?> builder)	Registers the AbstractAdaptedFactory.
<r extends Model,o> AdaptedRootBuilder<r,o>	root(java.lang.Class<r> rootModelClass, java.util.function.Function<r,o> createOperations)	Specifies the root Model.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_DRAG_LATENCY

public static final int DEFAULT_DRAG_LATENCY

Default drag latency.

See Also:

Constant Field Values

Constructor Detail

OfficeFloorContentPartFactory

public OfficeFloorContentPartFactory()

Method Detail

createFeedbackParts

public static java.util.List<org.eclipse.gef.mvc.fx.parts.IFeedbackPart<? extends javafx.scene.Node>> createFeedbackParts(java.util.List<? extends org.eclipse.gef.mvc.fx.parts.IVisualPart<? extends javafx.scene.Node>> targets,
                                                                                                                          java.util.function.Function<java.util.List<org.eclipse.gef.mvc.fx.parts.IVisualPart<? extends javafx.scene.Node>>,java.util.List<org.eclipse.gef.mvc.fx.parts.IFeedbackPart<? extends javafx.scene.Node>>> createFeedbackParts)

Indicates if contains an ConnectionModel.

Parameters:

targets - Target IVisualPart instances.

createFeedbackParts - Function to create the IFeedbackPart instances from the filtered list of targets.

Returns:

Filtered targets.

init

public void init(com.google.inject.Injector injector,
                 javafx.scene.layout.Pane editorPane,
                 org.eclipse.gef.mvc.fx.viewer.IViewer content,
                 javafx.scene.layout.Pane paletteIndicator,
                 org.eclipse.gef.mvc.fx.viewer.IViewer palette,
                 AdaptedErrorHandler errorHandler,
                 ChangeExecutor changeExecutor,
                 StyleRegistry styleRegistry,
                 int dragLatency,
                 SelectOnly selectOnly)

Initialises.

Parameters:

injector - Injector.

editorPane - Editor Pane.

content - IViewer content.

paletteIndicator - Palette indicator Pane.

palette - IViewer palette.

errorHandler - AdaptedErrorHandler.

changeExecutor - ChangeExecutor.

styleRegistry - StyleRegistry.

dragLatency - Drag latency. Higher provides better drag performance, while lower provides better responsiveness.

selectOnly - SelectOnly.

registerModel

public <M extends Model,E extends java.lang.Enum<E>> void registerModel(AbstractAdaptedFactory<R,O,M,E,?> builder)

Registers the AbstractAdaptedFactory.

Type Parameters:

M - Model type.

E - Model event type.

Parameters:

builder - AbstractAdaptedFactory.

getStyleRegistry

public StyleRegistry getStyleRegistry()

Obtains the StyleRegistry.

Returns:

StyleRegistry.

isCreateParent

public boolean isCreateParent()

Indicates if able to create an AdaptedParent.

Returns:

true if able to create an AdaptedParent.

loadRootModel

public javafx.beans.property.Property<R> loadRootModel(R rootModel)

Loads the root Model.

Parameters:

rootModel - Root Model.

loadContentModels

public void loadContentModels()

Loads the content Model instances into the content IViewer.

createAdaptedModel

public <M extends Model> AdaptedModel<M> createAdaptedModel(M model,
                                                            AdaptedModel<?> parentAdaptedModel)

Creates the wrapper for the Model.

Type Parameters:

M - Model type.

Parameters:

model - Model.

parentAdaptedModel - Parent AdaptedModel.

Returns:

AbstractAdaptedFactory for the Model.

addConnection

public <S extends Model,T extends Model,C extends ConnectionModel> void addConnection(S source,
                                                                                                  T target,
                                                                                                  AdaptedConnectionManagementBuilder.ConnectionFactory<R,O,S,C,T> createConnection)

Adds the ConnectionModel to the Model structure.

Type Parameters:

S - Source Model type.

T - Target Model type.

C - ConnectionModel type.

Parameters:

source - Source Model.

target - Target Model.

createConnection - AdaptedConnectionManagementBuilder.ConnectionFactory.

getDragLatency

public int getDragLatency()

Obtains the drag latency.

Returns:

Drag latency.

getSelectOnly

public SelectOnly getSelectOnly()

Obtains the SelectOnly.

Returns:

SelectOnly or null if no SelectOnly.

root

public <r extends Model,o> AdaptedRootBuilder<r,o> root(java.lang.Class<r> rootModelClass,
                                                                    java.util.function.Function<r,o> createOperations)

Description copied from interface: AdaptedBuilderContext

Specifies the root Model.

Specified by:

root in interface AdaptedBuilderContext

Type Parameters:

r - Root Model type.

o - Operations type.

Parameters:

rootModelClass - Class of the root Model.

createOperations - Function to create the operations object to wrap the root Model.

Returns:

AdaptedRootBuilder.

parent

public <M extends Model,E extends java.lang.Enum<E>,RE extends java.lang.Enum<RE>> AdaptedParentBuilder<R,O,M,E> parent(M modelPrototype,
                                                                                                                                                      java.util.function.Function<R,java.util.List<M>> getParents,
                                                                                                                                                      AdaptedChildVisualFactory<M> viewFactory,
                                                                                                                                                      RE... changeParentEvents)

Description copied from interface: AdaptedRootBuilder

Adds an AdaptedParent.

Specified by:

parent in interface AdaptedRootBuilder<R extends Model,O>

Type Parameters:

M - Model type.

E - Model event type.

RE - Root Model event type.

Parameters:

modelPrototype - Model prototype used in view validation, creation prototype and to obtain the Class of the Model.

getParents - Function to obtain the parent Model instances.

viewFactory - AdaptedChildVisualFactory to create the view for the AdaptedParent.

changeParentEvents - Enum events on root Model about change in parent Model listing.

Returns:

AdaptedParentBuilder to build the AdaptedParent over the Model.

overlay

public void overlay(double x,
                    double y,
                    OverlayVisualFactory overlayVisualFactory)

Description copied from interface: AdaptedRootBuilder

Allows adding an overlay.

Co-ordinates used rather than Point to avoid importing libraries.

Specified by:

overlay in interface AdaptedRootBuilder<R extends Model,O>

Parameters:

x - X co-ordinate.

y - Y co-ordintate.

overlayVisualFactory - OverlayVisualFactory.

getErrorHandler

public AdaptedErrorHandler getErrorHandler()

Description copied from interface: AdaptedRootBuilder

Obtains the AdaptedErrorHandler.

Specified by:

getErrorHandler in interface AdaptedRootBuilder<R extends Model,O>

Returns:

AdaptedErrorHandler.

getChangeExecutor

public ChangeExecutor getChangeExecutor()

Description copied from interface: AdaptedRootBuilder

Obtains the ChangeExecutor.

Specified by:

getChangeExecutor in interface AdaptedRootBuilder<R extends Model,O>

Returns:

ChangeExecutor.

getEditor

public javafx.scene.Parent getEditor()

Description copied from interface: EditorStyler

Obtains the root Parent for the editor.

This allows for interrogating the structure of the editor.

Specified by:

getEditor in interface EditorStyler

Returns:

Editor Parent.

getGridModel

public org.eclipse.gef.mvc.fx.models.GridModel getGridModel()

Description copied from interface: EditorStyler

Obtains the GridModel to configure the content grid.

Specified by:

getGridModel in interface EditorStyler

Returns:

GridModel to configure the content grid.

editorStyle

public javafx.beans.property.Property<java.lang.String> editorStyle()

Description copied from interface: EditorStyler

Obtains the Property to the style sheet rules for the Scene.

Specified by:

editorStyle in interface EditorStyler

Returns:

Property to specify the style sheet rules for the Scene.

getPaletteIndicator

public javafx.scene.Node getPaletteIndicator()

Description copied from interface: PaletteIndicatorStyler

Obtains the palette indicator.

This allows for interrogating the structure of the palette indicator.

Specified by:

getPaletteIndicator in interface PaletteIndicatorStyler

Returns:

Palette indicator.

paletteIndicatorStyle

public javafx.beans.property.Property<java.lang.String> paletteIndicatorStyle()

Description copied from interface: AdaptedRootBuilder

Obtains the Property to the style sheet rules for the palette indicator.

Specified by:

paletteIndicatorStyle in interface AdaptedRootBuilder<R extends Model,O>

Specified by:

paletteIndicatorStyle in interface PaletteIndicatorStyler

Returns:

Property to specify the style sheet rules for the palette indicator.

getPalette

public javafx.scene.Node getPalette()

Description copied from interface: PaletteStyler

Obtains the palette.

This allows for interrogating the structure of the palette.

Specified by:

getPalette in interface PaletteStyler

Returns:

Palette.

paletteStyle

public javafx.beans.property.Property<java.lang.String> paletteStyle()

Description copied from interface: AdaptedRootBuilder

Obtains the Property to the style sheet rules for the palette.

Specified by:

paletteStyle in interface AdaptedRootBuilder<R extends Model,O>

Specified by:

paletteStyle in interface PaletteStyler

Returns:

Property to specify the style sheet rules for the palette.

createContentPart

public org.eclipse.gef.mvc.fx.parts.IContentPart<? extends javafx.scene.Node> createContentPart(java.lang.Object content,
                                                                                                java.util.Map<java.lang.Object,java.lang.Object> contextMap)

Specified by:

createContentPart in interface org.eclipse.gef.mvc.fx.parts.IContentPartFactory