com.ppetrie.paintfx.tools

Class Tool

java.lang.Object

com.ppetrie.paintfx.tools.Tool

Direct Known Subclasses:

DropperTool, EraserTool, LineTool, MoveTool, PenTool, ShapeTool, TextTool

public abstract class Tool
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
protected javafx.scene.control.Button	button The button corresponding to this tool
protected javafx.scene.control.CheckMenuItem	menuItem The menu item corresponding to this tool

Constructor Summary

Constructors

Constructor and Description
Tool(javafx.scene.control.Button button, javafx.scene.control.CheckMenuItem menuItem)

Method Summary

Modifier and Type	Method and Description
javafx.scene.control.Button	getButton()
javafx.scene.control.CheckMenuItem	getMenuItem()
abstract void	handleMouse(javafx.scene.input.MouseEvent e, javafx.event.EventType<? extends javafx.scene.input.MouseEvent> type, PaintController controller) Handles canvas mouse events while this tool is selected
boolean	matches(javafx.event.EventTarget target) Checks whether the tool button or menu item pressed matches this tool

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

button

protected javafx.scene.control.Button button

The button corresponding to this tool

menuItem

protected javafx.scene.control.CheckMenuItem menuItem

The menu item corresponding to this tool

Constructor Detail

Tool

public Tool(javafx.scene.control.Button button,
            javafx.scene.control.CheckMenuItem menuItem)

Method Detail

matches

public boolean matches(javafx.event.EventTarget target)

Checks whether the tool button or menu item pressed matches this tool

Parameters:

target - the tool button or menu item pressed

Returns:

true if the target matches this tool, false otherwise

getMenuItem

public javafx.scene.control.CheckMenuItem getMenuItem()

Returns:

the menu item belonging to this tool

getButton

public javafx.scene.control.Button getButton()

Returns:

the button belonging to this tool

handleMouse

public abstract void handleMouse(javafx.scene.input.MouseEvent e,
                                 javafx.event.EventType<? extends javafx.scene.input.MouseEvent> type,
                                 PaintController controller)

Handles canvas mouse events while this tool is selected

Parameters:

e - the mouse event

type - the type of the mouse event

controller - the program's controller