FigEdgeModelElement (ArgoUML Javadoc for internal use)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.argouml.uml.diagram.ui
Class FigEdgeModelElement

java.lang.Object
  org.tigris.gef.presentation.Fig
      org.tigris.gef.presentation.FigEdge
          org.tigris.gef.presentation.FigEdgePoly
              org.argouml.uml.diagram.ui.FigEdgeModelElement

All Implemented Interfaces:: ArgoEventListener, ArgoNotationEventListener, Cloneable, Connecter, DelayedVChangeListener, EventListener, Highlightable, KeyListener, MouseListener, NotationContext, PopupGenerator, PropertyChangeListener, Serializable, VetoableChangeListener

Direct Known Subclasses:: FigAssociation, FigAssociationEnd, FigDependency, FigEdgeAssociationClass, FigEdgeNote, FigExtend, FigGeneralization, FigInclude, FigLink, FigMessage, FigRealization, FigTransition

public abstract class FigEdgeModelElement
extends FigEdgePoly
implements VetoableChangeListener, DelayedVChangeListener, MouseListener, KeyListener, PropertyChangeListener, NotationContext, ArgoNotationEventListener

Abstract class to display diagram lines (edges) for UML ModelElements that look like lines and that have editable names.

See Also:: Serialized Form

Nested Class Summary

Nested classes inherited from class org.tigris.gef.presentation.FigEdge

Field Summary
`private FigCommentPort`	`commentPort`
`private NotationName`	`currentNotationName` The current notation for this fig.
`private DiElement`	`diElement`
`private static Font`	`ITALIC_LABEL_FONT`
`private ItemUID`	`itemUid`
`private static Font`	`LABEL_FONT`
`private static Logger`	`LOG`
`private FigText`	`name` The Fig that displays the name of this model element.
`private static int`	`popupAddOffset` Offset from the end of the set of popup actions at which new items should be inserted by concrete figures.
`private boolean`	`removeFromDiagram` Set the removeFromDiagram to false if this edge may not be removed from the diagram.
`private Fig`	`stereotypeFig` The Fig that displays the stereotype of this model element.

Fields inherited from class org.tigris.gef.presentation.FigEdgePoly

_initiallyLaidOut

Fields inherited from class org.tigris.gef.presentation.FigEdge

_arrowHeadEnd, _arrowHeadStart, _destFigNode, _highlight, _pathItems, _sourceFigNode, _useNearest

Fields inherited from class org.tigris.gef.presentation.Fig

_allowsSaving, _context, _dashes, _dashPeriod, _dashStyle, _filled, _h, _w, _x, _y, an, annotationOwner, annotationStatus, BORDER, MIN_SIZE

Constructor Summary
`FigEdgeModelElement()` Partially construct a new FigNode.
`FigEdgeModelElement(Object edge)` The constructor that hooks the Fig into the UML model element.

