org.eclipse.gef4.mvc.fx.tools

Class FXPinchSpreadTool

java.lang.Object

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

org.eclipse.gef4.mvc.fx.tools.FXPinchSpreadTool

All Implemented Interfaces:

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

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

An ITool to handle pinch/spread (zoom) interaction gestures.

During each pinch/spread 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 AbstractFXOnPinchSpreadPolicy (see getTargetPart(IViewer, Node)).

The FXPinchSpreadTool 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<AbstractFXOnPinchSpreadPolicy>	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
FXPinchSpreadTool()

Method Summary

Modifier and Type	Method and Description
protected java.util.Set<? extends AbstractFXOnPinchSpreadPolicy>	getPinchSpreadPolicies(IVisualPart<javafx.scene.Node,? extends javafx.scene.Node> targetPart) Returns a Set containing all AbstractFXOnPinchSpreadPolicys 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 for the given target Node within the given IViewer.
protected java.util.Set<? extends AbstractFXOnPinchSpreadPolicy>	getTargetPolicies(IViewer<javafx.scene.Node> viewer, javafx.scene.input.ZoomEvent e) Returns a Set containing all AbstractFXOnPinchSpreadPolicys that are supported by the target IVisualPart for the given ZoomEvent.
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<AbstractFXOnPinchSpreadPolicy> TOOL_POLICY_KEY

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

Constructor Detail

FXPinchSpreadTool

public FXPinchSpreadTool()

Method Detail

getPinchSpreadPolicies

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

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

Parameters:

targetPart - The target IVisualPart of which the installed AbstractFXOnPinchSpreadPolicys are returned.

Returns:

A Set containing all AbstractFXOnPinchSpreadPolicys 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 for the given target Node within the given IViewer.

Parameters:

viewer - The IViewer which is searched for the target IVisualPart.

target - The target Node that received the input event.

Returns:

The target IVisualPart that was determined.

getTargetPolicies

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

Returns a Set containing all AbstractFXOnPinchSpreadPolicys that are supported by the target IVisualPart for the given ZoomEvent.

Parameters:

viewer - The IViewer that is searched for a target IVisualPart.

e - The ZoomEvent that has to be transfered.

Returns:

A Set containing all AbstractFXOnPinchSpreadPolicys that are supported by the target IVisualPart for the given ZoomEvent.

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>