org.fife.rtext.plugins.console
Class Plugin

java.lang.Object
  org.fife.ui.app.AbstractPlugin
      org.fife.rtext.plugins.console.Plugin

All Implemented Interfaces:

Plugin

public class Plugin

extends AbstractPlugin

A plugin that allows the user to have a command prompt embedded in RText.

Version:

1.0

Author:

Robert Futrell

Field Summary

protected static java.util.ResourceBundle

msg

Constructor Summary

Plugin(AbstractPluggableGUIApplication app)
Constructor.

Method Summary

org.fife.rtext.plugins.console.ConsoleWindow	getDockableWindow() Returns the dockable window containing the consoles.
PluginOptionsDialogPanel	getOptionsDialogPanel() Returns an options panel for use in an Options dialog. This panel should contain all options pertaining to this plugin.
java.lang.String	getPluginAuthor() Returns the author of the plugin.
javax.swing.Icon	getPluginIcon() Returns the icon to display beside the name of this plugin in the application's interface.
java.lang.String	getPluginName() Returns the name of the plugin.
java.lang.String	getPluginVersion() Returns the version of the plugin.
RText	getRText() Returns the parent application.
java.lang.String	getString(java.lang.String key) Returns a localized message.
java.lang.String	getString(java.lang.String key, java.lang.String param) Returns a localized message.
java.lang.String	getString(java.lang.String key, java.lang.String param1, java.lang.String param2) Returns a localized message.
void	install(AbstractPluggableGUIApplication app) Called just after a plugin is added to a GUI application.
void	savePreferences() Called when the GUI application is shutting down. When this method is called, the Plugin should save any preferences.
void	stopCurrentProcess() Stops the currently running process, if any.
boolean	uninstall() Called just before this Plugin is removed from an GUIApplication. This gives the plugin a chance to clean up any loose ends (kill any threads, close any files, remove listeners, etc.).

Methods inherited from class org.fife.ui.app.AbstractPlugin

getOptionsDialogPanelParentPanelID, setOptionsDialogPanelParentPanelID

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

msg

protected static final java.util.ResourceBundle msg

Constructor Detail

Plugin

public Plugin(AbstractPluggableGUIApplication app)

Constructor.

Parameters:

app - The parent application.

Method Detail

getDockableWindow

public org.fife.rtext.plugins.console.ConsoleWindow getDockableWindow()

Returns the dockable window containing the consoles.

Returns:

The dockable window.

getOptionsDialogPanel

public PluginOptionsDialogPanel getOptionsDialogPanel()

Returns an options panel for use in an Options dialog. This panel should contain all options pertaining to this plugin.

Returns:

The options panel.

getPluginAuthor

public java.lang.String getPluginAuthor()

Returns the author of the plugin.

Returns:

The author.

getPluginIcon

public javax.swing.Icon getPluginIcon()

Returns the icon to display beside the name of this plugin in the application's interface.

Returns:

The icon for this plugin. This value may be null to represent no icon.

getPluginName

public java.lang.String getPluginName()

Returns the name of the plugin.

Returns:

The plugin name.

getPluginVersion

public java.lang.String getPluginVersion()

Returns the version of the plugin.

Returns:

The version number of this plugin.

getRText

public RText getRText()

Returns the parent application.

Returns:

The parent application.

getString

public java.lang.String getString(java.lang.String key)

Returns a localized message.

Parameters:

key - The key.

Returns:

The localized message.

See Also:

getString(String, String), getString(String, String, String)

getString

public java.lang.String getString(java.lang.String key,
                                  java.lang.String param)

Returns a localized message.

Parameters:

key - The key.

param - A parameter for the localized message.

Returns:

The localized message.

See Also:

getString(String), getString(String, String, String)

getString

public java.lang.String getString(java.lang.String key,
                                  java.lang.String param1,
                                  java.lang.String param2)

Returns a localized message.

Parameters:

key - The key.

param1 - A parameter for the localized message.

param2 - A parameter for the localized message.

Returns:

The localized message.

See Also:

getString(String), getString(String, String)

install

public void install(AbstractPluggableGUIApplication app)

Description copied from interface: Plugin

Called just after a plugin is added to a GUI application. If this is a GUIPlugin, it has already been added visually. Plugins should use this method to register any listeners to the GUI application and do any other necessary setup.

Parameters:

app - The application to which this plugin was just added.

See Also:

Plugin.uninstall()

savePreferences

public void savePreferences()

Called when the GUI application is shutting down. When this method is called, the Plugin should save any preferences.

stopCurrentProcess

public void stopCurrentProcess()

Stops the currently running process, if any.

uninstall

public boolean uninstall()

Called just before this Plugin is removed from an GUIApplication. This gives the plugin a chance to clean up any loose ends (kill any threads, close any files, remove listeners, etc.).

Returns:

Whether the uninstall went cleanly.

See Also:

Plugin.install(org.fife.ui.app.AbstractPluggableGUIApplication)