cern.gp.windows

Class WindowUtils

java.lang.Object

cern.gp.windows.WindowUtils

public class WindowUtils
extends java.lang.Object

Provides utility methods for windowing in NetBeans.

Author:

Katarina Sigerud

Field Summary

Fields

Modifier and Type	Field and Description
static int	DESKTOP_FRAME The frame resides docked left, right, top, or bottom
static int	INTERNAL_FRAME A frame that resides in the desktop
static int	PERSIST_ALWAYS always persist the TopComponent
static int	PERSIST_NEVER dont persist the TopComponent
static int	PERSIST_ONLY_OPENED persist a TopComponent only if it is opened
static int	PERSIST_UNKNOWN unkown persistence mode the TopComponent
static int	TOP_FRAME A frame that resides as a separate window

Method Summary

Modifier and Type	Method and Description
static Workspace	createWorkspace(java.lang.String codeName, java.lang.String displayName) Utility method: creates a workspace and adds it to the WindowManager's list of workspaces.
static TopComponent	findTopComponent(java.lang.String componentName) Utility method: Returns the TopComponent with the given programmatic name in the current workspace, or null if there is no such TopComponent.
static TopComponent	findTopComponent(Workspace workspace, java.lang.String componentName) Utility method: Returns the TopComponent with the given programmatic name in the given workspace, or null if there is no such TopComponent.
static void	frameResidesInDesktop(Mode mode) Utility method: makes the given mode reside in the desktop instead of as a separate window.
static void	frameResidesInDesktop(Mode mode, int frameType) Utility method: makes the given mode either reside in the desktop or display a separate window.
static int	getPersistMode(TopComponent comp) Get the persistence mode of the given TopComponent
static Mode	openInMode(TopComponent component, java.lang.String modeName) Utility method: opens a topcomponent in the current workspace in a mode with the indicated name.
static Mode	openInMode(TopComponent component, java.lang.String modeName, int frameType) Utility method: opens a topcomponent in the current workspace in a mode with the indicated name.
static Mode	openInMode(Workspace workspace, TopComponent component, java.lang.String modeName) Utility method: opens a topcomponent in the given workspace in a mode with the indicated name.
static Mode	openInMode(Workspace workspace, TopComponent component, java.lang.String modeName, int frameType) Utility method: opens a topcomponent in the given workspace in a mode with the indicated name.
static void	setFrameType(int frameType) Utility method: Sets the default windowing behavior, MDI or SDI.
static void	setPersistMode(TopComponent comp, int option) Determine under which conditions the TopComponent is persisted to the NetBeans system directory

Methods inherited from class java.lang.Object

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

Field Detail

INTERNAL_FRAME

public static final int INTERNAL_FRAME

A frame that resides in the desktop

See Also:

Constant Field Values

TOP_FRAME

public static final int TOP_FRAME

A frame that resides as a separate window

See Also:

Constant Field Values

DESKTOP_FRAME

public static final int DESKTOP_FRAME

The frame resides docked left, right, top, or bottom

See Also:

Constant Field Values

PERSIST_ONLY_OPENED

public static final int PERSIST_ONLY_OPENED

persist a TopComponent only if it is opened

See Also:

Constant Field Values

PERSIST_NEVER

public static final int PERSIST_NEVER

dont persist the TopComponent

See Also:

Constant Field Values

PERSIST_ALWAYS

public static final int PERSIST_ALWAYS

always persist the TopComponent

See Also:

Constant Field Values

PERSIST_UNKNOWN

public static final int PERSIST_UNKNOWN

unkown persistence mode the TopComponent

See Also:

Constant Field Values

Method Detail

setFrameType

public static void setFrameType(int frameType)

Utility method: Sets the default windowing behavior, MDI or SDI. If set to true the default behavior for new windows is to reside in the desktop.

Parameters:

type - indicates that the default windowing behavior, should be one of INTERNAL_FRAME, TOP_FRAME, or DESKTOP_FRAME

