org.argouml.kernel
Class ProjectSettings

java.lang.Object
  org.argouml.kernel.ProjectSettings

public class ProjectSettings
extends java.lang.Object

A datastructure for settings for a Project.

Most getters return a string, since they are used by "argo.tee". This is also the reason all these attributes are not part of a Map or something.

TODO: The header comment is currently not used - this function is not completely implemented yet. How do we store this in the project? Where should the user enter his header comment? See issue 4813.

init

@Deprecated
public void init()

Deprecated. for 0.27.2 by tfmorris. No replacement. Diagrams/Figs are now created with the correct initial settings.

Send all events required for post-load of project.

getDefaultDiagramSettings

public DiagramSettings getDefaultDiagramSettings()

Returns:

the default diagram settings

getNotationSettings

public NotationSettings getNotationSettings()

Returns:

the default project wide notation settings

getNotationLanguage

public java.lang.String getNotationLanguage()

Used by "argo.tee".

Returns:

Returns the notation language.

getNotationName

public NotationName getNotationName()

Returns:

Return the notation name.

setNotationLanguage

public boolean setNotationLanguage(java.lang.String newLanguage)

Parameters:

newLanguage - the notation language.

Returns:

true if the notation is set - false if it does not exist

setNotationLanguage

public void setNotationLanguage(NotationName nn)

Parameters:

nn - the new notation language

getShowBoldNames

public java.lang.String getShowBoldNames()

Used by "argo.tee".

Returns:

Returns "true" if we show bold names.

getShowBoldNamesValue

@Deprecated
public boolean getShowBoldNamesValue()

Deprecated. for 0.27.2 by tfmorris. Use DiagramSettings.

Returns:

Returns true if we show bold names.

setShowBoldNames

@Deprecated
public void setShowBoldNames(java.lang.String showbold)

Deprecated. for 0.27.2 by tfmorris. Use DiagramSettings.

Parameters:

showbold - true if names are to be shown in bold font.

setShowBoldNames

@Deprecated
public void setShowBoldNames(boolean showem)

Deprecated. for 0.27.2 by tfmorris. Use DiagramSettings.

Parameters:

showem - true if names are to be shown in bold font.

getUseGuillemots

public java.lang.String getUseGuillemots()

Used by "argo.tee".

Returns:

Returns "true" if we show guillemets.

See Also:

getUseGuillemotsValue()

getUseGuillemotsValue

public boolean getUseGuillemotsValue()

Get setting controlling whether guillemets (the double angle brackets quotation mark characters from Unicode) are to be used for formatting instead of two individual characters for each quote mark (e.g. >>). NOTE: This affects not only the Diagrams, but also display in the explorer view and other places.

Returns:

Returns true if we show guillemets.

setUseGuillemots

public void setUseGuillemots(java.lang.String showem)

Parameters:

showem - true if guillemets are to be used.

See Also:

getUseGuillemotsValue()

setUseGuillemots

public void setUseGuillemots(boolean showem)

Parameters:

showem - true if guillemets are to be shown.

See Also:

getUseGuillemotsValue()

getLeftGuillemot

@Deprecated
public java.lang.String getLeftGuillemot()

Deprecated. for 0.27.2 by tfmorris. There's no need for a separate method for this. It can be easily handled in a format string using the results of DiagramSettings#isUseGuillemets().

Returns:

the left pointing guillemet, i.e. << or the one-character symbol

getRightGuillemot

@Deprecated
public java.lang.String getRightGuillemot()

Deprecated. for 0.27.2 by tfmorris. There's no need for a separate method for this. It can be easily handled in a format string using the results of DiagramSettings#isUseGuillemets().

Returns:

the right pointing guillemet, i.e. >> or the one-character symbol

getShowAssociationNames

@Deprecated
public java.lang.String getShowAssociationNames()

Deprecated. for 0.27.2 by tfmorris. Use NotationSettings.

Used by "argo.tee".

Returns:

Returns "true" if we show association names.

getShowAssociationNamesValue

@Deprecated
public boolean getShowAssociationNamesValue()

