org.fife.rtext.plugins.tasks
Class TasksPlugin

java.lang.Object
  org.fife.ui.app.AbstractPlugin
      org.fife.ui.app.GUIPlugin
          org.fife.rtext.plugins.tasks.TasksPlugin

All Implemented Interfaces:

GUIApplicationConstants, Plugin, DockableWindowConstants

public class TasksPlugin
extends GUIPlugin

Plugin that adds "Tasks" support to RText.

Version:

1.0

Author:

Robert Futrell

Field Summary

Fields inherited from interface org.fife.ui.app.GUIApplicationConstants

OS_LINUX, OS_MAC_OSX, OS_OTHER, OS_WINDOWS

Fields inherited from interface org.fife.ui.dockablewindows.DockableWindowConstants

BOTTOM, FLOATING, LEFT, RIGHT, TOP

Constructor Summary

TasksPlugin(AbstractPluggableGUIApplication app)
Constructor.

Method Summary

PluginOptionsDialogPanel	getOptionsDialogPanel() Returns an options panel for use in an Options dialog.
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.
java.lang.String	getTaskIdentifiers() Returns the current task identifiers.
void	install(AbstractPluggableGUIApplication app) Called just after a plugin is added to a GUI application.
boolean	isTaskWindowVisible() Returns whether the task window is currently visible.
void	savePreferences() Called when the GUI application is shutting down.
boolean	uninstall() Called just before this Plugin is removed from an GUIApplication.

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

dockableWindowIterator, getDockableWindow, lookAndFeelChanged, putDockableWindow

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

Constructor Detail

TasksPlugin

public TasksPlugin(AbstractPluggableGUIApplication app)

Constructor.

Parameters:

app - The parent RText application.

Method Detail

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.

getTaskIdentifiers

public java.lang.String getTaskIdentifiers()

Returns the current task identifiers.

Returns:

The current task identifiers.

install

public void install(AbstractPluggableGUIApplication app)

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()

isTaskWindowVisible

public boolean isTaskWindowVisible()

Returns whether the task window is currently visible.

Returns:

Whether the task window is currently visible.

savePreferences

public void savePreferences()

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

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)