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

Class AdaptedModelVisualFactoryContextImpl<M extends Model>

java.lang.Object

net.officefloor.gef.editor.internal.parts.AdaptedModelVisualFactoryContextImpl<M>

All Implemented Interfaces:

AdaptedActionVisualFactoryContext, AdaptedConnectorVisualFactoryContext, AdaptedModelVisualFactoryContext<M>

Direct Known Subclasses:

AdaptedChildVisualFactoryContextImpl

public class AdaptedModelVisualFactoryContextImpl<M extends Model>
extends java.lang.Object
implements AdaptedModelVisualFactoryContext<M>, AdaptedActionVisualFactoryContext

AdaptedChildVisualFactoryContext implementation.

Author:

Daniel Sagenschneider

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AdaptedModelVisualFactoryContextImpl.Actioner<M extends Model>	Function interface to action a ModelAction.
static interface	AdaptedModelVisualFactoryContextImpl.ConnectorLoader<M extends Model>	Function interface to load connectors.

Nested classes/interfaces inherited from interface net.officefloor.gef.editor.AdaptedModelVisualFactoryContext

AdaptedModelVisualFactoryContext.Connector

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	isPalettePrototype	Indicates if rendering the palette prototype.
protected java.lang.Class<M>	modelClass	Class of the Model.

Constructor Summary

Constructors

Constructor	Description
AdaptedModelVisualFactoryContextImpl(java.lang.Class<M> modelClass, boolean isPalettePrototype, AdaptedModelVisualFactoryContextImpl.ConnectorLoader<M> connectorLoader, AdaptedModelVisualFactoryContextImpl.Actioner<M> actioner)	Instantiate.

Method Summary

Modifier and Type	Method	Description
<R extends Model,O> void	action(ModelAction<R,O,M> action)	Allows ModelAction instances to be actioned via visual.
<R extends Model,O> javafx.scene.Node	action(ModelAction<R,O,M> action, AdaptedActionVisualFactory visualFactory)	Convenience method to add a ModelAction to be actioned via AdaptedActionVisualFactory.
javafx.scene.layout.Pane	addIndent(javafx.scene.layout.HBox parent)	Adds an indent Pane.
<N extends javafx.scene.Node> N	addNode(javafx.scene.layout.Pane parent, N node)	Add the Node to the parent Pane returning it.
<N extends javafx.scene.layout.Region> AdaptedModelVisualFactoryContext.Connector	connector(AdaptedConnectorVisualFactory<N> visualFactory, java.lang.Class... connectionModelClasses)	Specifies the GeometryNode as AdaptedConnector IAnchor.
javafx.scene.Node	createImageWithHover(java.lang.Class<?> resourceClass, java.lang.String imageFilePath, java.lang.String hoverImageFilePath)	Convenience method to create a Node with Image and hover Image.

Methods inherited from class java.lang.Object

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

Field Detail

modelClass

protected final java.lang.Class<M extends Model> modelClass

Class of the Model.

isPalettePrototype

protected final boolean isPalettePrototype

Indicates if rendering the palette prototype.

Constructor Detail

AdaptedModelVisualFactoryContextImpl

public AdaptedModelVisualFactoryContextImpl(java.lang.Class<M> modelClass,
                                            boolean isPalettePrototype,
                                            AdaptedModelVisualFactoryContextImpl.ConnectorLoader<M> connectorLoader,
                                            AdaptedModelVisualFactoryContextImpl.Actioner<M> actioner)

Instantiate.

Parameters:

modelClass - Class of the Model.

isPalettePrototype - Indicates if rendering the palette prototype.

connectorLoader - AdaptedModelVisualFactoryContextImpl.ConnectorLoader.

actioner - AdaptedModelVisualFactoryContextImpl.Actioner.

Method Detail

addNode

public <N extends javafx.scene.Node> N addNode(javafx.scene.layout.Pane parent,
                                               N node)

Description copied from interface: AdaptedModelVisualFactoryContext

Add the Node to the parent Pane returning it.

This allows for convenient adding new Node instances to Pane.

Specified by:

addNode in interface AdaptedActionVisualFactoryContext

Specified by:

addNode in interface AdaptedModelVisualFactoryContext<M extends Model>

Type Parameters:

N - Node type.

Parameters:

parent - Parent Pane.

node - Node.

Returns:

Input Node

addIndent

public javafx.scene.layout.Pane addIndent(javafx.scene.layout.HBox parent)

Description copied from interface: AdaptedModelVisualFactoryContext

Adds an indent Pane.

Specified by:

addIndent in interface AdaptedModelVisualFactoryContext<M extends Model>

Parameters:

parent - Parent HBox.

Returns:

Pane for the indent.

connector

public <N extends javafx.scene.layout.Region> AdaptedModelVisualFactoryContext.Connector connector(AdaptedConnectorVisualFactory<N> visualFactory,
                                                                                                   java.lang.Class... connectionModelClasses)

Description copied from interface: AdaptedModelVisualFactoryContext

Specifies the GeometryNode as AdaptedConnector IAnchor.

Specified by:

connector in interface AdaptedModelVisualFactoryContext<M extends Model>

Type Parameters:

N - Node type.

Parameters:

visualFactory - AdaptedConnectorVisualFactory.

connectionModelClasses - ConnectionModel Class instances that this connector satisfies.

Returns:

AdaptedModelVisualFactoryContext.Connector.

See Also:

DefaultConnectors

createImageWithHover

public javafx.scene.Node createImageWithHover(java.lang.Class<?> resourceClass,
                                              java.lang.String imageFilePath,
                                              java.lang.String hoverImageFilePath)

Description copied from interface: AdaptedModelVisualFactoryContext

Convenience method to create a Node with Image and hover Image. Typically this is to create button for the action.

Specified by:

createImageWithHover in interface AdaptedActionVisualFactoryContext

Specified by:

createImageWithHover in interface AdaptedModelVisualFactoryContext<M extends Model>

Parameters:

resourceClass - Class within the class path containing the images.

imageFilePath - Path to the Image.

hoverImageFilePath - Path to the hover Image.

Returns:

Node for the Image with hover.

See Also:

DefaultImages

action

public <R extends Model,O> void action(ModelAction<R,O,M> action)

Description copied from interface: AdaptedModelVisualFactoryContext

Allows ModelAction instances to be actioned via visual.

This allows custom visuals (e.g. button) tor trigger an action.

Specified by:

action in interface AdaptedModelVisualFactoryContext<M extends Model>

Type Parameters:

R - Root Model type.

O - Operations type.

Parameters:

action - ModelAction to be actioned.

action

public <R extends Model,O> javafx.scene.Node action(ModelAction<R,O,M> action,
                                                          AdaptedActionVisualFactory visualFactory)

Description copied from interface: AdaptedModelVisualFactoryContext

Convenience method to add a ModelAction to be actioned via AdaptedActionVisualFactory.

Specified by:

action in interface AdaptedModelVisualFactoryContext<M extends Model>

Type Parameters:

R - Root Model type.

O - Operations type.

Parameters:

action - ModelAction to be actioned.

visualFactory - AdaptedActionVisualFactory.

Returns:

Node to trigger the ModelAction.