Deprecated. for 0.27.2 by tfmorris. Use NotationSettings.

Returns:

Returns true if we show association names.

setShowAssociationNames

@Deprecated
public void setShowAssociationNames(java.lang.String showem)

Deprecated. for 0.27.2 by tfmorris. Use NotationSettings.

Parameters:

showem - true if association names are to be shown.

setShowAssociationNames

@Deprecated
public void setShowAssociationNames(boolean showem)

Deprecated. for 0.27.2 by tfmorris. Use NotationSettings.

Parameters:

showem - true if association names are to be shown.

getShowVisibility

@Deprecated
public java.lang.String getShowVisibility()

Deprecated. for 0.27.2 by tfmorris. Use NotationSettings.

Used by "argo.tee".

Returns:

Returns "true" if we show visibilities.

getShowVisibilityValue

@Deprecated
public boolean getShowVisibilityValue()

Deprecated. for 0.27.2 by tfmorris. Use NotationSettings.

Returns:

Returns true if we show visibilities.

setShowVisibility

@Deprecated
public void setShowVisibility(java.lang.String showem)

Deprecated. for 0.27.2 by tfmorris. Use NotationSettings.

Parameters:

showem - true if visibilities are to be shown.

setShowVisibility

@Deprecated
public void setShowVisibility(boolean showem)

Deprecated. for 0.27.2 by tfmorris. Use NotationSettings.

Parameters:

showem - true if visibilities are to be shown.

getShowMultiplicity

@Deprecated
public java.lang.String getShowMultiplicity()

Deprecated. for 0.27.2 by tfmorris. Use NotationSettings.

Used by "argo.tee".

Returns:

Returns "true" if we show multiplicities.

getShowMultiplicityValue

@Deprecated
public boolean getShowMultiplicityValue()

Deprecated. for 0.27.2 by tfmorris. Use NotationSettings.

Returns:

Returns true if we show multiplicities.

setShowMultiplicity

@Deprecated
public void setShowMultiplicity(java.lang.String showem)

Deprecated. for 0.27.2 by tfmorris. Use NotationSettings.

Parameters:

showem - true if multiplicity is to be shown.

setShowMultiplicity

@Deprecated
public void setShowMultiplicity(boolean showem)

Deprecated. for 0.27.2 by tfmorris. Use NotationSettings.

Parameters:

showem - true if the multiplicity is to be shown.

getShowInitialValue

@Deprecated
public java.lang.String getShowInitialValue()

Deprecated. for 0.27.2 by tfmorris. Use NotationSettings.

Used by "argo.tee".

Returns:

Returns "true" if we show initial values.

getShowInitialValueValue

@Deprecated
public boolean getShowInitialValueValue()

Deprecated. for 0.27.2 by tfmorris. Use NotationSettings.

Returns:

Returns true if we show initial values.

setShowInitialValue

@Deprecated
public void setShowInitialValue(java.lang.String showem)

Deprecated. for 0.27.2 by tfmorris. Use NotationSettings.

Parameters:

showem - true if initial values are to be shown.

setShowInitialValue

@Deprecated
public void setShowInitialValue(boolean showem)

Deprecated. for 0.27.2 by tfmorris. Use NotationSettings.

Parameters:

showem - true if initial values are to be shown.

getShowProperties

@Deprecated
public java.lang.String getShowProperties()

Deprecated. for 0.27.2 by tfmorris. Use NotationSettings.

Used by "argo.tee".

Returns:

Returns "true" if we show properties.

getShowPropertiesValue

@Deprecated
public boolean getShowPropertiesValue()

Deprecated. for 0.27.2 by tfmorris. Use NotationSettings.

Returns:

Returns true if we show properties.

setShowProperties

@Deprecated
public void setShowProperties(java.lang.String showem)

Deprecated. for 0.27.2 by tfmorris. Use NotationSettings.

Parameters:

showem - true if properties are to be shown.

setShowProperties

@Deprecated
public void setShowProperties(boolean showem)

Deprecated. for 0.27.2 by tfmorris. Use NotationSettings.

Parameters:

showem - true if properties are to be shown.

getShowTypes

