org.eclipse.gef4.mvc.fx.tools

Class FXHoverTool

java.lang.Object

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

org.eclipse.gef4.mvc.fx.tools.FXHoverTool

All Implemented Interfaces:

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

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

The FXHoverTool is an AbstractTool that handles mouse hover changes.

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
protected javafx.event.EventHandler<javafx.scene.input.MouseEvent>	createHoverFilter(FXViewer viewer) Creates an EventHandler for hover MouseEvents.
protected java.util.Set<? extends AbstractFXOnHoverPolicy>	getHoverPolicies(IVisualPart<javafx.scene.Node,? extends javafx.scene.Node> targetPart) Returns a Set containing all AbstractFXOnHoverPolicys 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<AbstractFXOnHoverPolicy> TOOL_POLICY_KEY

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

Constructor Detail

FXHoverTool

public FXHoverTool()

Method Detail

createHoverFilter

protected javafx.event.EventHandler<javafx.scene.input.MouseEvent> createHoverFilter(FXViewer viewer)

Creates an EventHandler for hover MouseEvents. The handler will search for a target part within the given FXViewer and notify all hover policies of that target part about hover changes.

If no target part can be identified, then the root part of the given FXViewer is used as the target part.

Parameters:

viewer - The FXViewer for which to create the EventHandler.

Returns:

The EventHandler that handles hover changes for the given FXViewer.

getHoverPolicies

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

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

Parameters:

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

Returns:

A Set containing all AbstractFXOnHoverPolicys 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>