org.fife.ui.app
Class GUIPlugin

java.lang.Object
  org.fife.ui.app.GUIPlugin

All Implemented Interfaces:

DockableWindowConstants, GUIApplicationConstants, Plugin

Direct Known Subclasses:

FileSystemTreePlugin, SourceBrowserPlugin

public abstract class GUIPlugin

extends java.lang.Object

implements Plugin, GUIApplicationConstants

A plugin thats includes one or more dockable windows.

Version:

0.8

Author:

Robert Futrell

See Also:

Plugin, AbstractPluggableGUIApplication, DockableWindow

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

GUIPlugin()
Constructor.

Method Summary

java.util.Iterator	dockableWindowIterator() Returns an iterator over all dockable windows in this plugin.
DockableWindow	getDockableWindow(java.lang.String id) Returns a dockable window.
protected void	putDockableWindow(java.lang.String id, DockableWindow window) Associates a dockable window with an identifier.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.fife.ui.app.Plugin

getOptionsDialogPanel, getPluginAuthor, getPluginIcon, getPluginName, getPluginVersion, install, savePreferences, uninstall

Constructor Detail

GUIPlugin

public GUIPlugin()

Constructor.

Method Detail

dockableWindowIterator

public java.util.Iterator dockableWindowIterator()

Returns an iterator over all dockable windows in this plugin.

Returns:

An iterator.

See Also:

getDockableWindow(String)

getDockableWindow

public DockableWindow getDockableWindow(java.lang.String id)

Returns a dockable window.

Parameters:

id - The id for the dockable window.

Returns:

The dockable window, or null if no dockable window is associated with that identifier.

See Also:

putDockableWindow(String, DockableWindow), dockableWindowIterator()

putDockableWindow

protected void putDockableWindow(java.lang.String id,
                                 DockableWindow window)

Associates a dockable window with an identifier.

Parameters:

id - The identifier.

window - The dockable window.

See Also:

getDockableWindow(String)