org.eclipse.gef4.mvc.fx.tools

Class FXTypeTool

java.lang.Object

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

org.eclipse.gef4.mvc.fx.tools.FXTypeTool

All Implemented Interfaces:

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

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

The FXTypeTool is an AbstractTool that handles keyboard input.

Field Summary

Fields

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

Method Summary

Modifier and Type	Method and Description
protected java.util.Set<? extends AbstractFXOnTypePolicy>	getKeyPolicies(IVisualPart<javafx.scene.Node,? extends javafx.scene.Node> targetPart) Returns a Set containing all AbstractFXOnTypePolicys that are installed on the given target IVisualPart.
protected java.util.Set<? extends AbstractFXOnTypePolicy>	getTargetPolicies(javafx.scene.input.KeyEvent event) Returns a Set containing all AbstractFXOnTypePolicys that are installed on the target IVisualPart for the given KeyEvent.
protected java.util.Set<? extends AbstractFXOnTypePolicy>	getTargetPolicies(javafx.scene.Scene scene) Returns a Set containing all AbstractFXOnTypePolicys that are installed on the target IVisualPart for the given Scene.
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<AbstractFXOnTypePolicy> TOOL_POLICY_KEY

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

Constructor Detail

FXTypeTool

public FXTypeTool()

Method Detail

getKeyPolicies

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

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

Parameters:

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

Returns:

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

getTargetPolicies

protected java.util.Set<? extends AbstractFXOnTypePolicy> getTargetPolicies(javafx.scene.input.KeyEvent event)

Returns a Set containing all AbstractFXOnTypePolicys that are installed on the target IVisualPart for the given KeyEvent. The target IVisualPart is determined by using getTargetPolicies(Scene).

Parameters:

event - The KeyEvent to transfer.

Returns:

A Set containing all AbstractFXOnTypePolicys that are installed on the target IVisualPart for the given KeyEvent.

getTargetPolicies

protected java.util.Set<? extends AbstractFXOnTypePolicy> getTargetPolicies(javafx.scene.Scene scene)

Returns a Set containing all AbstractFXOnTypePolicys that are installed on the target IVisualPart for the given Scene. If an IVisualPart within the given Scene has keyboard focus, that part is used as the target part. Otherwise, the root part of the IViewer that is rendered in the given Scene is used as the target part.

Parameters:

scene - The Scene for which to determine the AbstractFXOnTypePolicys that are installed on the target IVisualPart.

Returns:

A Set containing all AbstractFXOnTypePolicys that are installed on the target IVisualPart for the given Scene.

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>