org.argouml.uml.diagram.collaboration.ui
Class FigClassifierRole

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.collaboration.ui.FigClassifierRole

All Implemented Interfaces:

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

public class FigClassifierRole

extends FigNodeModelElement

Class to display graphics for a UML classifier role in a collaboration diagram.

Stereotype (if there is one) and name are displayed in the centre of the box.

See Also:

Serialized Form

FigClassifierRole

public FigClassifierRole()

Constructor for a new classifier role.

An invisible FigRect as the point of contact for connections (FigNodeModelElement#bigPort), with matching rectangle providing the graphic rendering (#cover). Stereotype and name are rendered centrally in the rectangle.

FigClassifierRole

public FigClassifierRole(GraphModel gm,
                         Layer lay,
                         Object node)

Variant constructor that associates the classifier role with a particular model element.

Classifier role is constructed with FigClassifierRole().

Parameters:

gm - The graph model to use. Ignored in this implementation.

lay - The layer

node - The model element object to associate with this Fig.

initNotationProviders

protected void initNotationProviders(Object own)

Description copied from class: FigNodeModelElement

Create the NotationProviders.

Overrides:

initNotationProviders in class FigNodeModelElement

Parameters:

own - the current owner

See Also:

FigNodeModelElement.initNotationProviders(java.lang.Object)

placeString

public String placeString()

Return the default name to use for this classifier role.

Seems to be immediately overwritten by the empty string, but may be useful in defining the default name size?

Overrides:

placeString in class FigNodeModelElement

Returns:

The string to use ("new Classifier Role" in this case).

clone

public Object clone()

Version of the clone to ensure all sub-figs are copied.

Uses the generic superclass clone which gives a vector of all the figs. Then initialize our instance variables from this vector.

Overrides:

clone in class FigNodeModelElement

Returns:

A new copy of the the current fig.

See Also:

Object.clone()

updateStereotypeText

protected void updateStereotypeText()

Update the stereotype text.

If the stereotype text is non-existant, we must make sure it is marked not displayed, and update the display accordingly.

Similarly if there is text, we must make sure it is marked displayed.

Overrides:

updateStereotypeText in class FigNodeModelElement

setLineColor

public void setLineColor(Color col)

See Also:

Fig.setLineColor(java.awt.Color)

getLineColor

public Color getLineColor()

See Also:

Fig.getLineColor()

setFillColor

public void setFillColor(Color col)

See Also:

Fig.setFillColor(java.awt.Color)

getFillColor

public Color getFillColor()

See Also:

Fig.getFillColor()

setFilled

public void setFilled(boolean f)

See Also:

Fig.setFilled(boolean)

getFilled

public boolean getFilled()

See Also:

Fig.getFilled()

setLineWidth

public void setLineWidth(int w)

See Also:

Fig.setLineWidth(int)

getLineWidth

public int getLineWidth()

See Also:

Fig.getLineWidth()

getMinimumSize

public Dimension getMinimumSize()

Work out the minimum size that this Fig can be.

This should be the size of the stereotype + name + padding. However we allow for the possible case that the cover or big port could be bigger still.

Returns:

The minimum size of this fig.

setBoundsImpl

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

Override setBounds to keep shapes looking right.

Set the bounds of all components of the Fig. The stereotype (if any) and name are centred in the fig.

We allow for the requested bounds being too small, and impose our minimum size if necessary.

Parameters:

x - X coordinate of upper left corner

y - Y coordinate of upper left corner

w - width of bounding box

h - height of bounding box

textEdited

protected void textEdited(FigText ft)
                   throws PropertyVetoException

Called after text has been edited directly on the screen.

Overrides:

textEdited in class FigNodeModelElement

Parameters:

ft - The text that was edited.

Throws:

PropertyVetoException - by the parser

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)

updateNameText

protected void updateNameText()

Adjust the fig in the light of some change to the model.

Overrides:

updateNameText in class FigNodeModelElement

See Also:

FigNodeModelElement.updateNameText()

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)

makeSelection

public Selection makeSelection()

Overrides:

makeSelection in class FigNodeModelElement

See Also:

Fig.makeSelection()