@Deprecated
public java.lang.String getShowTypes()

Deprecated. for 0.27.2 by tfmorris. Use NotationSettings.

Used by "argo.tee".

Returns:

Returns "true" if we show types.

getShowTypesValue

@Deprecated
public boolean getShowTypesValue()

Deprecated. for 0.27.2 by tfmorris. Use NotationSettings.

Returns:

Returns true if we show types.

setShowTypes

@Deprecated
public void setShowTypes(java.lang.String showem)

Deprecated. for 0.27.2 by tfmorris. Use NotationSettings.

Parameters:

showem - true if types are to be shown.

setShowTypes

@Deprecated
public void setShowTypes(boolean showem)

Deprecated. for 0.27.2 by tfmorris. Use NotationSettings.

Parameters:

showem - true if types are to be shown.

getShowStereotypes

public java.lang.String getShowStereotypes()

Used by "argo.tee".

Returns:

Returns "true" if we show stereotypes in the explorer.

getShowStereotypesValue

public boolean getShowStereotypesValue()

TODO: Is this used in places other than on Diagrams? If so, it needs to stay in ProjectSettings (as well as being a DiagramSetting).

Returns:

Returns true if we show stereotypes in the explorer

setShowStereotypes

public void setShowStereotypes(java.lang.String showem)

Parameters:

showem - true if stereotypes are to be shown in the explorer.

setShowStereotypes

public void setShowStereotypes(boolean showem)

Parameters:

showem - true if stereotypes are to be shown in the explorer view.

getShowSingularMultiplicities

@Deprecated
public java.lang.String getShowSingularMultiplicities()

Deprecated. for 0.27.2 by tfmorris. Use NotationSettings.

Used by "argo.tee".

Returns:

Returns "true" if we show "1" Multiplicities.

getShowSingularMultiplicitiesValue

@Deprecated
public boolean getShowSingularMultiplicitiesValue()

Deprecated. for 0.27.2 by tfmorris. Use NotationSettings.

Returns:

Returns true if we show "1" Multiplicities.

setShowSingularMultiplicities

@Deprecated
public void setShowSingularMultiplicities(java.lang.String showem)

Deprecated. for 0.27.2 by tfmorris. Use NotationSettings.

Parameters:

showem - true if "1" Multiplicities are to be shown.

setShowSingularMultiplicities

@Deprecated
public void setShowSingularMultiplicities(boolean showem)

Deprecated. for 0.27.2 by tfmorris. Use NotationSettings.

Parameters:

showem - true if "1" Multiplicities are to be shown.

getHideBidirectionalArrows

@Deprecated
public java.lang.String getHideBidirectionalArrows()

Deprecated. for 0.27.2 by tfmorris. Use DiagramSettings.

Used by "argo.tee".

Returns:

Returns "true" if we show the arrows when both association ends of an association are navigable.

getHideBidirectionalArrowsValue

@Deprecated
public boolean getHideBidirectionalArrowsValue()

Deprecated. for 0.27.2 by tfmorris. Use DiagramSettings.

Returns:

Returns true if we show the arrows when both association ends of an association are navigable.

setHideBidirectionalArrows

@Deprecated
public void setHideBidirectionalArrows(java.lang.String hideem)

Deprecated. for 0.27.2 by tfmorris. Use DiagramSettings.

Parameters:

hideem - true if both arrows are to be shown when both association ends of an association are navigable.

setHideBidirectionalArrows

@Deprecated
public void setHideBidirectionalArrows(boolean hideem)

Deprecated. for 0.27.2 by tfmorris. Use DiagramSettings.

Parameters:

hideem - true if both arrows are to be shown when both association ends of an association are navigable.

getDefaultShadowWidth

@Deprecated
public java.lang.String getDefaultShadowWidth()

Deprecated. for 0.27.2 by tfmorris. Use DiagramSettings.

Used by "argo.tee".

Returns:

Returns the shadow width.

getDefaultShadowWidthValue

@Deprecated
public int getDefaultShadowWidthValue()

Deprecated. for 0.27.2 by tfmorris. Use DiagramSettings.

Returns:

