org.argouml.uml.diagram.activity.ui
Class FigObjectFlowState

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.activity.ui.FigObjectFlowState

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 FigObjectFlowState

extends FigNodeModelElement

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

The Fig of this modelelement may either contain the Classifier name, or it contains the name of the ClassifierInState AND the name of its state. In the examples in the UML standard, this is written like
PurchaseOrder
[approved]
i.e. in 2 lines. The first line is underlined, to indicate that it is an instance (object).

The fact that the first line is underlined, and the 2nd not, is the reason to implement them in 2 seperate Figs.

TODO: Allow stereotypes to be shown.

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.FigText	classifier
private org.tigris.gef.presentation.FigRect	cover
private static int	HEIGHT
private static int	OFFSET
private static int	PADDING
private org.tigris.gef.presentation.FigText	state
private static int	WIDTH

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

FigObjectFlowState()
Main Constructor FigObjectFlowState (called from file loading)

FigObjectFlowState(org.tigris.gef.graph.GraphModel gm, Object node)
Constructor FigObjectFlowState that hooks the Fig into an existing UML model element

Method Summary

Object	clone() After the base clone method has been called determine which child figs of the clone represent the name, stereotype and port.
Color	getFillColor()
boolean	getFilled()
Color	getLineColor()
int	getLineWidth()
Dimension	getMinimumSize() Get the minimum size.
String	getName() Get the name of the model element this Fig represents.
org.tigris.gef.presentation.FigText	getNameFig() Get the Fig that displays the model element name.
void	keyPressed(KeyEvent ke)
protected void	modelChanged(PropertyChangeEvent mee) This is called after any part of the UML MModelElement has changed.
String	placeString() Default Reply text to be shown while placing node in diagram.
void	renderingChanged() Rerenders the fig if needed.
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)
void	setName(String n) Change the name of the model element this Fig represents.
protected void	textEdited(org.tigris.gef.presentation.FigText ft) This method is called after the user finishes editing a text field that is in the FigNodeModelElement.
private void	updateClassifierText() Updates the text of the classifier FigText.
private void	updateStateText() Updates the text of the state FigText.

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, getPopUpActions, getShadowSize, getStereotype, getStereotypeFig, getStereotypeFigText, getTipString, hit, hitClarifier, isCheckSize, isPartlyOwner, isPartlyOwner, isReadyToEdit, keyReleased, keyTyped, makeSelection, mouseClicked, notationAdded, notationChanged, notationProviderAdded, notationProviderRemoved, notationRemoved, paint, paintClarifiers, postLoad, propertyChange, redrawEnclosedFigs, removeEnclosedFig, removeFromDiagram, setBigPort, setEncloser, setEnclosingFig, setItemUID, setNameFig, setOwner, setReadyToEdit, setShadowSize, setStereotype, setStereotypeFig, setSuppressCalcBounds, updateBounds, updateFigGroupSize, updateListeners, updateNameText, updateStereotypeText, 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

See Also:

Constant Field Values

OFFSET

private static final int OFFSET

See Also:

Constant Field Values

WIDTH

private static final int WIDTH

See Also:

Constant Field Values

HEIGHT

private static final int HEIGHT

See Also:

Constant Field Values

cover

private org.tigris.gef.presentation.FigRect cover

classifier

private org.tigris.gef.presentation.FigText classifier

state

private org.tigris.gef.presentation.FigText state

Constructor Detail

FigObjectFlowState

public FigObjectFlowState()

Main Constructor FigObjectFlowState (called from file loading)

FigObjectFlowState

public FigObjectFlowState(org.tigris.gef.graph.GraphModel gm,
                          Object node)

Constructor FigObjectFlowState that hooks the Fig into an existing UML model element

Parameters:

gm - ignored!

node - owner, i.e. the UML element

Method Detail

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)

placeString

public String placeString()

Description copied from class: FigNodeModelElement

Default Reply text to be shown while placing node in diagram. Overrule this when the text is not "new [UMLClassName]".

Overrides:

placeString in class FigNodeModelElement

Returns:

the text to be shown while placing node in diagram

See Also:

FigNodeModelElement.placeString()

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 FigNodeModelElement

See Also:

Object.clone()

getMinimumSize

public Dimension getMinimumSize()

Get the minimum size. The space between the 2 text figs is: PADDING.

See Also:

Fig.getMinimumSize()

setBounds

public void setBounds(int x,
                      int y,
                      int w,
                      int h)

Override setBounds to keep shapes looking right. The classifier and state Figs are nicely centered vertically, and stretched out over the full width, to allow easy selection with the mouse. The Fig can only be shrinked to half its original size - so that it is not reduceable to a few pixels only.

See Also:

Fig.setBounds(int, int, int, int)

renderingChanged

public void renderingChanged()

Description copied from class: FigNodeModelElement

Rerenders the fig if needed. 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()

updateClassifierText

private void updateClassifierText()

Updates the text of the classifier FigText.

updateStateText

private void updateStateText()

Updates the text of the state FigText.

getNameFig

public org.tigris.gef.presentation.FigText getNameFig()

Description copied from class: FigNodeModelElement

Get the Fig that displays the model element name.

Overrides:

getNameFig in class FigNodeModelElement

Returns:

the name Fig

See Also:

FigNodeModelElement.getNameFig()

getName

public String getName()

Description copied from class: FigNodeModelElement

Get the name of the model element this Fig represents.

Overrides:

getName in class FigNodeModelElement

Returns:

the name of the model element

See Also:

FigNodeModelElement.getName()

setName

public void setName(String n)

Description copied from class: FigNodeModelElement

Change the name of the model element this Fig represents.

Overrides:

setName in class FigNodeModelElement

Parameters:

n - the name of the model element

See Also:

FigNodeModelElement.setName(java.lang.String)

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()

keyPressed

public void keyPressed(KeyEvent ke)

Specified by:

keyPressed in interface KeyListener

Overrides:

keyPressed in class FigNodeModelElement

See Also:

KeyListener.keyPressed(java.awt.event.KeyEvent)

textEdited

protected void textEdited(org.tigris.gef.presentation.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, 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)