Package gui.tool

Interface Tool

All Superinterfaces:

PageEventHandler

All Known Implementing Classes:

AudioTool, ColourTool, HyperlinkTool, ImageTool, MediaTool, PenTool, SearchTool, ShapeTool, TagTool, TextTool, VideoTool

public interface Tool
extends PageEventHandler

Interface to be implemented by tools to provide the GUI with which they are configured as well as the graphic which represents them in the toolbar.

Tools provide the following:

• A "graphic" which will be displayed in the toolbar.
• The name of the tool.
• The GUI with which the tool is configured.

Nested Class Summary

Nested classes/interfaces inherited from interface gui.page.PageEventHandler

PageEventHandler.HandlerMethod<T extends javafx.event.Event>

Method Summary

Modifier and Type	Method	Description
default javafx.scene.Node	getGraphic()	Return the "graphic" to show in the toolbar for this tool.
default String	getName()	Return the name of this tool.
default javafx.scene.Node	getSettingsGUI()	Return the GUI element which configures the settings for this tool.

Methods inherited from interface gui.page.PageEventHandler

disabledFor, enabledFor, getHandlerMethods

Method Details

getGraphic

default javafx.scene.Node getGraphic()

Return the "graphic" to show in the toolbar for this tool.

getName

default String getName()

Return the name of this tool.

getSettingsGUI

default javafx.scene.Node getSettingsGUI()

Return the GUI element which configures the settings for this tool.

The returned Node will be shown in the tool pane when this tool is selected.