Method Summary
`protected void`	`allowRemoveFromDiagram(boolean allowed)`
`protected boolean`	`canEdit(Fig f)`
`void`	`damage()`
`void`	`delayedVetoableChange(PropertyChangeEvent pce)`
`void`	`deleteFromModel()`
`protected void`	`finalize()`
`protected Action[]`	`getApplyStereotypeActions()`
`FigCommentPort`	`getCommentPort()`
`NotationName`	`getContextNotation()` This default implementation simply requests the default notation.
`protected Object`	`getDestination()` Returns the destination of the edge.
`DiElement`	`getDiElement()`
`static Font`	`getItalicLabelFont()`
`ItemUID`	`getItemUID()` Getter for the UID
`static Font`	`getLabelFont()`
`FigText`	`getNameFig()` Getter for name, the name Fig
`Vector`	`getPopUpActions(MouseEvent me)`
`protected static int`	`getPopupAddOffset()`
`protected Object`	`getSource()` Returns the source of the edge.
`int`	`getSquaredDistance(Point p1, Point p2)` distance formula: (x-h)^2 + (y-k)^2 = distance^2
`Fig`	`getStereotypeFig()` Getter for stereo, the stereotype Fig
`String`	`getTipString(MouseEvent me)`
`boolean`	`hit(Rectangle r)`
`ToDoItem`	`hitClarifier(int x, int y)` The user clicked on the clarifier.
`void`	`keyPressed(KeyEvent ke)`
`void`	`keyReleased(KeyEvent ke)`
`void`	`keyTyped(KeyEvent ke)`
`private void`	`layoutThisToSelf()` helper method for updateClassifiers() in order to automatically layout an edge that is now from and to the same node type.
`void`	`makeCommentPort()`
`Selection`	`makeSelection()` Returns a `SelectionRerouteEdge` object that manages selection and rerouting of the edge.
`protected void`	`modelChanged(PropertyChangeEvent e)` This is called after any part of the UML ModelElement has changed.
`void`	`mouseClicked(MouseEvent me)` If the user double clicks on anu part of this FigNode, pass it down to one of the internal Figs.
`void`	`mouseEntered(MouseEvent me)`
`void`	`mouseExited(MouseEvent me)`
`void`	`mousePressed(MouseEvent me)`
`void`	`mouseReleased(MouseEvent me)`
`void`	`notationAdded(ArgoNotationEvent event)` Invoked when a notation has been added.
`void`	`notationChanged(ArgoNotationEvent event)` Invoked when any aspect of the notation has been changed.
`void`	`notationProviderAdded(ArgoNotationEvent event)` Invoked when a notation provider has been added.
`void`	`notationProviderRemoved(ArgoNotationEvent event)` Invoked when a notation provider has been removed.
`void`	`notationRemoved(ArgoNotationEvent event)` Invoked when a notation has been removed.
`void`	`paintClarifiers(Graphics g)`
`void`	`postLoad()`
`void`	`propertyChange(PropertyChangeEvent pve)`
`void`	`removeFromDiagram()`
`void`	`renderingChanged()` Rerenders the fig if needed.
`void`	`setContextNotation(NotationName nn)`
`void`	`setDiElement(DiElement diElement)`
`void`	`setItemUID(ItemUID newId)` Setter for the UID
`void`	`setLayer(Layer lay)`
`void`	`setOwner(Object newOwner)`
`protected void`	`showHelp(String s)` Utility function to localize the given string with help text, and show it in the status bar of the ArgoUML window.
`protected void`	`textEdited(FigText ft)` This method is called after the user finishes editing a text field that is in the FigEdgeModelElement.
`protected void`	`textEditStarted(FigText ft)` This method is called when the user doubleclicked on the text field, and starts editing.
`protected boolean`	`updateClassifiers()` Updates the classifiers the edge is attached to.
`protected void`	`updateListeners(Object newOwner)` Implementations of this method should register/unregister the fig for all (model)events.
`protected void`	`updateNameText()` generate the notation for the modelelement and stuff it into the text Fig
`protected void`	`updateStereotypeText()` generate the notation for the stereotype and stuff it into the text Fig
`void`	`vetoableChange(PropertyChangeEvent pce)`

Methods inherited from class org.tigris.gef.presentation.FigEdgePoly

computeRoute, findAvoidPt, insertPoint, layoutEdge, makeEdgeFig, moveVertex, paint, routingRectPoint, segOK, setEndPoints, setInitiallyLaidOut, setPoint, tryRoute

Methods inherited from class org.tigris.gef.presentation.FigEdge

addPathItem, calcBounds, cleanUp, contains, getBetweenNearestPoints, getBounds, getDashed, getDestArrowHead, getDestFigNode, getDestPortFig, getFig, getFirstPoint, getHighlight, getLastPoint, getLineColor, getLineWidth, getNumPoints, getPathItem, getPathItemFig, getPathItemFigs, getPathItemsRaw, getPerimeterLength, getPoint, getPoints, getPrivateData, getSourceArrowHead, getSourceFigNode, getSourcePortFig, getXs, getYs, hasFillColor, hitFig, intersects, isReshapable, isResizable, isRotatable, paintArrowHeads, paintHighlightLine, paintPathItems, removePathItem, removePathItem, setBetweenNearestPoints, setDashed, setDestArrowHead, setDestFigNode, setDestPortFig, setFig, setHighlight, setLineColor, setLineWidth, setNumPoints, setPoint, setPoints, setSourceArrowHead, setSourceFigNode, setSourcePortFig, setXs, setYs, stuffPointAlongPerimeter, translateEdge, updatePathItemLocations

Methods inherited from class org.tigris.gef.presentation.Fig

