org.eclipse.gef4.mvc.tools

Interface ITool<VR>

Type Parameters:

VR - The visual root node of the UI toolkit used, e.g. javafx.scene.Node in case of JavaFX.

All Superinterfaces:

IActivatable, IAdaptable.Bound<IDomain<VR>>, IPropertyChangeNotifier

All Known Implementing Classes:

AbstractTool, FXClickDragTool, FXFocusTool, FXHoverTool, FXPinchSpreadTool, FXRotateTool, FXScrollTool, FXTypeTool

public interface ITool<VR>
extends IActivatable, IAdaptable.Bound<IDomain<VR>>

An ITool handles a certain aspect of user interaction. It may react to input mouse, keyboard, and gesture events, as well as to changes to logical models (adapted to the IViewer), which keep track of selection, hover, etc. As an reaction to input events, an ITool may manipulate the IViewer's logical models, or interact with the IViewer's IVisualParts via their respective IPolicys.

Field Summary

Fields inherited from interface org.eclipse.gef4.common.activate.IActivatable

ACTIVE_PROPERTY

Method Summary

Modifier and Type	Method and Description
IDomain<VR>	getDomain() The IDomain, this ITool is adapted to.

Methods inherited from interface org.eclipse.gef4.common.activate.IActivatable

activate, deactivate, isActive

Methods inherited from interface org.eclipse.gef4.common.properties.IPropertyChangeNotifier

addPropertyChangeListener, removePropertyChangeListener

Methods inherited from interface org.eclipse.gef4.common.adapt.IAdaptable.Bound

getAdaptable, setAdaptable

Method Detail

getDomain

IDomain<VR> getDomain()

The IDomain, this ITool is adapted to.

Returns:

The IDomain, this ITool is adapted to, or null if this ITool is not adapted to any IDomain.