Java Doc for DockableWindowManager.java in  » Swing-Library » jEdit » org » gjt » sp » jedit » gui » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Keeps track of all dockable windows for a single View, and provides an API for getting/showing/hiding them.

Each org.gjt.sp.jedit.View has an instance of this class.

dockables.xml:

Dockable window definitions are read from dockables.xml files contained inside plugin JARs. A dockable definition file has the following form:

<?xml version="1.0"?>
 <!DOCTYPE DOCKABLES SYSTEM "dockables.dtd">
 <DOCKABLES>
 <DOCKABLE NAME="dockableName" MOVABLE="TRUE|FALSE">
 // Code to create the dockable
 </DOCKABLE>
 </DOCKABLES>

The MOVABLE attribute specifies the behavior when the docking position of the dockable window is changed. If MOVABLE is TRUE, the existing instance of the dockable window is moved to the new docking position, and if the dockable window implements the DockableWindow interface (see DockableWindow ), it is also notified about the change in docking position before it is moved. If MOVABLE is FALSE, the BeanShell code is invoked to get the instance of the dockable window to put in the new docking position. Typically, the BeanShell code returns a new instance of the dockable window, and the state of the existing instance is not preserved after the change. It is therefore recommended to set MOVABLE to TRUE for all dockables in order to make them preserve their state when they are moved. For backward compatibility reasons, this attribute is set to FALSE by default.

More than one <DOCKABLE> tag may be present. The code that creates the dockable can reference any BeanShell built-in variable (see org.gjt.sp.jedit.BeanShell ), along with a variable position whose value is one of DockableWindowManager.FLOATING , DockableWindowManager.TOP , DockableWindowManager.LEFT , DockableWindowManager.BOTTOM , and DockableWindowManager.RIGHT .

The following properties must be defined for each dockable window:

• dockableName.title - the string to show on the dockable button.
• dockableName.label - The string to use for generating menu items and action names.
• dockableName.longtitle - (optional) the string to use in the dockable's floating window title (when it is floating). If not specified, the dockableName.title property is used.

• dockableName - opens the dockable window.
• dockableName-toggle - toggles the dockable window's visibility.
• dockableName-float - opens the dockable window in a new floating window.

Implementation details:

When an instance of this class is initialized by the org.gjt.sp.jedit.View class, it iterates through the list of registered dockable windows (from jEdit itself, and any loaded plugins) and examines options supplied by the user in the Global Options dialog box. Any plugins designated for one of the four docking positions are displayed.

To create an instance of a dockable window, the DockableWindowManager finds and executes the BeanShell code extracted from the appropriate dockables.xml file. This code will typically consist of a call to the constructor of the dockable window component. The result of the BeanShell expression, typically a newly constructed component, is placed in a window managed by this class.