org.eclipse.gef4.mvc.fx.tools

Class FXScrollTool

java.lang.Object

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

org.eclipse.gef4.mvc.fx.tools.FXScrollTool

All Implemented Interfaces:

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

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

The FXScrollTool is an AbstractTool that handles mouse scroll events.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.Class<AbstractFXOnScrollPolicy>	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
FXScrollTool()

Method Summary

Modifier and Type	Method and Description
protected java.util.Set<? extends AbstractFXOnScrollPolicy>	getScrollPolicies(IVisualPart<javafx.scene.Node,? extends javafx.scene.Node> targetPart) Returns a Set containing all AbstractFXOnScrollPolicys that are installed on the given target IVisualPart.
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<AbstractFXOnScrollPolicy> TOOL_POLICY_KEY

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

Constructor Detail

FXScrollTool

public FXScrollTool()

Method Detail

getScrollPolicies

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

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

Parameters:

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

Returns:

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

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>