org.argouml.application.api
Class Argo

java.lang.Object
  org.argouml.application.api.Argo

public final class Argo

extends Object

The Argo class provides static methods and definitions that can be used as helpers throughout the Argo code.

This class is a variation of the Expert design pattern [Grand]. By incorporating a number of unrelated but commonly used methods in a single class, it attempts to decrease the complexity of the overall code while increasing its own complexity.

These include

• definitions of configuration keys
• definitions of resource bundle identifier strings
• methods for localization using gef
• methods for environment manipulation

RESOURCEDIR

public static final String RESOURCEDIR

Key for argo resource directory.

See Also:

Constant Field Values

ARGOINI

public static final String ARGOINI

argo.ini path.

See Also:

Constant Field Values

KEY_STARTUP_DIR

public static final ConfigurationKey KEY_STARTUP_DIR

Key for default startup directory.

KEY_SPLASH

public static final ConfigurationKey KEY_SPLASH

Key to show splash screen.

KEY_PRELOAD

public static final ConfigurationKey KEY_PRELOAD

Key to preload classes.

KEY_EDEM

public static final ConfigurationKey KEY_EDEM

Key to report usage statistics.

KEY_MOST_RECENT_PROJECT_FILE

public static final ConfigurationKey KEY_MOST_RECENT_PROJECT_FILE

Key for last saved project URL.

KEY_RELOAD_RECENT_PROJECT

public static final ConfigurationKey KEY_RELOAD_RECENT_PROJECT

Key to reload last saved project on startup.

KEY_NUMBER_LAST_RECENT_USED

public static final ConfigurationKey KEY_NUMBER_LAST_RECENT_USED

Key for number of last recently used file entries in menu list.

KEY_SCREEN_TOP_Y

public static final ConfigurationKey KEY_SCREEN_TOP_Y

Key for screen top.

KEY_SCREEN_LEFT_X

public static final ConfigurationKey KEY_SCREEN_LEFT_X

Key for screen left.

KEY_SCREEN_WIDTH

public static final ConfigurationKey KEY_SCREEN_WIDTH

Key for screen width.

KEY_SCREEN_HEIGHT

public static final ConfigurationKey KEY_SCREEN_HEIGHT

Key for screen height.

KEY_SCREEN_SOUTHWEST_WIDTH

public static final ConfigurationKey KEY_SCREEN_SOUTHWEST_WIDTH

Key for southwest pane width.

KEY_SCREEN_NORTHWEST_WIDTH

public static final ConfigurationKey KEY_SCREEN_NORTHWEST_WIDTH

Key for northwest pane width.

KEY_SCREEN_SOUTHEAST_WIDTH

public static final ConfigurationKey KEY_SCREEN_SOUTHEAST_WIDTH

Key for southeast pane width.

KEY_SCREEN_NORTHEAST_WIDTH

public static final ConfigurationKey KEY_SCREEN_NORTHEAST_WIDTH

Key for northeast pane width.

KEY_SCREEN_WEST_WIDTH

public static final ConfigurationKey KEY_SCREEN_WEST_WIDTH

Key for west pane width.

KEY_SCREEN_EAST_WIDTH

public static final ConfigurationKey KEY_SCREEN_EAST_WIDTH

Key for east pane width.

KEY_SCREEN_SOUTH_HEIGHT

public static final ConfigurationKey KEY_SCREEN_SOUTH_HEIGHT

Key for south pane height.

KEY_SCREEN_NORTH_HEIGHT

public static final ConfigurationKey KEY_SCREEN_NORTH_HEIGHT

Key for north pane height.

KEY_SCREEN_THEME

public static final ConfigurationKey KEY_SCREEN_THEME

Key for theme.

KEY_LOOK_AND_FEEL_CLASS

public static final ConfigurationKey KEY_LOOK_AND_FEEL_CLASS

Key for look and feel class name.

KEY_THEME_CLASS

public static final ConfigurationKey KEY_THEME_CLASS

Key for theme class name.

