Package dk.gtz.graphedit.tool

Class VertexDeleteTool

java.lang.Object

dk.gtz.graphedit.tool.AbstractBaseTool

dk.gtz.graphedit.tool.VertexDeleteTool

All Implemented Interfaces:

ITool

public class VertexDeleteTool
extends AbstractBaseTool

Tool to delete vertices. When selected, click an vertex to delete it.

Constructor Summary

Constructors

Constructor	Description
VertexDeleteTool()	Construct a new instance

Method Summary

Modifier and Type	Method	Description
void	delete(ViewModelProjectResource buffer, UUID vertexId, ViewModelVertex vertex, ViewModelGraph graph)	Delete a specified vertex
javafx.scene.Node	getGraphic()	Get the graphical representation for the tool selection button.
String	getHelpDescription()	Get a multiline string that describe the tool and how to use it
Optional<String>	getTooltip()	Get a multiline tooltip string that briefly describes this tool
void	onVertexMouseEvent(VertexMouseEvent e)	Event handler for the case where a vertex has been interacted with with the mouse

Methods inherited from class dk.gtz.graphedit.tool.AbstractBaseTool

onEdgeMouseEvent, onKeyEvent, onViewportMouseEvent

Methods inherited from class java.lang.Object

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

Constructor Details

VertexDeleteTool

public VertexDeleteTool()

Construct a new instance

Method Details

getHelpDescription

public String getHelpDescription()

Description copied from interface: ITool

Get a multiline string that describe the tool and how to use it

Returns:

a (possibly) multiline string

getTooltip

public Optional<String> getTooltip()

Description copied from interface: ITool

Get a multiline tooltip string that briefly describes this tool

Specified by:

getTooltip in interface ITool

Overrides:

getTooltip in class AbstractBaseTool

Returns:

a (possibly) multiline string

getGraphic

public javafx.scene.Node getGraphic()

Description copied from interface: ITool

Get the graphical representation for the tool selection button. Typically just a FontIcon, but can be anything

Returns:

a javafx node that will be displayed inside the tool selector button

onVertexMouseEvent

public void onVertexMouseEvent(VertexMouseEvent e)

Description copied from interface: ITool

Event handler for the case where a vertex has been interacted with with the mouse

Specified by:

onVertexMouseEvent in interface ITool

Overrides:

onVertexMouseEvent in class AbstractBaseTool

Parameters:

e - The event that happened

delete

public void delete(ViewModelProjectResource buffer,
 UUID vertexId,
 ViewModelVertex vertex,
 ViewModelGraph graph)

Delete a specified vertex

Parameters:

buffer - The buffer that contains the vertex. This is used to push undo actions

vertexId - The id of the vertex to delete

vertex - The viewmodel object of the vertex to delete

graph - The graph that contains the vertex