addAnnotation, addPoint, addPropertyChangeListener, align, center, classNameAndBounds, clone, connectionPoint, contains, contains, countCornersContained, createDrag, drawDashedLine, drawDashedPerimeter, endTrans, firePropChange, firePropChange, firePropChange, getAnnotationOwner, getAnnotationStrategy, getBounds, getCenter, getClosestPoint, getContext, getDashed01, getDashedString, getEnclosedFigs, getEnclosingFig, getFillColor, getFilled, getFilled01, getGravityPoints, getGroup, getHalfHeight, getHalfWidth, getHandleBox, getHeight, getId, getLayer, getLocation, getLocked, getMinimumSize, getOwner, getPreferredSize, getResource, getSingle, getSize, getTrapRect, getUseTrapRect, getVisState, getWidth, getX, getY, hasLineColor, initAnnotations, intersectsPerimeter, isAnnotation, isCopyable, isCutable, isLowerRightResizable, isMovable, isRemoveStarted, isSelectable, isSelected, isVisible, OK, pointAlongPerimeter, postSave, preSave, print, redraw, removeAnnotation, removeAnnotation, removePoint, removePropertyChangeListener, reorder, routingRect, savingAllowed, setAnnotationOwner, setAnnotationStatus, setAnnotationStrategy, setBounds, setBounds, setBoundsImpl, setCenter, setContext, setDashedString, setEnclosingFig, setFillColor, setFilled, setGroup, setHandleBox, setHeight, setLocation, setLocation, setLocked, setMovable, setPoint, setPoint, setPrivateData, setResizable, setResource, setSavingAllowed, setSingle, setSize, setSize, setVisible, setWidth, setX, setY, stuffBounds, translate, translateAnnotations, translateImpl, unsetAnnotationOwner, updateAnnotationPositions, updateVisState, within

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.tigris.gef.ui.Highlightable

addPropertyChangeListener, removePropertyChangeListener

Field Detail

LOG

private static final Logger LOG

diElement

private DiElement diElement

removeFromDiagram

private boolean removeFromDiagram

Set the removeFromDiagram to false if this edge may not be removed from the diagram.

LABEL_FONT

private static final Font LABEL_FONT

ITALIC_LABEL_FONT

private static final Font ITALIC_LABEL_FONT

popupAddOffset

private static int popupAddOffset

Offset from the end of the set of popup actions at which new items should be inserted by concrete figures.

name

private FigText name

The Fig that displays the name of this model element. Use getNameFig(), no setter should be required.

stereotypeFig

private Fig stereotypeFig

The Fig that displays the stereotype of this model element. Use getStereotypeFig(), no setter should be required.

commentPort

private FigCommentPort commentPort

itemUid

private ItemUID itemUid

currentNotationName

private NotationName currentNotationName

The current notation for this fig. The notation is for example UML 1.3 or Java

Constructor Detail

FigEdgeModelElement

public FigEdgeModelElement()

Partially construct a new FigNode. This method creates the _name element that holds the name of the model element and adds itself as a listener.

FigEdgeModelElement

public FigEdgeModelElement(Object edge)

The constructor that hooks the Fig into the UML model element.
Parameters:: edge - the UML element

Method Detail

finalize

protected void finalize()

See Also:: Object.finalize()

makeCommentPort

public void makeCommentPort()

getCommentPort

public FigCommentPort getCommentPort()

setItemUID

public void setItemUID(ItemUID newId)

Setter for the UID

Parameters:: newId - the new UID

getItemUID

public ItemUID getItemUID()

Getter for the UID

Returns:: the UID

getTipString

public String getTipString(MouseEvent me)

See Also:: Fig.getTipString(java.awt.event.MouseEvent)

getPopUpActions

public Vector getPopUpActions(MouseEvent me)

Specified by:: getPopUpActions in interface PopupGenerator

See Also:: PopupGenerator.getPopUpActions(java.awt.event.MouseEvent)

getApplyStereotypeActions

protected Action[] getApplyStereotypeActions()

getSquaredDistance

public int getSquaredDistance(Point p1,
                              Point p2)

distance formula: (x-h)^2 + (y-k)^2 = distance^2

Parameters:: p1 - point; p2 - point
Returns:: the square of the distance

paintClarifiers

public void paintClarifiers(Graphics g)

Parameters:: g - the Graphics object

hitClarifier

public ToDoItem hitClarifier(int x,
                             int y)

The user clicked on the clarifier.

Parameters:: x - the x of the point clicked; y - the y of the point clicked
Returns:: the todo item clicked

makeSelection

public Selection makeSelection()

Returns a SelectionRerouteEdge object that manages selection and rerouting of the edge.

Returns:: the SelectionRerouteEdge.

getNameFig

public FigText getNameFig()

Getter for name, the name Fig

