org.argouml.uml.diagram.ui
Interface ArgoFig

All Known Implementing Classes:
AbstractFigComponent, AbstractFigNode, ArgoFigGroup, ArgoFigText, CompartmentFigText, FigAbstraction, FigActionState, FigActor, FigAssociation, FigAssociationClass, FigAssociationEnd, FigAssociationRole, FigAttribute, FigAttributesCompartment, FigBranchState, FigCallActionMessage, FigCallState, FigClass, FigClassAssociationClass, FigClassifierBox, FigClassifierBoxWithAttributes, FigClassifierRole, FigClassifierRole, FigClassifierRole, FigComment, FigCompartment, FigCompartmentBox, FigComponent, FigComponentInstance, FigCompositeState, FigConcurrentRegion, FigCreateActionMessage, FigDataType, FigDeepHistoryState, FigDependency, FigDestroyActionMessage, FigEdgeAssociationClass, FigEdgeModelElement, FigEdgeNote, FigEdgePort, FigEditableCompartment, FigEnumeration, FigEnumerationLiteral, FigEnumLiteralsCompartment, FigException, FigExtend, FigExtensionPoint, FigExtensionPointsCompartment, FigFeature, FigFinalState, FigForkState, FigGeneralization, FigHead, FigHistoryState, FigInclude, FigInitialState, FigInterface, FigJoinState, FigJunctionState, FigKeyword, FigLink, FigMessage, FigMessage, FigMessage, FigMessagePort, FigMNode, FigModel, FigMultiLineText, FigMultiLineTextWithBold, FigNodeAssociation, FigNodeInstance, FigNodeModelElement, FigObject, FigObjectFlowState, FigOperation, FigOperationsCompartment, FigPackage, FigPartition, FigPermission, FigPool, FigReturnActionMessage, FigShallowHistoryState, FigSignal, FigSimpleState, FigSingleLineText, FigSingleLineTextWithNotation, FigState, FigStateVertex, FigStereotype, FigStereotypeDeclaration, FigStereotypesCompartment, FigStereotypesGroup, FigStubState, FigSubactivityState, FigSubmachineState, FigSubsystem, FigSynchState, FigTextGroup, FigTransition, FigUsage, FigUseCase

public interface ArgoFig

An interface that all ArgoUML Figs are required to interface. It provides a single place to specify behaviors that we want all Figs to have since we don't have access to the GEF class hierarchy (and it is made up of concrete classes instead of interfaces.

Since:
0.25.4

Field Summary
static boolean DEBUG
          Enable this flag to switch to the debug default color scheme
static java.awt.Color DEBUG_COLOR
          The color used for things which shouldn't normally be visible, so we can spot them easily when they are.
static java.awt.Color FILL_COLOR
          Default color for filled figures.
static java.awt.Color INVISIBLE_LINE_COLOR
          Color for a line which is supposed to blend into the fill.
static java.awt.Color LINE_COLOR
          Default color for lines.
static int LINE_WIDTH
          Default line width in pixels.
static int ROWHEIGHT
          min.
static java.awt.Color SOLID_FILL_COLOR
          Color for a solid fill.
static int STEREOHEIGHT
          min.
static java.awt.Color TEXT_COLOR
          Default color for text.
static int X0
          Default X offset of origin used when building figs
static int Y0
          Default Y offset of origin used when building figs
 
Method Summary
 Project getProject()
          Deprecated. for 0.27.2 by tfmorris. Implementations should have all the information that they require in the DiagramSettings object.
 DiagramSettings getSettings()
           
 void renderingChanged()
          Rerender the entire fig.
 void setOwner(java.lang.Object owner)
          Deprecated. for 0.27.3 by tfmorris. Set owner in constructor.
 void setProject(Project project)
          Deprecated. for 0.27.2 by tfmorris. This optional method has never been implemented by any concrete class that implements this interface and should not be used. Project ownership is maintained at a coarser granularity level.
 void setSettings(DiagramSettings settings)
          Set the rendering settings to be used for this fig.
 

Field Detail

X0

static final int X0
Default X offset of origin used when building figs

See Also:
Constant Field Values

Y0

static final int Y0
Default Y offset of origin used when building figs

See Also:
Constant Field Values

ROWHEIGHT

static final int ROWHEIGHT
min. 17, used to calculate y pos of FigText items in a compartment

See Also:
Constant Field Values

STEREOHEIGHT

static final int STEREOHEIGHT
min. 18, used to calculate y pos of stereotype FigText items in a compartment

See Also:
Constant Field Values

DEBUG

static final boolean DEBUG
Enable this flag to switch to the debug default color scheme

See Also:
Constant Field Values

LINE_WIDTH

static final int LINE_WIDTH
Default line width in pixels.

See Also:
Constant Field Values

LINE_COLOR

static final java.awt.Color LINE_COLOR
Default color for lines. This constant is an interim measure before moving to settable defaults.


SOLID_FILL_COLOR

static final java.awt.Color SOLID_FILL_COLOR
Color for a solid fill. It's probably always going to be the same as the line color, but we'll identify it separately for flexibility in the future.


FILL_COLOR

static final java.awt.Color FILL_COLOR
Default color for filled figures. This is an interim measure before moving to settable defaults.


INVISIBLE_LINE_COLOR

static final java.awt.Color INVISIBLE_LINE_COLOR
Color for a line which is supposed to blend into the fill. It's the same color for right now, but we'll keep it separate so we can identify it easily in the future.


TEXT_COLOR

static final java.awt.Color TEXT_COLOR
Default color for text. This is an interim measure before moving to settable defaults.


DEBUG_COLOR

static final java.awt.Color DEBUG_COLOR
The color used for things which shouldn't normally be visible, so we can spot them easily when they are. Completely transparent when we're not debugging. Historically this was hardwired to either red or cyan.

Method Detail

setProject

@Deprecated
void setProject(Project project)
Deprecated. for 0.27.2 by tfmorris. This optional method has never been implemented by any concrete class that implements this interface and should not be used. Project ownership is maintained at a coarser granularity level.

Set the owning project for this Fig. This is an optional operation which may throw an UnsupportedOperationException if not implemented.

Parameters:
project - the project

getProject

@Deprecated
Project getProject()
Deprecated. for 0.27.2 by tfmorris. Implementations should have all the information that they require in the DiagramSettings object.

Get the owning project for this fig.

Returns:
the owning project

renderingChanged

void renderingChanged()
Rerender the entire fig.

This may be an expensive operation for subclasses which are complex, so should be used sparingly. It is only intended to be used when some global change to the rendering defaults is made at the ArgoDiagram level.


getSettings

DiagramSettings getSettings()
Returns:
the rendering settings for the Fig

setSettings

void setSettings(DiagramSettings settings)
Set the rendering settings to be used for this fig. Currently this normally will be a diagram-wide or project-wide settings object that is shared by all Figs.

Parameters:
settings - the rendering settings to use

setOwner

@Deprecated
void setOwner(java.lang.Object owner)
Deprecated. for 0.27.3 by tfmorris. Set owner in constructor.

Setting the owner of the Fig must be done in the constructor and not changed afterwards for all ArgoUML figs.

Parameters:
owner - owning UML element
See Also:
org.tigris.gef.presentation.Fig#setOwner(java.lang.Object)


ArgoUML © 1996-2006ArgoUML HomepageArgoUML Developers' pageArgoUML Cookbook