KEY_SMOOTH_EDGES

public static final ConfigurationKey KEY_SMOOTH_EDGES

Key to enable smooth edges of diagram text and lines (anti-aliasing).

KEY_USER_EMAIL

public static final ConfigurationKey KEY_USER_EMAIL

Key for user email address.

KEY_USER_FULLNAME

public static final ConfigurationKey KEY_USER_FULLNAME

Key for user full name.

KEY_USER_IMPORT_CLASSPATH

public static final ConfigurationKey KEY_USER_IMPORT_CLASSPATH

Key for user java reverse engineering classpath.

KEY_INPUT_SOURCE_ENCODING

public static final ConfigurationKey KEY_INPUT_SOURCE_ENCODING

Key for input source file encoding used in RE. Will be used for generated file also.

KEY_XMI_STRIP_DIAGRAMS

public static final ConfigurationKey KEY_XMI_STRIP_DIAGRAMS

Key to store setting of stripping diagrams on XMI import.

KEY_DEFAULT_MODEL

public static final ConfigurationKey KEY_DEFAULT_MODEL

Key to store profile/default model.

KEY_USER_EXPLORER_PERSPECTIVES

public static final ConfigurationKey KEY_USER_EXPLORER_PERSPECTIVES

Key for user explorer perspectives.

 format:
 perspective name,rule,rule,rule;perspective name, etc

KEY_LOCALE

public static final ConfigurationKey KEY_LOCALE

Key for selecting the locale.

CONSOLE_LOG

public static final String CONSOLE_LOG

Standard definition of the logging category for the console.

See Also:

Constant Field Values

ARGO_CONSOLE_SUPPRESS

public static final String ARGO_CONSOLE_SUPPRESS

Standard definition of the logging category for the console.

See Also:

Constant Field Values

ARGO_CONSOLE_PREFIX

public static final String ARGO_CONSOLE_PREFIX

Standard definition of system variable to add text prefix to console log.

See Also:

Constant Field Values

setDirectory

public static void setDirectory(String dir)

Change the default startup directory.

Parameters:

dir - the directory to save

getDirectory

public static String getDirectory()

Get the default startup directory.

Returns:

the startup directory

getPlugins

public static ArrayList getPlugins(Class pluginType,
                                   Object[] context)

Deprecated. by Linus Tolke for 0.21.3. This is replaced by the new module loader.

Returns a vector of plugins of the class type passed which satisfy both of the contexts required. If no plugins are available, returns null.

Parameters:

pluginType - class of the plugin to search for

context - plugin-specific query parameters

Returns:

a vector of plugins or null

getPlugins

public static ArrayList getPlugins(Class pluginType)

Deprecated. by Linus Tolke for 0.21.3. This is replaced by the new module loader.

Returns a vector of all plugins of the class type passed. If no plugins are available, returns null.

Parameters:

pluginType - class of the plugin to search for

Returns:

a vector of plugins or null

initializeModules

public static void initializeModules()

Deprecated. by Linus Tolke for 0.21.3. There is no reason to let this call go through the Argo class.

Initializes the module loader. Multiple calls are ignored.

getArgoHome

public static String getArgoHome()

Deprecated. by Linus Tolke for 0.21.3. I don't think there is a reason to let this call go through the Argo class.

Convenience helper to access the argo home directory.

Returns:

the argo home directory

getArgoRoot

public static String getArgoRoot()

Deprecated. by Linus Tolke for 0.21.3. I don't think there is a reason to let this call go through the Argo class.

Convenience helper to access the argo root directory.

Returns:

the argo root directory

lookupIconResource

public static Icon lookupIconResource(String arg1)

Look up an icon resource.

Parameters:

arg1 - the name of the resource to find.

Returns:

an Icon

lookupIconResource

public static Icon lookupIconResource(String arg1,
                                      String arg2)

Look up an icon resource.

Parameters:

arg1 - the name of the resource to find.

arg2 - the description of the resource

Returns:

an Icon