org.eclipse.gef4.mvc.fx.policies

Class FXChangeViewportPolicy

java.lang.Object

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

org.eclipse.gef4.mvc.fx.policies.FXChangeViewportPolicy

All Implemented Interfaces:

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

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

A transactional IPolicy to change the viewport of an IViewer via its attached ViewportModel. The ViewportModel is expected to be registered as adapter on the IViewer, which is retrieved through navigating via the IRootPart of this policy's host.

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.gef4.mvc.operations.ITransactional

ITransactional.NoOperation, ITransactional.UnexecutableOperation

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	initialized Stores the initialized flag for this policy, i.e.

Fields inherited from interface org.eclipse.gef4.mvc.operations.ITransactional

NOOP, UNEXECUTABLE

Constructor Summary

Constructors

Constructor and Description
FXChangeViewportPolicy()

Method Summary

Modifier and Type	Method and Description
ITransactionalOperation	commit() Returns an ITransactionalOperation that performs all manipulations applied by the policy since the last ITransactional.init() call.
void	init() Initializes the policy, so that the policy's "work" methods can be used.
void	scrollRelative(double deltaTranslateX, double deltaTranslateY) Advances the viewport transformation by the given translation values.
void	zoomRelative(double relativeZoom, double sceneX, double sceneY) Concatenates a scaling transformation to the current viewport transformation.

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

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

FXChangeViewportPolicy

public FXChangeViewportPolicy()

Method Detail

commit

public ITransactionalOperation commit()

Description copied from interface: ITransactional

Returns an ITransactionalOperation 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.

You can return ITransactional.NOOP if no changes have to be applied. The domain will filter out all ITransactional.NOOPs before their execution.

You can return ITransactional.UNEXECUTABLE to prevent any composite operation that contains the ITransactional.UNEXECUTABLE from execution.

Specified by:

commit in interface ITransactional

Returns:

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

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

scrollRelative

public void scrollRelative(double deltaTranslateX,
                           double deltaTranslateY)

Advances the viewport transformation by the given translation values.

Parameters:

deltaTranslateX - The horizontal translation delta.

deltaTranslateY - The vertical translation delta.

zoomRelative

public void zoomRelative(double relativeZoom,
                         double sceneX,
                         double sceneY)

Concatenates a scaling transformation to the current viewport transformation.

Parameters:

relativeZoom - The scale factor.

sceneX - The pivot x-coordinate.

sceneY - The pivot y-coordinate.