Returns the shadow width.

setDefaultShadowWidth

@Deprecated
public void setDefaultShadowWidth(int newWidth)

Deprecated. for 0.27.2 by tfmorris. Use DiagramSettings.

Parameters:

newWidth - The Shadow Width.

setDefaultShadowWidth

@Deprecated
public void setDefaultShadowWidth(java.lang.String width)

Deprecated. for 0.27.2 by tfmorris. Use DiagramSettings.

Parameters:

width - The shadow width to set.

getDefaultStereotypeView

@Deprecated
public java.lang.String getDefaultStereotypeView()

Deprecated. for 0.27.2 by tfmorris. Use DiagramSettings.

Used by "argo.tee".

Returns:

Returns the default stereotype view

getDefaultStereotypeViewValue

@Deprecated
public int getDefaultStereotypeViewValue()

Deprecated. for 0.27.2 by tfmorris. Use DiagramSettings.

Returns:

Returns the default stereotype view

getGenerationOutputDir

@Deprecated
public java.lang.String getGenerationOutputDir()

Deprecated. for 0.27.2 by tfmorris. This is a user setting, not a project setting.

No longer used by "argo.tee". All uses deprecated.

Returns:

the output directory name

setGenerationOutputDir

@Deprecated
public void setGenerationOutputDir(java.lang.String od)

Deprecated. for 0.27.2 by tfmorris. This is a user setting, not a project setting. Any uses will be ignored.

Parameters:

od - the output directory name

getHeaderComment

public java.lang.String getHeaderComment()

Returns:

the header comment string

setDefaultStereotypeView

@Deprecated
public void setDefaultStereotypeView(int newView)

Deprecated. for 0.27.2 by tfmorris. Use DiagramSettings.

Parameters:

newView - the default stereotype view

setHeaderComment

public void setHeaderComment(java.lang.String c)

Parameters:

c - the header comment string

getFontName

@Deprecated
public java.lang.String getFontName()

Deprecated. for 0.27.2 by tfmorris. Use DiagramSettings.

Diagram font name.

Used by "argo.tee".

Returns:

diagram font name.

setFontName

@Deprecated
public void setFontName(java.lang.String newFontName)

Deprecated. for 0.27.2 by tfmorris. Use DiagramSettings.

Diagram font name.

Parameters:

newFontName - diagram font name.

getFontSize

@Deprecated
public int getFontSize()

Deprecated. for 0.27.2 by tfmorris. Use DiagramSettings.

Diagram font size.

Used by "argo.tee".

Returns:

diagram font size.

setFontSize

@Deprecated
public void setFontSize(int newFontSize)

Deprecated. for 0.27.2 by tfmorris. Use DiagramSettings.

Diagram font size.

Parameters:

newFontSize - diagram font size.

getFontPlain

@Deprecated
public java.awt.Font getFontPlain()

Deprecated. for 0.27.2 by tfmorris. Use DiagramSettings.

Returns the Plain diagram font which corresponds to selected parameters.

Returns:

plain diagram font

getFontItalic

@Deprecated
public java.awt.Font getFontItalic()

Deprecated. for 0.27.2 by tfmorris. Use DiagramSettings.

Returns the Italic diagram font which corresponds to selected parameters.

Returns:

italic diagram font

getFontBold

@Deprecated
public java.awt.Font getFontBold()

Deprecated. for 0.27.2 by tfmorris. Use DiagramSettings.

Returns the Bold diagram font which corresponds to selected parameters.

Returns:

bold diagram font

getFontBoldItalic

@Deprecated
public java.awt.Font getFontBoldItalic()

Deprecated. for 0.27.2 by tfmorris. Use DiagramSettings.

Returns the Bold-Italic diagram font which corresponds to selected parameters.

Returns:

bold-italic diagram font

getFont

@Deprecated
public java.awt.Font getFont(int fontStyle)

Deprecated. for 0.27.2 by tfmorris. Use DiagramSettings.

Utility function to convert a font style integer into a Font.

Parameters:

fontStyle - the style; see the predefined constants in Font

Returns:

the Font that corresponds to the style