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

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.FigDataType
                          org.argouml.uml.diagram.static_structure.ui.FigEnumeration

All Implemented Interfaces:

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

public class FigEnumeration

extends FigDataType

implements EnumLiteralsCompartmentContainer

Class to display graphics for a UML Enumeration in a diagram. It depends on FigDataType for most of its behavior.

See Also:

Serialized Form

FigEnumeration

public FigEnumeration()

Main constructor for a FigEnumeration.

FigEnumeration

public FigEnumeration(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 FigDataType

See Also:

FigDataType.makeSelection()

clone

public Object clone()

Description copied from class: FigNodeModelElement

After the base clone method has been called determine which child figs of the clone represent the name, stereotype and port.

The clone function is used by Copy/Paste operations.

Overrides:

clone in class FigClassifierBox

See Also:

TODO: Is this actually needed? - tfm

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 FigDataType

Parameters:

me - a mouse event

Returns:

a collection of menu items

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 FigDataType

See Also:

FigNodeModelElement.modelChanged(java.beans.PropertyChangeEvent)

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 FigDataType

See Also:

FigNodeModelElement.renderingChanged()

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)

updateEnumLiterals

protected void updateEnumLiterals()

Update (i.e. redraw) the compartment with the literals.

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 FigDataType

Throws:

PropertyVetoException

See Also:

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

getMinimumSize

public Dimension getMinimumSize()

Gets the minimum size permitted for a enumeration on the diagram.

Overrides:

getMinimumSize in class FigDataType

Returns:

the size of the minimum bounding box.

setBoundsImpl

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

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

Overrides:

setBoundsImpl in class FigDataType

Parameters:

x - Desired X coordinate of upper left corner

y - Desired Y coordinate of upper left corner

w - Desired width of the figure

h - Desired height of the figure

See Also:

Fig.setBoundsImpl(int, int, int, int)

getLiteralsCompartment

public FigEnumLiteralsCompartment getLiteralsCompartment()

Returns:

the Fig for the EnumerationLiterals compartment

isEnumLiteralsVisible

public boolean isEnumLiteralsVisible()

Description copied from interface: EnumLiteralsCompartmentContainer

Determine if the EnumerationLiterals compartment is visible.

Specified by:

isEnumLiteralsVisible in interface EnumLiteralsCompartmentContainer

Returns:

true if the literals compartment is visible

setEnumLiteralsVisible

public void setEnumLiteralsVisible(boolean isVisible)

Description copied from interface: EnumLiteralsCompartmentContainer

Set the visibility of the EnumerationLiterals compartment.

Specified by:

setEnumLiteralsVisible in interface EnumLiteralsCompartmentContainer

Parameters:

isVisible - true will show the enumeration literal compartment

getEnumLiteralsBounds

public Rectangle getEnumLiteralsBounds()

Specified by:

getEnumLiteralsBounds in interface EnumLiteralsCompartmentContainer

Returns:

the bounds of the EnumerationLiterals compartment