Package org.kie.workbench.common.stunner.core.client.components.toolbox.actions

Interface ToolboxAction<H extends org.kie.workbench.common.stunner.core.client.canvas.CanvasHandler>

Type Parameters:

H - The canvas handler type.

All Known Implementing Classes:

AbstractToolboxAction, CreateConnectorToolboxAction, CreateNodeToolboxAction, DeleteNodeToolboxAction, MorphNodeToolboxAction

public interface ToolboxAction<H extends org.kie.workbench.common.stunner.core.client.canvas.CanvasHandler>

It describes and performs an action/operation that can be done from a Toolbox.

It's displayed as a button for the ActionsToolbox.

Method Summary

Modifier and Type	Method	Description
org.kie.workbench.common.stunner.core.definition.shape.Glyph	getGlyph(H canvasHandler, String uuid)	The glyph that is being rendered as for the toolbox button's shape/icon.
String	getTitle(H canvasHandler, String uuid)	The title to display for the toolbox' button.
ToolboxAction<H>	onMouseClick(H canvasHandler, String uuid, org.kie.workbench.common.stunner.core.client.shape.view.event.MouseClickEvent event)	The operation to perform once clicking on the toolbox' button.

Method Detail

getGlyph

org.kie.workbench.common.stunner.core.definition.shape.Glyph getGlyph(H canvasHandler,
                                                                      String uuid)

The glyph that is being rendered as for the toolbox button's shape/icon.

Parameters:

canvasHandler - The toolbox' canvas handler instance.

uuid - The toolbox' element identifier.

Returns:

The glyph definition that will be rendered as for the toolbox button's shape/icon.

getTitle

String getTitle(H canvasHandler,
                String uuid)

The title to display for the toolbox' button.

Parameters:

canvasHandler - The toolbox' canvas handler instance.

uuid - The toolbox' element identifier.

Returns:

The title to display for the toolbox' button.

onMouseClick

ToolboxAction<H> onMouseClick(H canvasHandler,
                              String uuid,
                              org.kie.workbench.common.stunner.core.client.shape.view.event.MouseClickEvent event)

The operation to perform once clicking on the toolbox' button.

Parameters:

canvasHandler - The toolbox' canvas handler instance.

uuid - The toolbox' element identifier.

Returns:

This instance (cascade).