Package dk.gtz.graphedit.tool

Class EdgeDeleteTool

java.lang.Object

dk.gtz.graphedit.tool.AbstractBaseTool

dk.gtz.graphedit.tool.EdgeDeleteTool

All Implemented Interfaces:

ITool

public class EdgeDeleteTool
extends AbstractBaseTool

Tool to delete edges between vertices. When selected, click an edge to delete it.

Constructor Summary

Constructors

Constructor	Description
EdgeDeleteTool()	Create a new instance of the edge delete tool

Method Summary

Modifier and Type	Method	Description
void	delete(ViewModelProjectResource buffer, UUID edgeId, ViewModelEdge edge, ViewModelGraph graph)	Deletes a specified edge
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	onEdgeMouseEvent(EdgeMouseEvent e)	Event handler for the case where an edge has been interacted with with the mouse

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

onKeyEvent, onVertexMouseEvent, onViewportMouseEvent

Methods inherited from class java.lang.Object

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

Constructor Details

EdgeDeleteTool

public EdgeDeleteTool()

Create a new instance of the edge delete tool

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

onEdgeMouseEvent

public void onEdgeMouseEvent(EdgeMouseEvent e)

Description copied from interface: ITool

Event handler for the case where an edge has been interacted with with the mouse

Specified by:

onEdgeMouseEvent in interface ITool

Overrides:

onEdgeMouseEvent in class AbstractBaseTool

Parameters:

e - The event that happened

delete

public void delete(ViewModelProjectResource buffer,
 UUID edgeId,
 ViewModelEdge edge,
 ViewModelGraph graph)

Deletes a specified edge

Parameters:

buffer - The buffer containing the edge to delete (used for undo/redo)

edgeId - The id of the edge to delete

edge - The edge to delete

graph - The graph containing the edge to delete