org.fife.rtext.plugins.filesystemtree
Class FileSystemTreePlugin

java.lang.Object
  org.fife.ui.app.AbstractPlugin
      org.fife.ui.app.GUIPlugin
          org.fife.rtext.plugins.filesystemtree.FileSystemTreePlugin

All Implemented Interfaces:

GUIApplicationConstants, Plugin, DockableWindowConstants

public class FileSystemTreePlugin
extends GUIPlugin

A panel displaying all files on the local file system, allowing for quick and easy opening of files without opening the file chooser.

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

FileSystemTreePlugin(AbstractPluggableGUIApplication app)
Creates a new FileSystemTreePlugin.

Method Summary

PluginOptionsDialogPanel	getOptionsDialogPanel() Returns the options panel for this source browser.
java.lang.String	getPluginAuthor() Returns the author of the plugin.
javax.swing.Icon	getPluginIcon() Returns the icon for this plugin.
java.lang.String	getPluginName() Returns the name of this GUIPlugin.
java.lang.String	getPluginVersion() Returns the plugin version.
void	goInto(java.io.File dir) Drills into a directory.
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.
boolean	uninstall() Called just before this Plugin is removed from an RText instance.

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

FileSystemTreePlugin

public FileSystemTreePlugin(AbstractPluggableGUIApplication app)

Creates a new FileSystemTreePlugin.

Parameters:

app - The RText instance.

Method Detail

getOptionsDialogPanel

public PluginOptionsDialogPanel getOptionsDialogPanel()

Returns the options panel for this source browser.

Returns:

The options panel.

getPluginAuthor

public java.lang.String getPluginAuthor()

Returns the author of the plugin.

Returns:

The plugin's author.

getPluginIcon

public javax.swing.Icon getPluginIcon()

Returns the icon for this plugin.

Returns:

The icon for this plugin.

getPluginName

public java.lang.String getPluginName()

Returns the name of this GUIPlugin.

Returns:

This plugin's name.

getPluginVersion

public java.lang.String getPluginVersion()

Returns the plugin version.

Returns:

The version number of this plugin.

goInto

public void goInto(java.io.File dir)

Drills into a directory.

Parameters:

dir - The directory to drill into.

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

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 RText instance. Here we uninstall any listeners we registered.

Returns:

Whether the uninstall went cleanly.

See Also:

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