com.modeliosoft.modelio.api.diagram.tools

Interface IDiagramCommand

All Known Subinterfaces:

IAttachedBoxCommand, IBoxCommand, ILinkCommand, IMultiLinkCommand

All Known Implementing Classes:

DefaultAttachedBoxCommand, DefaultBoxCommand, DefaultLinkCommand, DefaultMultiLinkCommand

public interface IDiagramCommand

Basic definition of a command for the diagram palette.
It must provide a label, a tooltip and a bitmap.

Structure Diagram

Method Summary

Methods

Modifier and Type	Method and Description
org.eclipse.jface.resource.ImageDescriptor	getBitmap() Get the command's bitmap.
String	getLabel() Get the name of the command.
String	getTooltip() Gets the tooltip of this command.
void	setBitmap(org.eclipse.jface.resource.ImageDescriptor image) Set the command's bitmap.
void	setLabel(String label) Set the name of the command.
void	setTooltip(String tooltip) Set the tooltip of this command.

Method Detail

getLabel

String getLabel()

Get the name of the command.

Returns:

the name of the command.

getTooltip

String getTooltip()

Gets the tooltip of this command.

Returns:

the text that will be displayed in the command's tooltip.

getBitmap

org.eclipse.jface.resource.ImageDescriptor getBitmap()

Get the command's bitmap.

Returns:

the bitmap ImageDescriptor.

setLabel

void setLabel(String label)

Set the name of the command.

Parameters:

label - the name of the command.

setBitmap

void setBitmap(org.eclipse.jface.resource.ImageDescriptor image)

Set the command's bitmap.

Parameters:

image - the bitmap ImageDescriptor.

setTooltip

void setTooltip(String tooltip)

Set the tooltip of this command.

Parameters:

tooltip - the text that will be displayed in the command's tooltip.