org.fife.rtext.plugins.tidy
Class Plugin

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

All Implemented Interfaces:

java.util.EventListener, Plugin, java.beans.PropertyChangeListener

public class Plugin

extends AbstractPlugin

implements java.beans.PropertyChangeListener

A plugin that "tidies" source code. This code calls into other libraries for its functionality.

Version:

1.0

Author:

Robert Futrell

Constructor Summary

Plugin(AbstractPluggableGUIApplication app)
Constructor.

Method Summary

HtmlOptions	getHtmlOptions() Returns the options related to tidying HTML.
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.
XmlOptions	getXmlOptions() Returns the options related to tidying XML.
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.
void	propertyChange(java.beans.PropertyChangeEvent e) Called whenever a change we're interested in occurs in RText.
void	savePreferences() Called when the GUI application is shutting down. When this method is called, the Plugin should save any preferences.
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

Constructor Detail

Plugin

public Plugin(AbstractPluggableGUIApplication app)

Constructor.

Parameters:

app - The parent application.

Method Detail

getHtmlOptions

public HtmlOptions getHtmlOptions()

Returns the options related to tidying HTML.

Returns:

The HTML options.

getOptionsDialogPanel

public PluginOptionsDialogPanel getOptionsDialogPanel()

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

Specified by:

getOptionsDialogPanel in interface Plugin

Returns:

The options panel.

getPluginAuthor

public java.lang.String getPluginAuthor()

Returns the author of the plugin.

Specified by:

getPluginAuthor in interface 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.

Specified by:

getPluginIcon in interface Plugin

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.

Specified by:

getPluginName in interface Plugin

Returns:

The plugin name.

getPluginVersion

public java.lang.String getPluginVersion()

Returns the version of the plugin.

Specified by:

getPluginVersion in interface Plugin

Returns:

The version number of this plugin.

getXmlOptions

public XmlOptions getXmlOptions()

Returns the options related to tidying XML.

Returns:

The XML tidying-options.

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.

Specified by:

install in interface Plugin

Parameters:

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

See Also:

Plugin.uninstall()

propertyChange

public void propertyChange(java.beans.PropertyChangeEvent e)

Called whenever a change we're interested in occurs in RText.

Specified by:

propertyChange in interface java.beans.PropertyChangeListener

Parameters:

e - The event.

savePreferences

public void savePreferences()

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

Specified by:

savePreferences in interface Plugin

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

Specified by:

uninstall in interface Plugin

Returns:

Whether the uninstall went cleanly.

See Also:

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