com.sas.workspace.plugins
Interface AboutInterface

public interface AboutInterface

This interface allows a plugin to describe itself. It also provides access to version and copyright information. An object implementing this interface is returned from PluginInterface.getAbout().

See Also:

com.sas.console.plugin.PluginInterface#getAbout

Method Summary

Vector	getAdditionalInfo() The additional information for the About Dialog.
String	getCopyright() The copyright information for the plugin.
String	getDescription() A short description of the plugin.
String	getFormalName() The String to display as the formal name of the plugin
ImageIcon	getImage() The ImageIcon to display in the dialog.
String	getVersion() The version of the plugin.

Method Detail

getImage

public ImageIcon getImage()

The ImageIcon to display in the dialog. This icon should be at least a 32bit icon.

Returns:

ImageIcon to display on the about window

getFormalName

public String getFormalName()

The String to display as the formal name of the plugin

Returns:

The formal display name of the plugin.

getVersion

public String getVersion()

The version of the plugin. The number is the only thing that is needed her as the label will already have "Version " in it

Returns:

Representation of the version for this plugin

getDescription

public String getDescription()

A short description of the plugin. For a longer description or additional information on the plugin, use the getAdditionalInfo method. This is displayed in a text area so line wrapping will be done automatically although a long description is discouraged through the getDescription method.

Returns:

Short description of the plugin.

getCopyright

public String getCopyright()

The copyright information for the plugin. This should only be the dates and copyright owner as the label will already contain "Copyright (c) "

getAdditionalInfo

public Vector getAdditionalInfo()

The additional information for the About Dialog. This information should be in a Vector but should be only strings. If only one object in the vector is found, a text area inside a scroll pane will be displayed. If multiple items are found, a JList will be displayed inside a scroll pane. If multi-demensional arrays are found, a table will be shown in a scroll pane.

Returns:

Vector of strings containing additional info