public abstract class DefaultBoxTool extends DefaultDiagramTool implements IBoxTool
In a diagram, graphic boxes are graphic objects that display diagram nodes. For example Packages and Classes
are graphic boxes. IBoxCommand is the interface that drives the interaction of creating a box
The interaction is started when the user clicks on the button in the diagram palette. Once the interaction is started
the user can use the mouse to create a new graphic box in the diagram. The
acceptElement method is called to know if the element
flown over by the mouse is valid for the command. If it is not valid the user cannot finish the interaction. If the
element is valid the user can terminates the interaction by either clicking or by pressing the left mouse button
doing a drag and drop and releasing the mouse button. Once this is done the
actionPerformed is called.
The actionPerformed does nothing in
this default implementation.
Subclass the DefaultBoxCommand to provide a behavior to the
actionPerformed method.
| Constructor and Description |
|---|
DefaultBoxTool() |
| Modifier and Type | Method and Description |
|---|---|
abstract boolean |
acceptElement(IDiagramHandle diagramHandle,
IDiagramGraphic targetNode)
This method accept or refuse the interaction in the diagram.
|
abstract void |
actionPerformed(IDiagramHandle diagramHandle,
IDiagramGraphic parent,
Rectangle rect)
This method is called when the interaction is validated by the user.
|
decorate, findStereotypeFromSpec, getBitmap, getLabel, getModule, getParameter, getParameters, getSourceScopes, getTargetScopes, getTooltip, initializeclone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, waitdecorate, getBitmap, getLabel, getModule, getParameters, getSourceScopes, getTargetScopes, getTooltip, initializepublic abstract boolean acceptElement(IDiagramHandle diagramHandle, IDiagramGraphic targetNode)
This method is called until the interaction is validated by the user.
This default implementation always accept the interaction.
acceptElement in interface IBoxTooldiagramHandle - the representation of the diagram in which the interaction occurs.targetNode - the graphic that is below the mouse pointer.public abstract void actionPerformed(IDiagramHandle diagramHandle, IDiagramGraphic parent, Rectangle rect)
This default implementation does nothing.
If the user click or click and drag in a graphic box the parent argument contains the diagram node container corresponding to graphic box. If the user click or click and drag in the diagram background parent is null.
The rect argument is the rectangle that result from the user interaction with the diagram. This rect should be used to manage the unmasking of the model element in the diagram.
actionPerformed in interface IBoxTooldiagramHandle - the representation of the diagram where the command has been triggered.parent - the graphic parent where the user has clicked.rect - the rectangle of the object to create.IDiagramHandle.unmask(MObject, int, int)