org.modelio.api.modelio.diagram.tools

Class DefaultMultiLinkTool

java.lang.Object

org.modelio.api.modelio.diagram.tools.DefaultDiagramTool

org.modelio.api.modelio.diagram.tools.DefaultMultiLinkTool

All Implemented Interfaces:

IDiagramTool, IMultiLinkTool

Direct Known Subclasses:

GenericMultiLinkTool

public abstract class DefaultMultiLinkTool
extends DefaultDiagramTool
implements IMultiLinkTool

Interface for complex graphic creation interaction in a diagram.

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 multi link in the diagram.
The acceptFirstElement method is called to know if the element flown over by the mouse is valid to be the first element of the interaction. If it is not valid as first element, then the acceptLastElement method is called to know if the element flown over by the mouse is valid as last element of the interaction (in which case the interaction is done with a single click, as is the case for IBoxCommand for example).
If the element is valid as first element the interaction moves on to the next step. The acceptAdditionalElement method is called to know if the element flown over by the mouse can be added to the current interaction. If it is not valid to be added to the current interaction, then the acceptLastElement method is called to know if the element flown over by the mouse is valid as last element of the interaction.
When the user clicks on an element for which the acceptAdditionalElement method doesn't accept the element to be added to the interaction but the acceptLastElement method accepts the element as last element of the interaction, the actionPerformed method is called.

The actionPerformed method is in charge of creating the elements in the model and of unmasking them in the diagram. This interface is intended to be implemented by MDA Components in order to add commands in a diagram palette.

Constructor Summary

Constructors

Constructor and Description
DefaultMultiLinkTool() Construct a DefaultMultiLinkCommand .

Method Summary

Modifier and Type	Method and Description
abstract boolean	acceptAdditionalElement(IDiagramHandle diagramHandle, java.util.List<IDiagramGraphic> previousNodes, IDiagramGraphic targetNode) This method accept or refuse the interaction with the diagram for an additional element of the interaction.
abstract boolean	acceptFirstElement(IDiagramHandle diagramHandle, IDiagramGraphic targetNode) This method accept or refuse the interaction in the diagram for the first element.
abstract boolean	acceptLastElement(IDiagramHandle diagramHandle, java.util.List<IDiagramGraphic> otherNodes, IDiagramGraphic targetNode) This method accept or refuse the interaction with the diagram for the "last" element of the interaction.
abstract void	actionPerformed(IDiagramHandle diagramHandle, IDiagramGraphic lastNode, java.util.List<IDiagramGraphic> otherNodes, java.util.List<IDiagramLink.LinkRouterKind> routerKinds, java.util.List<ILinkPath> paths, Rectangle rectangle) This method is invoked when the command is launched.

Methods inherited from class org.modelio.api.modelio.diagram.tools.DefaultDiagramTool

decorate, findStereotypeFromSpec, getBitmap, getLabel, getModule, getParameter, getParameters, getSourceScopes, getTargetScopes, getTooltip, initialize

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.modelio.api.modelio.diagram.tools.IDiagramTool

decorate, getBitmap, getLabel, getModule, getParameters, getSourceScopes, getTargetScopes, getTooltip, initialize

Constructor Detail

DefaultMultiLinkTool

public DefaultMultiLinkTool()

Construct a DefaultMultiLinkCommand .

Method Detail

acceptFirstElement

public abstract boolean acceptFirstElement(IDiagramHandle diagramHandle,
                                           IDiagramGraphic targetNode)

This method accept or refuse the interaction in the diagram for the first element.

This method is called until the user clicks on an element.
If the interaction is allowed the method return new InteractionStatus(true, "");
If the interaction is not allowed the method return new InteractionStatus(false, "Tooltip message"); . In this case the acceptLastElement method is called with the same arguments, to check if the pointed element could be the last of the interaction.

Specified by:

acceptFirstElement in interface IMultiLinkTool

Parameters:

diagramHandle - the representation of the diagram in which the interaction occurs.

targetNode - the graphic that is below the mouse pointer.

Returns:

an InteractionStatus that represents the result of the acceptFirstElement method.

acceptAdditionalElement

public abstract boolean acceptAdditionalElement(IDiagramHandle diagramHandle,
                                                java.util.List<IDiagramGraphic> previousNodes,
                                                IDiagramGraphic targetNode)

This method accept or refuse the interaction with the diagram for an additional element of the interaction.

This method is called after the method acceptFirstElement returned true, to check whether the target element could be valid as an additional element of the interaction.
If the interaction is allowed the method return new InteractionStatus(true, "");
If the interaction is not allowed the method return new InteractionStatus(false, "Tooltip message"); . In this case the acceptLastElement method is called with the same arguments, to check if the pointed element could be the last of the interaction.

Specified by:

acceptAdditionalElement in interface IMultiLinkTool

Parameters:

diagramHandle - the representation of the diagram in which the interaction occurs.

previousNodes - the graphics accepted until now (might be empty).

targetNode - the graphic that is below the mouse pointer.

Returns:

an InteractionStatus that represents the result of the acceptAdditionalElement method.

acceptLastElement

public abstract boolean acceptLastElement(IDiagramHandle diagramHandle,
                                          java.util.List<IDiagramGraphic> otherNodes,
                                          IDiagramGraphic targetNode)

This method accept or refuse the interaction with the diagram for the "last" element of the interaction.

This method is called after the method acceptFirstElement (or acceptAdditionalElement, depending on the case) returned false, to check whether the target element could be valid as the last element of the interaction.
If the interaction is allowed the method return new InteractionStatus(true, "");
If the interaction is not allowed the method return new InteractionStatus(false, "Tooltip message"); . In this case the mouse pointer is changed to a "forbidden" icon and the tooltip message is displayed in a tooltip near the mouse pointer

Specified by:

acceptLastElement in interface IMultiLinkTool

Parameters:

diagramHandle - the representation of the diagram in which the interaction occurs.

otherNodes - the graphics accepted until now (might be empty).

targetNode - the graphic that is below the mouse pointer.

Returns:

an InteractionStatus that represents the result of the acceptLastElement method.

actionPerformed

public abstract void actionPerformed(IDiagramHandle diagramHandle,
                                     IDiagramGraphic lastNode,
                                     java.util.List<IDiagramGraphic> otherNodes,
                                     java.util.List<IDiagramLink.LinkRouterKind> routerKinds,
                                     java.util.List<ILinkPath> paths,
                                     Rectangle rectangle)

This method is invoked when the command is launched.

The actionPerformed is called after user has choosen the last destination.
The method is in charge of creating the element(s) in the model and of unmasking it (them) in the diagram.
lastNode is the graphic accepted by the acceptLastElement method. otherNodes are all the graphics accepted by calls to acceptFirstNode and acceptAdditionalNode.

Specified by:

actionPerformed in interface IMultiLinkTool

Parameters:

diagramHandle - the representation of the diagram where the command has been triggered.

lastNode - the last graphic accepted.

otherNodes - all previous accepted graphics.

routerKinds - the router types that are currently defined to compute the path of the links from the previously accepted graphics to the element to create.

paths - the link paths deduced from the user interactions.

rectangle - the rectangle of the object to create.

See Also:

IDiagramHandle.unmask(MObject, int, int)