org.argouml.uml.diagram.state.ui
Class FigState

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.state.ui.FigStateVertex
                      org.argouml.uml.diagram.state.ui.FigState

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

Direct Known Subclasses:

FigCompositeState, FigConcurrentRegion, FigSimpleState, FigSubmachineState

public abstract class FigState

extends FigStateVertex

The fig hierarchy should comply as much as possible to the hierarchy of the UML metamodel. Reason for this is to make sure that events from the model are not missed by the figs. The hierarchy of the states was not compliant to this. This resulted in a number of issues (issue 1430 for example). Therefore introduced an abstract FigState and made FigCompositeState and FigSimpleState subclasses of this state.

Since:

Dec 30, 2002

See Also:

Serialized Form

SPACE_TOP

protected static final int SPACE_TOP

See Also:

Constant Field Values

SPACE_MIDDLE

protected static final int SPACE_MIDDLE

See Also:

Constant Field Values

DIVIDER_Y

protected static final int DIVIDER_Y

See Also:

Constant Field Values

SPACE_BOTTOM

protected static final int SPACE_BOTTOM

See Also:

Constant Field Values

MARGIN

protected static final int MARGIN

See Also:

Constant Field Values

notationProviderBody

protected NotationProvider4 notationProviderBody

FigState

public FigState()

Constructor for FigState.

FigState

public FigState(GraphModel gm,
                Object node)

Constructor for FigState, used when an UML elm already exists.

Parameters:

gm - ignored

node - the UML element

setOwner

public void setOwner(Object newOwner)

Description copied from class: FigNodeModelElement

In ArgoUML, for every Fig, this setOwner() function may only be called twice: Once after the fig is created, with a non-null argument, and once at end-of-life of the Fig, with a null argument. It is not allowed in ArgoUML to change the owner of a fig in any other way.

Hence, during the lifetime of this Fig object, the owner shall go from null to some UML object, and to null again.

Overrides:

setOwner in class FigNodeModelElement

See Also:

Fig.setOwner(java.lang.Object)

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)

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)

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 FigNodeModelElement

See Also:

FigNodeModelElement.renderingChanged()

getInitialX

protected abstract int getInitialX()

Returns:

the initial X

getInitialY

protected abstract int getInitialY()

Returns:

the initial Y

getInitialWidth

protected abstract int getInitialWidth()

Returns:

the initial width

getInitialHeight

protected abstract int getInitialHeight()

Returns:

the initial height

setInternal

protected void setInternal(FigText theInternal)

Parameters:

theInternal - The internal to set.

getInternal

protected FigText getInternal()

Returns:

Returns the internal.

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)

textEdited

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