org.fife.ui.app
Class GUIPlugin

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

All Implemented Interfaces:

GUIApplicationConstants, Plugin, DockableWindowConstants

Direct Known Subclasses:

FileSystemTreePlugin, Plugin, ProjectPlugin, SourceBrowserPlugin, TasksPlugin, ToolPlugin

public abstract class GUIPlugin
extends AbstractPlugin
implements 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<DockableWindow>	dockableWindowIterator() Returns an iterator over all dockable windows in this plugin.
DockableWindow	getDockableWindow(java.lang.String id) Returns a dockable window.
protected void	lookAndFeelChanged(javax.swing.LookAndFeel newLaf) Overridden to update the LookAndFeel of any non-active (i.e. not visible) dockable windows owned by this plugin.
protected void	putDockableWindow(java.lang.String id, DockableWindow window) Associates a dockable window with an identifier.

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

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

lookAndFeelChanged

protected void lookAndFeelChanged(javax.swing.LookAndFeel newLaf)

Overridden to update the LookAndFeel of any non-active (i.e. not visible) dockable windows owned by this plugin. Active dockable windows are automatically handled by the main window's updating of its UI.

Subclasses can override if they have modal dialogs (for example) that are cached and should be updated, but should call into the super implementation.

Overrides:

lookAndFeelChanged in class AbstractPlugin

Parameters:

newLaf - The new LookAndFeel.

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)