org.openide.windows

Class ModeUtilities

java.lang.Object

org.openide.windows.ModeUtilities

public final class ModeUtilities
extends Object

Utility class to help clients manage Modes in order to layout TopComponents in predefined "work-spaces".

In a NetBeans Platform application, a user may create various TopComponents and drag them around, into and out of the existing defined Modes (e.g. editor, explorer) or new "anonymous" Modes which get created by the system as needed.

The configuration of each Mode can be expressed in XML. This class gives access to that XML. WindowManager provides a mechanism to reproduce a Mode from XML so you can construct ways to save Mode and TopComponent combinations, which can subsequently be chosen and reloaded at a later time.

Note that this is a different approach to how the Platform tends to save the layout of TopComponents at shut-down time in the Windows2Local file system. Note also that this is not connected with the deprecated notion of Workspace.

Since:

6.82

See Also:

http://wiki.apidesign.org/wiki/ExtendingInterfaces

Method Summary

Modifier and Type	Method and Description
static String	toXml(Mode mode) Expose the Mode's configuration as XML.

Methods inherited from class java.lang.Object

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

Method Detail

toXml

public static final String toXml(Mode mode)

Expose the Mode's configuration as XML.

Parameters:

mode - the Mode whose XML configuration is required.

Returns:

the XML of the Mode's configuration or null if not supported.