org.eclipse.gef4.mvc.fx.tools

Class FXClickDragTool

java.lang.Object

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

org.eclipse.gef4.mvc.fx.tools.FXClickDragTool

All Implemented Interfaces:

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

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

An ITool to handle click/drag interaction gestures.

As click and drag are 'overlapping' gestures (a click is part of each drag, which is composed out of click, drag, and release), these are handled together here, even while distinct interaction policies will be queried to handle the respective gesture parts.

During each click/drag interaction, the tool identifies respective IVisualParts that serve as interaction targets for click and drag respectively. They are identified via hit-testing on the visuals and the availability of a corresponding AbstractFXOnClickPolicy or AbstractFXOnDragPolicy (see getTargetPart(IViewer, Node, Class)) and can even be temporarily overwritten (see overrideTargetForThisInteraction(EventTarget, IVisualPart)).

The FXClickDragTool 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 (including the click and potential drag part), 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<AbstractFXOnClickPolicy>	CLICK_TOOL_POLICY_KEY The typeKey used to retrieve those policies that are able to handle the click part of the click/drag interaction gesture.
static java.lang.Class<AbstractFXOnDragPolicy>	DRAG_TOOL_POLICY_KEY The typeKey used to retrieve those policies that are able to handle the drag part of the click/drag interaction gesture.

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
FXClickDragTool()

Method Summary

Modifier and Type	Method and Description
protected java.util.Set<? extends AbstractFXOnClickPolicy>	getClickPolicies(IVisualPart<javafx.scene.Node,? extends javafx.scene.Node> targetPart) Returns a Set containing all AbstractFXOnClickPolicys of the given target IVisualPart.
protected java.util.Set<? extends AbstractFXOnDragPolicy>	getDragPolicies(IVisualPart<javafx.scene.Node,? extends javafx.scene.Node> targetPart) Returns a Set containing all AbstractFXOnDragPolicys of the given target IVisualPart.
protected <T extends IPolicy<javafx.scene.Node>> IVisualPart<javafx.scene.Node,? extends javafx.scene.Node>	getTargetPart(IViewer<javafx.scene.Node> viewer, javafx.scene.Node target, java.lang.Class<T> policy) Returns the target IVisualPart for the given target Node within the given IViewer that supports the given policy.
void	overrideTargetForThisInteraction(javafx.event.EventTarget target, IVisualPart<javafx.scene.Node,? extends javafx.scene.Node> targetPart) Registers the given IVisualPart as the target part for all JavaFX events which are send to the given EventTarget during the currently active or next press-drag-release gesture.
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

CLICK_TOOL_POLICY_KEY

public static final java.lang.Class<AbstractFXOnClickPolicy> CLICK_TOOL_POLICY_KEY

The typeKey used to retrieve those policies that are able to handle the click part of the click/drag interaction gesture.

DRAG_TOOL_POLICY_KEY

public static final java.lang.Class<AbstractFXOnDragPolicy> DRAG_TOOL_POLICY_KEY

The typeKey used to retrieve those policies that are able to handle the drag part of the click/drag interaction gesture.

Constructor Detail

FXClickDragTool

public FXClickDragTool()

Method Detail

getClickPolicies

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

Returns a Set containing all AbstractFXOnClickPolicys of the given target IVisualPart.

Parameters:

targetPart - The IVisualPart of which the AbstractFXOnClickPolicys are returned.

Returns:

A Set containing all AbstractFXOnClickPolicys of the given target IVisualPart.

getDragPolicies

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

Returns a Set containing all AbstractFXOnDragPolicys of the given target IVisualPart.

Parameters:

targetPart - The IVisualPart of which the AbstractFXOnDragPolicys are returned.

Returns:

A Set containing all AbstractFXOnDragPolicys of the given target IVisualPart.

getTargetPart

protected <T extends IPolicy<javafx.scene.Node>> IVisualPart<javafx.scene.Node,? extends javafx.scene.Node> getTargetPart(IViewer<javafx.scene.Node> viewer,
                                                                                                                          javafx.scene.Node target,
                                                                                                                          java.lang.Class<T> policy)

Returns the target IVisualPart for the given target Node within the given IViewer that supports the given policy.

If a target override was previously registered for the given Node using overrideTargetForThisInteraction(EventTarget, IVisualPart) , then the override target will be returned (and the override will be removed).

Type Parameters:

T - The type of the policy that has to be supported.

Parameters:

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

target - The target Node that received the input event.

policy - The Class of the policy that has to be supported.

Returns:

The target IVisualPart that was determined.

overrideTargetForThisInteraction

public void overrideTargetForThisInteraction(javafx.event.EventTarget target,
                                             IVisualPart<javafx.scene.Node,? extends javafx.scene.Node> targetPart)

Registers the given IVisualPart as the target part for all JavaFX events which are send to the given EventTarget during the currently active or next press-drag-release gesture.

Parameters:

target - The JavaFX EventTarget for which the given target should be used.

targetPart - The IVisualPart to use as the target for all JavaFX events directed at the given EventTarget.

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>