org.eclipse.gef4.mvc.fx.tools

Class FXRotateTool

java.lang.Object

org.eclipse.gef4.mvc.tools.AbstractTool<javafx.scene.Node>

org.eclipse.gef4.mvc.fx.tools.FXRotateTool

All Implemented Interfaces:

IActivatable, IAdaptable.Bound<IDomain<javafx.scene.Node>>, IPropertyChangeNotifier, ITool<javafx.scene.Node>

public class FXRotateTool
extends AbstractTool<javafx.scene.Node>

An ITool to handle rotate interaction gestures.

During each rotate interaction, the tool identifies an IVisualPart that serves as interaction target. It is identified via hit-testing on the visuals and the availability of a corresponding AbstractFXOnRotatePolicy (see getTargetPart(IViewer, Node)).

The FXRotateTool handles the opening and closing of an transaction operation via the FXDomain, to which it is adapted. It controls that a single transaction operation is used for the complete interaction , so all interaction results can be undone in a single undo step.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.Class<AbstractFXOnRotatePolicy>	TOOL_POLICY_KEY The type of the policy that has to be supported by target parts.

Fields inherited from class org.eclipse.gef4.mvc.tools.AbstractTool

pcs

Fields inherited from interface org.eclipse.gef4.common.activate.IActivatable

ACTIVE_PROPERTY

Constructor Summary

Constructors

Constructor and Description
FXRotateTool()

Method Summary

Modifier and Type	Method and Description
protected java.util.Set<? extends AbstractFXOnRotatePolicy>	getRotatePolicies(IVisualPart<javafx.scene.Node,? extends javafx.scene.Node> targetPart) Returns a Set containing all AbstractFXOnRotatePolicys that are installed on the given target IVisualPart.
protected IVisualPart<javafx.scene.Node,? extends javafx.scene.Node>	getTargetPart(IViewer<javafx.scene.Node> viewer, javafx.scene.Node target) Returns the target IVisualPart within the given IViewer for the given target Node that received the input event.
protected java.util.Set<? extends AbstractFXOnRotatePolicy>	getTargetPolicies(IViewer<javafx.scene.Node> viewer, javafx.scene.input.RotateEvent e) Returns a Set containing all AbstractFXOnRotatePolicys that are installed on the target IVisualPart for the given RotateEvent.
protected void	registerListeners() This method is called when a valid IDomain is attached to this tool so that you can register event listeners for various inputs (keyboard, mouse) or model changes (selection, scroll offset / viewport).
protected void	unregisterListeners() This method is called when the attached IDomain is reset to null so that you can unregister previously registered event listeners.

Methods inherited from class org.eclipse.gef4.mvc.tools.AbstractTool

activate, addPropertyChangeListener, deactivate, getAdaptable, getDomain, isActive, removePropertyChangeListener, setAdaptable

Methods inherited from class java.lang.Object

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

Field Detail

TOOL_POLICY_KEY

public static final java.lang.Class<AbstractFXOnRotatePolicy> TOOL_POLICY_KEY

The type of the policy that has to be supported by target parts.

Constructor Detail

FXRotateTool

public FXRotateTool()

Method Detail

getRotatePolicies

protected java.util.Set<? extends AbstractFXOnRotatePolicy> getRotatePolicies(IVisualPart<javafx.scene.Node,? extends javafx.scene.Node> targetPart)

Returns a Set containing all AbstractFXOnRotatePolicys that are installed on the given target IVisualPart.

Parameters:

targetPart - The target IVisualPart of which the AbstractFXOnRotatePolicys are returned.

Returns:

A Set containing all AbstractFXOnRotatePolicys that are installed on the given target IVisualPart.

getTargetPart

protected IVisualPart<javafx.scene.Node,? extends javafx.scene.Node> getTargetPart(IViewer<javafx.scene.Node> viewer,
                                                                                   javafx.scene.Node target)

Returns the target IVisualPart within the given IViewer for the given target Node that received the input event.

Parameters:

viewer - The IViewer in which a target IVisualPart is searched.

target - The target Node that received the input event.

Returns:

The determined target IVisualPart.

getTargetPolicies

protected java.util.Set<? extends AbstractFXOnRotatePolicy> getTargetPolicies(IViewer<javafx.scene.Node> viewer,
                                                                              javafx.scene.input.RotateEvent e)

Returns a Set containing all AbstractFXOnRotatePolicys that are installed on the target IVisualPart for the given RotateEvent. The target IVisualPart is determined using getTargetPart(IViewer, Node).

Parameters:

viewer - The IViewer in which the input event occured.

e - The input RotateEvent.

Returns:

A Set containing all AbstractFXOnRotatePolicys that are installed on the target IVisualPart for the given input event.

registerListeners

protected void registerListeners()

Description copied from class: AbstractTool

This method is called when a valid IDomain is attached to this tool so that you can register event listeners for various inputs (keyboard, mouse) or model changes (selection, scroll offset / viewport).

Overrides:

registerListeners in class AbstractTool<javafx.scene.Node>

unregisterListeners

protected void unregisterListeners()

Description copied from class: AbstractTool

This method is called when the attached IDomain is reset to null so that you can unregister previously registered event listeners.

Overrides:

unregisterListeners in class AbstractTool<javafx.scene.Node>