com.virtuosotechnologies.asaph.maingui
Interface PrefsWindowManager

All Superinterfaces:

PaneContainer

public interface PrefsWindowManager

extends PaneContainer

The preferences window manager API exported by the maingui plugin. This is a PaneContainer that allows plugins to display panes in Asaph's prefs window.

The addPane() method understands the following initial properties:

• INITIAL_PANE_TITLE
• PANE_DESCRIPTION
• PANE_POSITION_END

The PaneController returned by this PaneContainer does NOT allow closes to be vetoed, and provides the following properties:

• PANE_JCOMPONENT (uneditable)
• PANE_TITLE (editable)
• PANE_OPEN (editable to false only)
• PANE_DESCRIPTION (editable)

Additional properties (such as PANE_FOCUSED) will be added in the future.

This API is not thread-safe, and should only be called from the AWT/Swing thread.

Field Summary

static ClassConstrainedKey	PANE_DESCRIPTION Property key for description, used both for initial requested properties and for PaneController properties.
static ClassConstrainedKey	PANE_POSITION_END Property key to force the position of this pane to remain towards the back.

Fields inherited from interface com.virtuosotechnologies.lib.pane.PaneContainer

INITIAL_PANE_LOCATION, INITIAL_PANE_MENUBAR, INITIAL_PANE_SIZE, INITIAL_PANE_TITLE

Method Summary

JComponent

getDialogParent() Get the dialog parent for the prefs window

Methods inherited from interface com.virtuosotechnologies.lib.pane.PaneContainer

addPane

Field Detail

PANE_DESCRIPTION

public static final ClassConstrainedKey PANE_DESCRIPTION

Property key for description, used both for initial requested properties and for PaneController properties. Class is String.

PANE_POSITION_END

public static final ClassConstrainedKey PANE_POSITION_END

Property key to force the position of this pane to remain towards the back. Class is Boolean.

Method Detail

getDialogParent

public JComponent getDialogParent()

Get the dialog parent for the prefs window

Returns:

the dialog parent JComponent