Package gui.tool

Class ColourTool

java.lang.Object

gui.tool.ColourTool

All Implemented Interfaces:

PageEventHandler, Tool

public class ColourTool
extends Object
implements Tool

Provides a GUI for choosing a colour. The selected colour can be used by other tools.

Property Summary

Properties

Type	Property	Description
javafx.beans.property.ObjectProperty<javafx.scene.paint.Color>	colour	Return an ObjectProperty wrapping the currently selected colour.

Nested Class Summary

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

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

Constructor Summary

Constructors

Constructor	Description
ColourTool()

Method Summary

Modifier and Type	Method	Description
javafx.beans.property.ObjectProperty<javafx.scene.paint.Color>	colourProperty()	Return an ObjectProperty wrapping the currently selected colour.
javafx.scene.Node	getGraphic()	Return the "graphic" to show in the toolbar for this tool.
String	getName()	Return the name of this tool.
javafx.scene.layout.FlowPane	getSettingsGUI()	Return the GUI element which configures the settings for this tool.

Methods inherited from class java.lang.Object

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

Methods inherited from interface gui.page.PageEventHandler

disabledFor, enabledFor, getHandlerMethods

Property Details

colour

public javafx.beans.property.ObjectProperty<javafx.scene.paint.Color> colourProperty

Return an ObjectProperty wrapping the currently selected colour. This allows users of this class to listen for changes to the currently selected colour.

Constructor Details

ColourTool

public ColourTool()

Method Details

getName

public String getName()

Description copied from interface: Tool

Return the name of this tool.

Specified by:

getName in interface Tool

getGraphic

public javafx.scene.Node getGraphic()

Description copied from interface: Tool

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

Specified by:

getGraphic in interface Tool

getSettingsGUI

public javafx.scene.layout.FlowPane getSettingsGUI()

Description copied from interface: Tool

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.

Specified by:

getSettingsGUI in interface Tool

colourProperty

public javafx.beans.property.ObjectProperty<javafx.scene.paint.Color> colourProperty()

Return an ObjectProperty wrapping the currently selected colour. This allows users of this class to listen for changes to the currently selected colour.