openInMode

public static Mode openInMode(TopComponent component,
                              java.lang.String modeName)

Utility method: opens a topcomponent in the current workspace in a mode with the indicated name. This method first looks if the mode already exists, or else creates it. Opens the topcomponent in the desktop.

Parameters:

component - the component to open

modeName - the (code) name of the mode

Returns:

the mode the topcomponent was opened in.

openInMode

public static Mode openInMode(Workspace workspace,
                              TopComponent component,
                              java.lang.String modeName)

Utility method: opens a topcomponent in the given workspace in a mode with the indicated name. This method first looks if the mode already exists, or else creates it. Opens the topcomponent in the desktop.

Parameters:

workspace - the workspace top open the component in

component - the component to open

modeName - the (code) name of the mode

Returns:

the mode the topcomponent was opened in.

openInMode

public static Mode openInMode(TopComponent component,
                              java.lang.String modeName,
                              int frameType)

Utility method: opens a topcomponent in the current workspace in a mode with the indicated name. This method first looks if the mode already exists, or else creates it

Parameters:

component - the component to open

modeName - the (code) name of the mode

frameType - indicates the type of the window frame, should be one of INTERNAL_FRAME, TOP_FRAME, or DESKTOP_FRAME

Returns:

the mode the topcomponent was opened in.

openInMode

public static Mode openInMode(Workspace workspace,
                              TopComponent component,
                              java.lang.String modeName,
                              int frameType)

Utility method: opens a topcomponent in the given workspace in a mode with the indicated name. This method first looks if the mode already exists, or else creates it.

Parameters:

workspace - the workspace top open the component in

component - the component to open

modeName - the (code) name of the mode

frameType - indicates the type of the window frame, should be one of INTERNAL_FRAME, TOP_FRAME, or DESKTOP_FRAME

Returns:

the mode the topcomponent was opened in.

setPersistMode

public static void setPersistMode(TopComponent comp,
                                  int option)

Determine under which conditions the TopComponent is persisted to the NetBeans system directory

Parameters:

comp - the component

option - one of PERSIST_NEVER or PERSIST_ONLY_OPENED

getPersistMode

public static int getPersistMode(TopComponent comp)

Get the persistence mode of the given TopComponent

Parameters:

comp - the component

Returns:

one of PERSIST_NEVER or PERSIST_ONLY_OPENED

frameResidesInDesktop

public static void frameResidesInDesktop(Mode mode)

Utility method: makes the given mode reside in the desktop instead of as a separate window.

Parameters:

mode - the mode to make reside in the desktop

frameResidesInDesktop

public static void frameResidesInDesktop(Mode mode,
                                         int frameType)

Utility method: makes the given mode either reside in the desktop or display a separate window.

Parameters:

mode - the mode to make reside in the desktop

frameType - indicates the type of frame, MDI or SDI

findTopComponent

public static TopComponent findTopComponent(java.lang.String componentName)

Utility method: Returns the TopComponent with the given programmatic name in the current workspace, or null if there is no such TopComponent.

Parameters:

componentName - the programmatic name of the TopComponent

Returns:

Returns the TopComponent with the given programmatic name, or null if there is no such TopComponent

findTopComponent

public static TopComponent findTopComponent(Workspace workspace,
                                            java.lang.String componentName)

Utility method: Returns the TopComponent with the given programmatic name in the given workspace, or null if there is no such TopComponent.

Parameters:

workspace - the workspace in which to look for the TopComponent

componentName - the programmatic name of the TopComponent

Returns:

Returns the TopComponent with the given programmatic name, or null if there is no such TopComponent

createWorkspace

public static Workspace createWorkspace(java.lang.String codeName,
                                        java.lang.String displayName)

Utility method: creates a workspace and adds it to the WindowManager's list of workspaces. The new workspace will appear as the last one in the list.

Parameters:

codeName - the code name of the new workspace

displayName - the display name of the new workspace