org.eclipse.gef4.mvc.fx.policies

Class FXTransformPolicy

java.lang.Object

org.eclipse.gef4.mvc.policies.AbstractPolicy<javafx.scene.Node>

org.eclipse.gef4.mvc.fx.policies.FXTransformPolicy

All Implemented Interfaces:

IAdaptable.Bound<IVisualPart<javafx.scene.Node,? extends javafx.scene.Node>>, ITransactional, IPolicy<javafx.scene.Node>

Direct Known Subclasses:

FXRelocateConnectionPolicy

public class FXTransformPolicy
extends AbstractPolicy<javafx.scene.Node>
implements ITransactional

The FXTransformPolicy is a transactional policy that handles the transformation of its host.

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	initialized Stores the initialized flag for this policy, i.e.
static java.lang.String	TRANSFORMATION_PROVIDER_ROLE The role name for the Provider<Affine> that will be used to obtain the host's Affine transformation.

Constructor Summary

Constructors

Constructor and Description
FXTransformPolicy()

Method Summary

Modifier and Type	Method and Description
IUndoableOperation	commit() Returns an IUndoableOperation that performs all manipulations applied by the policy since the last ITransactional.init() call.
javafx.scene.transform.Affine	getNodeTransform() Returns the Affine transformation that is returned by the Provider<Affine> that is installed on the host under the TRANSFORMATION_PROVIDER_ROLE role.
protected static Dimension	getSnapToGridOffset(GridModel gridModel, double localX, double localY, double gridCellWidthFraction, double gridCellHeightFraction) Computes the offset which needs to be added to the given local coordinates in order to stay on the grid/snap to the grid.
void	init() Initializes the policy, so that the policy's "work" methods can be used.
void	setConcatenation(AffineTransform transform) Concatenates the given AffineTransform to the initial transformation.
void	setPreConcatenation(AffineTransform transform) Concatenates the initial transformation to the given AffineTransform.
void	setTransform(AffineTransform newTransform) Changes the host's transformation to the given AffineTransform.

Methods inherited from class org.eclipse.gef4.mvc.policies.AbstractPolicy

commit, disableRefreshVisuals, enableRefreshVisuals, getAdaptable, getHost, init, setAdaptable

Methods inherited from class java.lang.Object

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

Field Detail

TRANSFORMATION_PROVIDER_ROLE

public static final java.lang.String TRANSFORMATION_PROVIDER_ROLE

The role name for the Provider<Affine> that will be used to obtain the host's Affine transformation.

See Also:

Constant Field Values

initialized

protected boolean initialized

Stores the initialized flag for this policy, i.e. true after init() was called, and false after commit() was called, respectively.

Constructor Detail

FXTransformPolicy

public FXTransformPolicy()

Method Detail

getSnapToGridOffset

protected static Dimension getSnapToGridOffset(GridModel gridModel,
                                               double localX,
                                               double localY,
                                               double gridCellWidthFraction,
                                               double gridCellHeightFraction)

Computes the offset which needs to be added to the given local coordinates in order to stay on the grid/snap to the grid.

Parameters:

gridModel - The GridModel of the host's IViewer.

localX - The x-coordinate in host coordinates.

localY - The y-coordinate in host coordinates.

gridCellWidthFraction - The granularity of the horizontal grid steps.

gridCellHeightFraction - The granularity of the vertical grid steps.

Returns:

A Dimension representing the offset that needs to be added to the local coordinates so that they snap to the grid.

commit

public IUndoableOperation commit()

Description copied from interface: ITransactional

Returns an IUndoableOperation that performs all manipulations applied by the policy since the last ITransactional.init() call. When called multiple times in sequence, only the first call will yield an operation, the subsequent calls will yield null.

Specified by:

commit in interface ITransactional

Returns:

An IUndoableOperation that performs all manipulations applied by the policy since the last ITransactional.init() call.

getNodeTransform

public javafx.scene.transform.Affine getNodeTransform()

Returns the Affine transformation that is returned by the Provider<Affine> that is installed on the host under the TRANSFORMATION_PROVIDER_ROLE role.

Returns:

The Affine transformation that is returned by the Provider<Affine> that is installed on the host under the TRANSFORMATION_PROVIDER_ROLE role.

init

public void init()

Description copied from interface: ITransactional

Initializes the policy, so that the policy's "work" methods can be used. Calling a "work" method while the policy is not initialized will result in an IllegalStateException. It is safe to call ITransactional.init() multiple times in sequence.

Specified by:

init in interface ITransactional

setConcatenation

public void setConcatenation(AffineTransform transform)

Concatenates the given AffineTransform to the initial transformation.

Parameters:

transform - The AffineTransform that is concatenated to the initial transformation.

setPreConcatenation

public void setPreConcatenation(AffineTransform transform)

Concatenates the initial transformation to the given AffineTransform.

Parameters:

transform - The AffineTransform to which the initial transformation is concatenated.

setTransform

public void setTransform(AffineTransform newTransform)

Changes the host's transformation to the given AffineTransform.

Parameters:

newTransform - The new AffineTransform for the host.