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

java.lang.Object
  extended byorg.tigris.gef.presentation.Fig
      extended byorg.tigris.gef.presentation.FigGroup
          extended byorg.tigris.gef.presentation.FigNode
              extended byorg.argouml.uml.diagram.ui.FigNodeModelElement
                  extended byorg.argouml.uml.diagram.collaboration.ui.FigClassifierRole
All Implemented Interfaces:
ArgoEventListener, ArgoNotationEventListener, Cloneable, org.tigris.gef.presentation.Connecter, DelayedVChangeListener, EventListener, org.tigris.gef.ui.Highlightable, KeyListener, MouseListener, NotationContext, org.tigris.gef.ui.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

Nested Class Summary
 
Nested classes inherited from class org.argouml.uml.diagram.ui.FigNodeModelElement
 
Field Summary
private  org.tigris.gef.presentation.FigRect cover
          The fig that is used for the complete classifier role.
private static int PADDING
          The minimum padding above and below the stereotype and name.
 
Fields inherited from class org.argouml.uml.diagram.ui.FigNodeModelElement
ABSTRACT, ACTIVE, LEAF, POPUP_ADD_OFFSET, ROOT, ROWHEIGHT, SHADOW_COLOR_ALPHA, SHADOW_COLOR_VALUE, STEREOHEIGHT
 
Fields inherited from class org.tigris.gef.presentation.FigNode
_blinkPorts, _highlight, ang135, ang225, ang315, ang45
 
Fields inherited from class org.tigris.gef.presentation.FigGroup
_dynObjects, _extraFrameSpace
 
Fields inherited from class org.tigris.gef.presentation.Fig
_allowsSaving, _context, _dashes, _dashPeriod, _dashStyle, _displayed, _fillColor, _filled, _group, _h, _layer, _lineColor, _lineWidth, _locked, _resource, _selected, _shown, _w, _x, _y, an, annotationOwner, annotationStatus, BORDER, MIN_SIZE
 
Constructor Summary
FigClassifierRole()
          Constructor for a new classifier role.
FigClassifierRole(org.tigris.gef.graph.GraphModel gm, org.tigris.gef.base.Layer lay, Object node)
          Variant constructor that associates the classifier role with a particular NSUML object.
 
Method Summary
 Object clone()
          Version of the clone to ensure all sub-figs are copied.
 Color getFillColor()
           
 boolean getFilled()
           
 Color getLineColor()
           
 int getLineWidth()
           
 Dimension getMinimumSize()
          Work out the minimum size that this Fig can be.
 org.tigris.gef.base.Selection makeSelection()
           
protected  void modelChanged(PropertyChangeEvent mee)
          This is called after any part of the UML MModelElement has changed.
 String placeString()
          Return the default name to use for this classifier role.
 void setBounds(int x, int y, int w, int h)
          Override setBounds to keep shapes looking right.
 void setFillColor(Color col)
           
 void setFilled(boolean f)
           
 void setLineColor(Color col)
           
 void setLineWidth(int w)
           
protected  void textEdited(org.tigris.gef.presentation.FigText ft)
          Called after text has been edited directly on the screen.
protected  void updateNameText()
          Adjust the fig in the light of some change to the model.
protected  void updateStereotypeText()
          Update the stereotype text.
 
Methods inherited from class org.argouml.uml.diagram.ui.FigNodeModelElement
addEnclosedFig, addFig, allowRemoveFromDiagram, buildModifierPopUp, buildVisibilityPopUp, calcBounds, classNameAndBounds, createFeatureIn, damage, delayedVetoableChange, deleteFromModel, displace, elementOrdering, enableSizeChecking, finalize, getBigPort, getContextNotation, getEnclosedFigs, getEncloser, getEnclosingFig, getItalicLabelFont, getItemUID, getLabelFont, getName, getNameFig, getPopUpActions, getShadowSize, getStereotype, getStereotypeFig, getStereotypeFigText, getTipString, hit, hitClarifier, isCheckSize, isPartlyOwner, isPartlyOwner, isReadyToEdit, keyPressed, keyReleased, keyTyped, mouseClicked, notationAdded, notationChanged, notationProviderAdded, notationProviderRemoved, notationRemoved, paint, paintClarifiers, postLoad, propertyChange, redrawEnclosedFigs, removeEnclosedFig, removeFromDiagram, renderingChanged, setBigPort, setEncloser, setEnclosingFig, setItemUID, setName, setNameFig, setOwner, setReadyToEdit, setShadowSize, setStereotype, setStereotypeFig, setSuppressCalcBounds, updateBounds, updateFigGroupSize, updateListeners, vetoableChange
 