Returns:: the nameFig

getStereotypeFig

public Fig getStereotypeFig()

Getter for stereo, the stereotype Fig

Returns:: the stereo Fig

vetoableChange

public void vetoableChange(PropertyChangeEvent pce)

Specified by:: vetoableChange in interface VetoableChangeListener

See Also:: VetoableChangeListener.vetoableChange(java.beans.PropertyChangeEvent)

delayedVetoableChange

public void delayedVetoableChange(PropertyChangeEvent pce)

Specified by:: delayedVetoableChange in interface DelayedVChangeListener

Parameters:: pce - the event
See Also:: DelayedVChangeListener.delayedVetoableChange(java.beans.PropertyChangeEvent)

propertyChange

public void propertyChange(PropertyChangeEvent pve)

Specified by:: propertyChange in interface PropertyChangeListener

See Also:: PropertyChangeListener.propertyChange(java.beans.PropertyChangeEvent)

textEditStarted

protected void textEditStarted(FigText ft)

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, but that seems not user-friendly.

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

showHelp

protected void showHelp(String s)

Utility function to localize the given string with help text, and show it in the status bar of the ArgoUML window. This function is used in favour of the inline call to enable later improvements; e.g. it would be possible to show a help-balloon. TODO: Work this out. One matter to possibly improve: show multiple lines.

Parameters:: s - the given string to be localized and shown

textEdited

protected void textEdited(FigText ft)

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

Parameters:: ft - the text Fig that has been edited

canEdit

protected boolean canEdit(Fig f)

Parameters:: f - the Fig
Returns:: true if editable

mousePressed

public void mousePressed(MouseEvent me)

Specified by:: mousePressed in interface MouseListener

See Also:: MouseListener.mousePressed(java.awt.event.MouseEvent)

mouseReleased

public void mouseReleased(MouseEvent me)

Specified by:: mouseReleased in interface MouseListener

See Also:: MouseListener.mouseReleased(java.awt.event.MouseEvent)

mouseEntered

public void mouseEntered(MouseEvent me)

Specified by:: mouseEntered in interface MouseListener

See Also:: MouseListener.mouseEntered(java.awt.event.MouseEvent)

mouseExited

public void mouseExited(MouseEvent me)

Specified by:: mouseExited in interface MouseListener

See Also:: MouseListener.mouseExited(java.awt.event.MouseEvent)

mouseClicked

public void mouseClicked(MouseEvent me)

If the user double clicks on anu part of this FigNode, pass it down to one of the internal Figs. This allows the user to initiate direct text editing.

Specified by:: mouseClicked in interface MouseListener

See Also:: MouseListener.mouseClicked(java.awt.event.MouseEvent)

keyPressed

public void keyPressed(KeyEvent ke)

Specified by:: keyPressed in interface KeyListener

See Also:: KeyListener.keyPressed(java.awt.event.KeyEvent)

keyReleased

public void keyReleased(KeyEvent ke)

Specified by:: keyReleased in interface KeyListener

See Also:: Not used, do nothing.

keyTyped

public void keyTyped(KeyEvent ke)

Specified by:: keyTyped in interface KeyListener

See Also:: KeyListener.keyTyped(java.awt.event.KeyEvent)

modelChanged

protected void modelChanged(PropertyChangeEvent e)

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

Parameters:: e - the event

updateNameText

protected void updateNameText()

generate the notation for the modelelement and stuff it into the text Fig

updateStereotypeText

protected void updateStereotypeText()

generate the notation for the stereotype and stuff it into the text Fig

setOwner

public void setOwner(Object newOwner)

See Also:: Fig.setOwner(java.lang.Object)

updateListeners

protected void updateListeners(Object newOwner)

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

Parameters:: newOwner - the new owner for the listeners

setLayer

public void setLayer(Layer lay)

See Also:: Fig.setLayer(org.tigris.gef.base.Layer)

deleteFromModel

public void deleteFromModel()

See Also:: Fig.deleteFromModel()

getContextNotation

public NotationName getContextNotation()

This default implementation simply requests the default notation.

Specified by:: getContextNotation in interface NotationContext

Returns:: null if the context does not wish to name a specific notation
See Also:: NotationContext.getContextNotation()

setContextNotation

public void setContextNotation(NotationName nn)

Specified by:: setContextNotation in interface NotationContext

Parameters:: nn - the new notationName
See Also:: NotationContext.setContextNotation(org.argouml.notation.NotationName)