org.argouml.uml.diagram.static_structure.ui
Class FigInterface

java.lang.Object
  org.tigris.gef.presentation.Fig
      org.tigris.gef.presentation.FigGroup
          org.tigris.gef.presentation.FigNode
              org.argouml.uml.diagram.ui.FigNodeModelElement
                  org.argouml.uml.diagram.static_structure.ui.FigClassifierBox
                      org.argouml.uml.diagram.static_structure.ui.FigInterface

All Implemented Interfaces:

ArgoEventListener, ArgoNotationEventListener, Cloneable, Connecter, DelayedVChangeListener, EventListener, org.tigris.gef.di.GraphicElement, org.tigris.gef.di.GraphNode, Highlightable, KeyListener, MouseListener, NotationContext, OperationsCompartmentContainer, PathContainer, PopupGenerator, PropertyChangeListener, Serializable, VetoableChangeListener

public class FigInterface

extends FigClassifierBox

Class to display graphics for a UML Interface in a diagram.

See Also:

Serialized Form

FigInterface

public FigInterface()

Main constructor for a FigInterface. Parent FigNodeModelElement will have created the main box FigNodeModelElement.getBigPort() and its name FigNodeModelElement.getNameFig() and stereotype (@link #getStereotypeFig()}. This constructor creates a box for the operations.

The properties of all these graphic elements are adjusted appropriately. The main boxes are all filled and have outlines.

For reasons I don't understand the stereotype is created in a box with lines. So we have to created a blanking rectangle to overlay the bottom line, and avoid three compartments showing.

Warning. Much of the graphics positioning is hard coded. The overall figure is placed at location (10,10). The name compartment (in the parent FigNodeModelElement is 21 pixels high. The stereotype compartment is created 15 pixels high in the parent, but we change it to 19 pixels, 1 more than (FigNodeModelElement.STEREOHEIGHT here. The operations box is created at 19 pixels, 2 more than FigNodeModelElement.ROWHEIGHT.

CAUTION: This constructor (with no arguments) is the only one that does enableSizeChecking(false), all others must set it true. This is because this constructor is the only one called when loading a project. In this case, the parsed size must be maintained.

FigInterface

public FigInterface(GraphModel gm,
                    Object node)

Constructor for use if this figure is created for an existing interface node in the metamodel.

Parameters:

gm - Not actually used in the current implementation

node - The UML object being placed.

makeSelection

public Selection makeSelection()

Overrides:

makeSelection in class FigNodeModelElement

See Also:

Fig.makeSelection()

getPopUpActions

public Vector getPopUpActions(MouseEvent me)

Build a collection of menu items relevant for a right-click popup menu on an Interface.

Specified by:

getPopUpActions in interface PopupGenerator

Overrides:

getPopUpActions in class FigNodeModelElement

Parameters:

me - a mouse event

Returns:

a collection of menu items

See Also:

PopupGenerator.getPopUpActions(java.awt.event.MouseEvent)

setOperationsVisible

public void setOperationsVisible(boolean isVisible)

Description copied from interface: OperationsCompartmentContainer

Set the visibility of the operations compartment.

Parameters:

isVisible - true will show the operations compartiment

getMinimumSize

public Dimension getMinimumSize()

Gets the minimum size permitted for an interface on the diagram.

Parts of this are hardcoded, notably the fact that the name compartment has a minimum height of 21 pixels.

Returns:

the size of the minimum bounding box.

setLineWidth

public void setLineWidth(int w)

See Also:

Fig.setLineWidth(int)

getLineWidth

public int getLineWidth()

See Also:

Fig.getLineWidth()

translate

public void translate(int dx,
                      int dy)

Overrides:

translate in class FigClassifierBox

See Also:

Fig.translate(int, int)

setEnclosingFig

public void setEnclosingFig(Fig encloser)

Description copied from class: FigNodeModelElement

Updates the modelelement container if the fig is moved in or out another fig. If this fig doesn't have an enclosing fig anymore, the namespace of the diagram will be the owning modelelement. If this fig is moved inside another FigNodeModelElement the owner of that fignodemodelelement will be the owning modelelement.

Overrides:

setEnclosingFig in class FigNodeModelElement

See Also:

Fig.setEnclosingFig(org.tigris.gef.presentation.Fig)

textEdited

protected void textEdited(FigText ft)
                   throws PropertyVetoException

Description copied from class: FigNodeModelElement

This method is called after the user finishes editing a text field that is in the FigNodeModelElement. Determine which field and update the model. This class handles the name, and the stereotype, subclasses should override to handle other text elements.

Overrides:

textEdited in class FigNodeModelElement

Parameters:

ft - the FigText that has been edited and contains the new text

Throws:

PropertyVetoException - thrown when new text represents an unacceptable value

See Also:

FigNodeModelElement.textEdited( org.tigris.gef.presentation.FigText)

textEditStarted

protected void textEditStarted(FigText ft)

Description copied from class: FigNodeModelElement

This method is called when the user doubleclicked on the text field, and starts editing. Subclasses should overrule this field to e.g. supply help to the user about the used format.

It is also possible to alter the text to be edited already here, e.g. by adding the stereotype in front of the name, by calling notationProviderName.putValue("fullyHandleStereotypes", true);, but that seems not user-friendly. See issue 3838.

Overrides:

textEditStarted in class FigNodeModelElement

Parameters:

ft - the FigText that will be edited and contains the start-text

See Also:

FigNodeModelElement.textEditStarted( org.tigris.gef.presentation.FigText)

getPreviousVisibleFeature

protected FigText getPreviousVisibleFeature(FigText ft,
                                            int i)

Parameters:

ft - the figtext holding the feature

i - the index (?)

Returns:

the figtext

getNextVisibleFeature

protected FigText getNextVisibleFeature(FigText ft,
                                        int i)

Parameters:

ft - the figtext holding the feature

i - the index (?)

Returns:

the figtext

classNameAndBounds

public String classNameAndBounds()

USED BY PGML.tee.

Overrides:

classNameAndBounds in class FigNodeModelElement

Returns:

the class name and bounds together with compartment visibility.

modelChanged

protected void modelChanged(PropertyChangeEvent mee)

Description copied from class: FigNodeModelElement

This is called after any part of the UML MModelElement has changed. This method automatically updates the name FigText. Subclasses should override and update other parts.

Overrides:

modelChanged in class FigNodeModelElement

Parameters:

mee - the ModelElementEvent that caused the change

See Also:

FigNodeModelElement.modelChanged( java.beans.PropertyChangeEvent)

updateListeners

protected void updateListeners(Object oldOwner,
                               Object newOwner)

Description copied from class: FigNodeModelElement

Implementations of this method should register/unregister the fig for all (model)events. For FigNodeModelElement only the fig itself is registered as listening to events fired by the owner itself. But for, for example, FigClass the fig must also register for events fired by the operations and attributes of the owner.

An explanation of the original purpose of this method is given in issue 1321.

This function is used in UMLDiagram, which removes all listeners to all Figs when a diagram is not displayed, and restore them when it becomes visible again.

In this case, it is imperative that indeed ALL listeners are updated, since they are ALL removed by the call to removeElementListener.

Additionally, this function may be used by the modelChanged() function.

In this case, it is also imperative that all listeners get removed / added.

Overrides:

updateListeners in class FigNodeModelElement

Parameters:

newOwner - null, or the owner of this. The former means that listeners have to be removed, the latter that they have to be set. TODO: Should this not be boolean, to clarify?

See Also:

org.argouml.uml.diagram.ui.FigNodeModelElement#updateListeners(java.lang.Object)

renderingChanged

public void renderingChanged()

Description copied from class: FigNodeModelElement

Rerenders the fig.

This functionality was originally the functionality of modelChanged but modelChanged takes the event now into account.

Overrides:

renderingChanged in class FigNodeModelElement

See Also:

FigNodeModelElement.renderingChanged()

setBoundsImpl

protected void setBoundsImpl(int x,
                             int y,
                             int w,
                             int h)

Sets the bounds, but the size will be at least the one returned by getMinimumSize(), unless checking of size is disabled.

If the required height is bigger, then the additional height is equally distributed among all figs (i.e. compartments), such that the cumulated height of all visible figs equals the demanded height

. Some of this has "magic numbers" hardcoded in. In particular there is a knowledge that the minimum height of a name compartment is 21 pixels.

Parameters:

x - Desired X coordinate of upper left corner

y - Desired Y coordinate of upper left corner

w - Desired width of the FigInterface

h - Desired height of the FigInterface