Methods inherited from class org.tigris.gef.presentation.FigNode
addFigEdge, bindPort, cleanUp, contains, deepHitPort, delete, dispose, endTrans, getBlinkPorts, getFigEdges, getFigEdges, getHighlight, getPortFig, getPortFigs, getPortSector, hidePorts, hitPort, hitPort, isBlinkPorts, isDragConnectable, mouseEntered, mouseExited, mousePressed, mouseReleased, removeFigEdge, removePort, setBlinkPorts, setHighlight, showPorts, superTranslate, translate, updateEdges
 
Methods inherited from class org.tigris.gef.presentation.FigGroup
addFigs, deepSelect, elements, getDisplayedFigs, getExtraFrameSpace, getFigAt, getFigs, getFigs, getFont, getFontFamily, getFontSize, getPrivateData, getSize, getSubFigBounds, getTextColor, getTextFillColor, getTextFilled, hitFig, isReshapable, isRotatable, iterator, parseDynObjects, removeAll, removeFig, setExtraFrameSpace, setFigs, setFigs, setFont, setFontFamily, setFontSize, setPrivateData, setTextColor, setTextFillColor, setTextFilled
 
Methods inherited from class org.tigris.gef.presentation.Fig
addAnnotation, addPoint, addPropertyChangeListener, align, center, connectionPoint, contains, contains, countCornersContained, createDrag, drawDashedLine, drawDashedPerimeter, firePropChange, firePropChange, firePropChange, getAnnotationOwner, getAnnotationStrategy, getBounds, getBounds, getClosestPoint, getContext, getDashed, getDashed01, getDashedString, getFilled01, getFirstPoint, getGravityPoints, getGroup, getHalfHeight, getHalfWidth, getHandleBox, getHeight, getId, getLastPoint, getLayer, getLocation, getLocked, getNumPoints, getOwner, getPerimeterLength, getPoint, getPoints, getPreferredSize, getResource, getSingle, getTrapRect, getUseTrapRect, getVisState, getWidth, getX, getXs, getY, getYs, hasFillColor, hasLineColor, initAnnotations, insertPoint, intersects, intersectsPerimeter, isAnnotation, isCopieable, isCopyable, isCutable, isDisplayed, isLowerRightResizable, isMovable, isResizable, isSelected, isVisible, OK, pointAlongPerimeter, postSave, preSave, print, redraw, removeAnnotation, removeAnnotation, removePoint, removePropertyChangeListener, reorder, routingRect, savingAllowed, setAnnotationOwner, setAnnotationStatus, setAnnotationStrategy, setBounds, setCenter, setContext, setDashed, setDashedString, setDisplayed, setGroup, setHandleBox, setHeight, setLayer, setLocation, setLocation, setLocked, setMovable, setNumPoints, setPoint, setPoint, setPoint, setPoint, setPoints, setPoints, setPoints, setPoints, setPoints, setResizable, setResource, setSavingAllowed, setSelected, setSingle, setSize, setSize, setVisible, setVisState, setWidth, setX, setXs, setY, setYs, stuffBounds, stuffPointAlongPerimeter, translateAnnotations, unsetAnnotationOwner, updateAnnotationPositions, updateVisState, within
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface java.awt.event.MouseListener
mouseEntered, mouseExited, mousePressed, mouseReleased
 
Methods inherited from interface org.tigris.gef.ui.Highlightable
addPropertyChangeListener, removePropertyChangeListener
 

Field Detail

PADDING

private static final int PADDING
The minimum padding above and below the stereotype and name.

See Also:
Constant Field Values

cover

private org.tigris.gef.presentation.FigRect cover
The fig that is used for the complete classifier role. Identical in size to FigNodeModelElement.bigPort.

Constructor Detail

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(org.tigris.gef.graph.GraphModel gm,
                         org.tigris.gef.base.Layer lay,
                         Object node)

Variant constructor that associates the classifier role with a particular NSUML object.

Classifier role is constructed with FigClassifierRole().

Parameters:
gm - The graph model to use. Ignored in this implementation.
lay - The layer
node - The NSUML object to associate with this Fig.
Method Detail

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.

setBounds

public void setBounds(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(org.tigris.gef.presentation.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)

updateNameText

protected void updateNameText()

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

Note. The current implementation does not properly use Notation.generate to generate the full name for a classifier role.

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)

makeSelection

public org.tigris.gef.base.Selection makeSelection()
Overrides:
makeSelection in class FigNodeModelElement
See Also:
Fig.makeSelection()


ArgoUML © 1996-2004 (20050222)ArgoUML HomepageArgoUML Developers' pageArgoUML Cookbook