WindowManager (Window System API)

java.lang.Object
- org.openide.windows.WindowManager

All Implemented Interfaces:

Serializable
```
public abstract class WindowManager
extends Object
implements Serializable
```
Manages window system. Allows the work with window system components, i.e. Modes, TopComponentGroups and provides handling of operations provided over TopComponents.
Important note: Do not provide implementation of this abstract class unless you are window system provider!

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`protected static interface`	`WindowManager.Component` Deprecated. Do not use anymore. This interface is replaced by bunch of protected methods which name starts with topComponent prefix, i.e. `WindowManager.topComponentOpen(org.openide.windows.TopComponent)`, `WindowManager.topComponentClose(org.openide.windows.TopComponent)` etc.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`PROP_CURRENT_WORKSPACE` Deprecated. Do not use. Workspaces are not supported anymore.
`static String`	`PROP_MODES` Name of property for modes in the workspace.
`static String`	`PROP_WORKSPACES` Deprecated. Do not use. Workspaces are not supported anymore.

Constructor Summary

Constructors
Constructor and Description

WindowManager()

Constructors
Constructor and Description
`WindowManager()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`protected void`	`activateComponent(TopComponent tc)` Activate a component.
`abstract void`	`addPropertyChangeListener(PropertyChangeListener l)` Attaches a listener for changes in workspaces.
`void`	`addWindowSystemListener(WindowSystemListener listener)` Register window system listener to receive notifications when the window system loads or saves.
`protected void`	`componentCloseNotify(TopComponent tc)` Notifies component that it was closed (and is not opened on any workspace anymore).
`protected void`	`componentHidden(TopComponent tc)` Notifies `TopComponent` it was hidden.
`protected void`	`componentOpenNotify(TopComponent tc)` Notifies component that it was opened (and wasn't opened on any workspace before).
`protected TopComponent.Registry`	`componentRegistry()` Access method for registry of all components in the system.
`protected void`	`componentShowing(TopComponent tc)` Notifies `TopComponent` it is about to be shown.
`Mode`	`createModeFromXml(String xml)` Given some XML, attempts to create a Mode that can subsequently be used to dock a TopComponent into.
`protected abstract WindowManager.Component`	`createTopComponentManager(TopComponent c)` Create a component manager for the given top component.
`Workspace`	`createWorkspace(String name)` Deprecated. Do not use. Workspaces are not supported anymore.
`abstract Workspace`	`createWorkspace(String name, String displayName)` Deprecated. Do not use. Workspaces are not supported anymore.
`protected static WindowManager.Component`	`findComponentManager(TopComponent tc)` Deprecated. Do not use anymore. See `WindowManager.Component` deprecation.
`abstract Mode`	`findMode(String name)` Finds mode of specified name.
`abstract Mode`	`findMode(TopComponent tc)` Finds mode which contains specified `TopComponent`.
`abstract TopComponent`	`findTopComponent(String tcID)` Returns `TopComponent` for given unique ID.
`abstract TopComponentGroup`	`findTopComponentGroup(String name)` Finds `TopComponentGroup` of given name.
`String`	`findTopComponentID(TopComponent tc)` Returns unique ID for specified `TopComponent`.
`abstract Workspace`	`findWorkspace(String name)` Deprecated. Do not use. Workspaces are not supported anymore.
`abstract Workspace`	`getCurrentWorkspace()` Deprecated. Do not use. Workspaces are not supported anymore.
`static WindowManager`	`getDefault()` Singleton instance accessor method for window manager.
`abstract Frame`	`getMainWindow()` Gets the NetBeans Main Window.
`abstract Set<? extends Mode>`	`getModes()` Gets set of all `Mode`S added into window system.
`TopComponent[]`	`getOpenedTopComponents(Mode mode)` Convenience method to retrieve the list of all opened TopComponents for given mode.
`TopComponent.Registry`	`getRegistry()` Getter for component registry.
`String`	`getRole()`
`abstract Workspace[]`	`getWorkspaces()` Deprecated. Do not use. Workspaces are not supported anymore.
`void`	`invokeWhenUIReady(Runnable run)` Provides support for executing a piece of code when UI of the window system is ready.
`boolean`	`isEditorMode(Mode mode)` Check whether the given Mode holds editor windows.
`boolean`	`isEditorTopComponent(TopComponent tc)` Check whether the given TopComponent will be/is docked into an 'editor' Mode.
`boolean`	`isOpenedEditorTopComponent(TopComponent tc)` Check whether the given TopComponent is opened and docked into an 'editor' Mode.
`boolean`	`isTopComponentFloating(TopComponent tc)` Checks the floating status of given TopComponent.
`boolean`	`isTopComponentMinimized(TopComponent tc)` Checks the minimized status of given TopComponent.
`boolean`	`removeMode(Mode mode)` Before restoring a whole bunch of Modes (for example with XML that has been previously saved somewhere and now loaded), it is useful to remove the anonymous modes from the system.
`abstract void`	`removePropertyChangeListener(PropertyChangeListener l)` Removes a listener for changes in workspaces.
`void`	`removeWindowSystemListener(WindowSystemListener listener)` Remove window system listener.
`void`	`setRole(String roleName)` Switches the window system to a new role (perspective).
`void`	`setTopComponentFloating(TopComponent tc, boolean floating)` Floats the given TopComponent or docks it back to the main window.
`void`	`setTopComponentMinimized(TopComponent tc, boolean minimize)` Minimizes the given TopComponent.
`abstract void`	`setWorkspaces(Workspace[] workspaces)` Deprecated. Do not use. Workspaces are not supported anymore.
`protected abstract void`	`topComponentActivatedNodesChanged(TopComponent tc, Node[] activatedNodes)` Informs about change of activated nodes of specified `TopComponent`.
`protected void`	`topComponentAttentionHighlight(TopComponent tc, boolean highlight)` Highlights the tab of the given TopComponent until user activates it.
`protected void`	`topComponentCancelRequestAttention(TopComponent tc)` Stop this TopComponent's tab from flashing if it is flashing.
`protected abstract void`	`topComponentClose(TopComponent tc)` Provides closing of specified `TopComponent`.
`protected abstract Action[]`	`topComponentDefaultActions(TopComponent tc)` Gets default list of actions which appear in popup menu of TopComponent.
`protected abstract void`	`topComponentDisplayNameChanged(TopComponent tc, String displayName)` Informs about change of display name of specified `TopComponent`.
`protected int`	`topComponentGetTabPosition(TopComponent tc)` Gives position index of given TopComponent in the mode.
`protected abstract void`	`topComponentHtmlDisplayNameChanged(TopComponent tc, String htmlDisplayName)` Informs about change of html display name of specified `TopComponent`.
`protected abstract void`	`topComponentIconChanged(TopComponent tc, Image icon)` Informs about chagne of icon of specified `TopComponent`.
`protected abstract String`	`topComponentID(TopComponent tc, String preferredID)` Returns unique ID for specified `TopComponent`.
`protected abstract boolean`	`topComponentIsOpened(TopComponent tc)` Indicates whether specified `TopComponent` is opened.
`protected void`	`topComponentMakeBusy(TopComponent tc, boolean busy)` Notifies the user that some process is running in the given TopComponent, for example by drawing an animated "wait" icon in TopComponent's header. The default implementation does nothing.
`protected abstract void`	`topComponentOpen(TopComponent tc)` Provides opening of specified `TopComponent`.
`protected void`	`topComponentOpenAtTabPosition(TopComponent tc, int position)` Opens given TopComponent at given position in the mode.
`protected abstract void`	`topComponentRequestActive(TopComponent tc)` Provides activation of specified `TopComponent`.
`protected void`	`topComponentRequestAttention(TopComponent tc)` Cause this TopComponent's tab to flash or otherwise draw the users' attention to it.
`protected abstract void`	`topComponentRequestVisible(TopComponent tc)` Provides selection of specfied `TopComponent`.
`protected void`	`topComponentToFront(TopComponent tc)` Attempts to bring the parent `Window` of the given `TopComponent` to front of other windows.
`protected abstract void`	`topComponentToolTipChanged(TopComponent tc, String toolTip)` Informs about change of tooltip of specified `TopComponent`.
`boolean`	`updateModeConstraintsFromXml(String xml)` Before restoring anonymous Modes, it is useful to update whatever defined Modes may exist like editor, explorer etc., so that all the Modes will eventually re-appear in the desired locations.
`abstract void`	`updateUI()` Called after a Look&Feel change to update the NetBeans UI.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - PROP_WORKSPACES
```
@Deprecated
public static final String PROP_WORKSPACES
```
    Deprecated. Do not use. Workspaces are not supported anymore.
    
    property change of workspaces.
    
    See Also:
    
    Constant Field Values
  - PROP_CURRENT_WORKSPACE
```
@Deprecated
public static final String PROP_CURRENT_WORKSPACE
```
    Deprecated. Do not use. Workspaces are not supported anymore.
    
    property change of current workspace.
    
    See Also:
    
    Constant Field Values
  - PROP_MODES
```
public static final String PROP_MODES
```
    Name of property for modes in the workspace.
    
    Since:
    
    4.13
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - WindowManager
```
public WindowManager()
```
- Method Detail
  - getDefault
```
public static final WindowManager getDefault()
```
    Singleton instance accessor method for window manager. Provides entry point for further work with window system API of the system.
    
    Returns:
    
    instance of window manager installed in the system
    
    Since:
    
    2.10
  - findMode
```
public abstract Mode findMode(String name)
```
    Finds mode of specified name.
    
    Returns:
    
    Mode whith the specified name is or null if there does not exist such Mode inside window system.
    
    Since:
    
    4.13
  - findMode
```
public abstract Mode findMode(TopComponent tc)
```
    Finds mode which contains specified TopComponent.
    
    Returns:
    
    Mode which contains specified TopComponent or null if the TopComponent is not added into any Mode inside window system.
    
    Since:
    
    4.13
  - getModes
```
public abstract Set<? extends Mode> getModes()
```
    Gets set of all ModeS added into window system.
    
    Since:
    
    4.13
  - getMainWindow
```
public abstract Frame getMainWindow()
```
    Gets the NetBeans Main Window. This should ONLY be used for:
    - using the Main Window as the parent for dialogs
    - using the Main Window's position for preplacement of windows
    Since version 6.36 the default implementation in org.netbeans.core.windows module first checks already opened Frames (see Frame.getFrames()) and if there is a Frame named 'NbMainWindow' then it is reused as NetBeans main window. Otherwise a new Frame is created instead.
    Returns:
    
    the Main Window
  - updateUI
```
public abstract void updateUI()
```
    Called after a Look&Feel change to update the NetBeans UI. Should call JComponent.updateUI() on all opened windows.
  - createTopComponentManager
```
protected abstract WindowManager.Component createTopComponentManager(TopComponent c)
```
    Create a component manager for the given top component.
    
    Parameters:
    
    c - the component
    
    Returns:
    
    the manager to handle opening, closing and selecting the component
  - componentRegistry
```
protected TopComponent.Registry componentRegistry()
```
    Access method for registry of all components in the system.
    
    Returns:
    
    the registry
  - getRegistry
```
public TopComponent.Registry getRegistry()
```
    Getter for component registry.
    
    Returns:
    
    the registry
  - createWorkspace
```
@Deprecated
public final Workspace createWorkspace(String name)
```
    Deprecated. Do not use. Workspaces are not supported anymore.
    
    Creates new workspace.
    
    Parameters:
    
    name - the name of the workspace
    
    Returns:
    
    new workspace
  - createWorkspace
```
@Deprecated
public abstract Workspace createWorkspace(String name,
                                                      String displayName)
```
    Deprecated. Do not use. Workspaces are not supported anymore.
    
    Creates new workspace with I18N support. Note that it will not be displayed until WindowManager.setWorkspaces(org.openide.windows.Workspace[]) is called with an array containing the new workspace.
    
    Parameters:
    
    name - the code name (used for internal purposes)
    
    displayName - the display name
    
    Returns:
    
    the new workspace
  - findWorkspace
```
@Deprecated
public abstract Workspace findWorkspace(String name)
```
    Deprecated. Do not use. Workspaces are not supported anymore.
    
    Finds workspace given its name.
    
    Parameters:
    
    name - the (code) name of workspace to find
    
    Returns:
    
    workspace or null if not found
  - getWorkspaces
```
@Deprecated
public abstract Workspace[] getWorkspaces()
```
    Deprecated. Do not use. Workspaces are not supported anymore.
    
    Gets a list of all workspaces.
    
    Returns:
    
    an array of all known workspaces
  - setWorkspaces
```
@Deprecated
public abstract void setWorkspaces(Workspace[] workspaces)
```
    Deprecated. Do not use. Workspaces are not supported anymore.
    
    Sets new array of workspaces. In conjunction with WindowManager.getWorkspaces(), this may be used to reorder workspaces, or add or remove workspaces.
    
    Parameters:
    
    workspaces - An array consisting of new workspaces.
  - getCurrentWorkspace
```
@Deprecated
public abstract Workspace getCurrentWorkspace()
```
    Deprecated. Do not use. Workspaces are not supported anymore.
    
    Gets the current workspace.
    
    Returns:
    
    the currently active workspace
    
    See Also:
    
    Workspace.activate()
  - findTopComponentGroup
```
public abstract TopComponentGroup findTopComponentGroup(String name)
```
    Finds TopComponentGroup of given name.
    
    Returns:
    
    instance of TopComponetnGroup or null
    
    Since:
    
    4.13
  - addPropertyChangeListener
```
public abstract void addPropertyChangeListener(PropertyChangeListener l)
```
    Attaches a listener for changes in workspaces.
    
    Parameters:
    
    l - the new listener
  - removePropertyChangeListener
```
public abstract void removePropertyChangeListener(PropertyChangeListener l)
```
    Removes a listener for changes in workspaces.
    
    Parameters:
    
    l - the listener to remove
  - findComponentManager
```
@Deprecated
protected static final WindowManager.Component findComponentManager(TopComponent tc)
```
    Deprecated. Do not use anymore. See WindowManager.Component deprecation.
    
    Finds top component manager for given top component.
    
    Parameters:
    
    tc - top component to find manager for.
    
    Returns:
    
    component manager for given top component.
  - activateComponent
```
protected void activateComponent(TopComponent tc)
```
    Activate a component. The top component containers should inform the top component that it is active via a call to this method through derived window manager implementation.
    
    Parameters:
    
    tc - the top component to activate; or null to deactivate all top components
  - componentOpenNotify
```
protected void componentOpenNotify(TopComponent tc)
```
    Notifies component that it was opened (and wasn't opened on any workspace before). Top component manager that implements Component inner interface of this class should send open notifications via calling this method
    
    Parameters:
    
    tc - the top component to be notified
  - componentCloseNotify
```
protected void componentCloseNotify(TopComponent tc)
```
    Notifies component that it was closed (and is not opened on any workspace anymore). Top component manager that implements Component inner interface of this class should send close notifications via calling this method
    
    Parameters:
    
    tc - the top component to be notified
  - componentShowing
```
protected void componentShowing(TopComponent tc)
```
    Notifies TopComponent it is about to be shown.
    
    Parameters:
    
    tc - TopComponent to be notified
    
    Since:
    
    2.18
    
    See Also:
    
    TopComponent.componentShowing()
  - componentHidden
```
protected void componentHidden(TopComponent tc)
```
    Notifies TopComponent it was hidden.
    
    Parameters:
    
    tc - TopComponent to be notified
    
    Since:
    
    2.18
    
    See Also:
    
    TopComponent.componentHidden()
  - topComponentOpen
```
protected abstract void topComponentOpen(TopComponent tc)
```
    Provides opening of specified TopComponent.
    
    Parameters:
    
    tc - TopComponent to open
    
    Since:
    
    4.13
  - topComponentOpenAtTabPosition
```
protected void topComponentOpenAtTabPosition(TopComponent tc,
                                             int position)
```
    Opens given TopComponent at given position in the mode. TopComponent is inserted at given position, positions of already opened TopComponents in the same mode are incremented.
    - Does no operation if TopComponent is already opened.
    - For position value less then 0, TopComponent is opened at position 0, the very first one.
    - For position value greater then count of opened TopComponents in the mode, TopComponent is opened at last position
    Parameters:
    
    tc - TopComponent which is opened.
    
    position - Index of the requested position.
    
    Since:
    
    6.15
  - topComponentGetTabPosition
```
protected int topComponentGetTabPosition(TopComponent tc)
```
    Gives position index of given TopComponent in the mode. Result is undefined for closed TopComponents.
    
    Parameters:
    
    tc - TopComponent for which position is returned.
    
    Returns:
    
    Index of position.
    
    Since:
    
    6.15
  - topComponentClose
```
protected abstract void topComponentClose(TopComponent tc)
```
    Provides closing of specified TopComponent.
    
    Parameters:
    
    tc - TopComponent to close
    
    Since:
    
    4.13
  - topComponentRequestActive
```
protected abstract void topComponentRequestActive(TopComponent tc)
```
    Provides activation of specified TopComponent.
    
    Parameters:
    
    tc - TopComponent to activate
    
    Since:
    
    4.13
  - topComponentRequestVisible
```
protected abstract void topComponentRequestVisible(TopComponent tc)
```
    Provides selection of specfied TopComponent.
    
    Parameters:
    
    tc - TopComponent to set visible (select)
    
    Since:
    
    4.13
  - topComponentDisplayNameChanged
```
protected abstract void topComponentDisplayNameChanged(TopComponent tc,
                                                       String displayName)
```
    Informs about change of display name of specified TopComponent.
    
    Parameters:
    
    tc - TopComponent which display name has changed
    
    displayName - newly changed display name value
    
    Since:
    
    4.13
  - topComponentHtmlDisplayNameChanged
```
protected abstract void topComponentHtmlDisplayNameChanged(TopComponent tc,
                                                           String htmlDisplayName)
```
    Informs about change of html display name of specified TopComponent.
    
    Parameters:
    
    tc - TopComponent which display name has changed
    
    htmlDisplayName - newly changed html display name value
    
    Since:
    
    6.4
  - topComponentToolTipChanged
```
protected abstract void topComponentToolTipChanged(TopComponent tc,
                                                   String toolTip)
```
    Informs about change of tooltip of specified TopComponent.
    
    Parameters:
    
    tc - TopComponent which tooltip has changed
    
    toolTip - newly changed tooltip value
    
    Since:
    
    4.13
  - topComponentIconChanged
```
protected abstract void topComponentIconChanged(TopComponent tc,
                                                Image icon)
```
    Informs about chagne of icon of specified TopComponent.
    
    Parameters:
    
    tc - TopComponent which icon has changed
    
    icon - newly chaned icon value
    
    Since:
    
    4.13
  - topComponentActivatedNodesChanged
```
protected abstract void topComponentActivatedNodesChanged(TopComponent tc,
                                                          Node[] activatedNodes)
```
    Informs about change of activated nodes of specified TopComponent.
    
    Parameters:
    
    tc - TopComponent which activated nodes has chagned
    
    activatedNodes - newly chaged activated nodes value
    
    Since:
    
    4.13
  - topComponentIsOpened
```
protected abstract boolean topComponentIsOpened(TopComponent tc)
```
    Indicates whether specified TopComponent is opened.
    
    Parameters:
    
    tc - specified TopComponent
    
    Since:
    
    4.13
  - topComponentDefaultActions
```
protected abstract Action[] topComponentDefaultActions(TopComponent tc)
```
    Gets default list of actions which appear in popup menu of TopComponent. The popup menu which is handled by window systsm implementation, typically at tab.
    
    Parameters:
    
    tc - TopComponent for which the default actions to provide
    
    Since:
    
    4.13
  - topComponentID
```
protected abstract String topComponentID(TopComponent tc,
                                         String preferredID)
```
    Returns unique ID for specified TopComponent.
    
    Parameters:
    
    tc - TopComponent the component for which is ID returned
    
    preferredID - first approximation used for ID
    
    Returns:
    
    unique TopComponent ID
    
    Since:
    
    4.13
  - topComponentRequestAttention
```
protected void topComponentRequestAttention(TopComponent tc)
```
    Cause this TopComponent's tab to flash or otherwise draw the users' attention to it. Note to WindowManager providers: This method not abstract for backward compatibility reasons, please override and provide implementation.
    
    Parameters:
    
    tc - A TopComponent
    
    Since:
    
    5.1
  - topComponentMakeBusy
```
protected void topComponentMakeBusy(TopComponent tc,
                                    boolean busy)
```
    Notifies the user that some process is running in the given TopComponent, for example by drawing an animated "wait" icon in TopComponent's header.
    The default implementation does nothing.
    
    Parameters:
    
    tc -
    
    busy - True to start 'busy' notification, false to stop it.
    
    Since:
    
    6.51
  - topComponentToFront
```
protected void topComponentToFront(TopComponent tc)
```
    Attempts to bring the parent Window of the given TopComponent to front of other windows.
    
    Since:
    
    5.8
    
    See Also:
    
    Window.toFront()
  - topComponentCancelRequestAttention
```
protected void topComponentCancelRequestAttention(TopComponent tc)
```
    Stop this TopComponent's tab from flashing if it is flashing. Note to WindowManager providers: This method not abstract for backward compatibility reasons, please override and provide implementation.
    
    Parameters:
    
    tc - A TopComponent
    
    Since:
    
    5.1
  - topComponentAttentionHighlight
```
protected void topComponentAttentionHighlight(TopComponent tc,
                                              boolean highlight)
```
    Highlights the tab of the given TopComponent until user activates it.
    
    Parameters:
    
    tc -
    
    highlight - True to highlight the tab, false to switch the highlight off.
    
    Since:
    
    6.58
  - findTopComponentID
```
public String findTopComponentID(TopComponent tc)
```
    Returns unique ID for specified TopComponent.
    
    Parameters:
    
    tc - TopComponent the component for which is ID returned
    
    Returns:
    
    unique TopComponent ID
    
    Since:
    
    4.13
  - findTopComponent
```
public abstract TopComponent findTopComponent(String tcID)
```
    Returns TopComponent for given unique ID.
    
    Parameters:
    
    tcID - unique TopComponent ID
    
    Returns:
    
    TopComponent instance corresponding to unique ID
    
    Since:
    
    4.15
  - invokeWhenUIReady
```
public void invokeWhenUIReady(Runnable run)
```
    Provides support for executing a piece of code when UI of the window system is ready. The behaviour is similar to EventQueue.invokeLater(java.lang.Runnable) moreover it is guaranteed that only one Runnable runs at given time. This method can be invoked from any thread.
    The typical usecase is to call this method during startup of NetBeans based application. The default manager then waits till the main window is opened and then executes all the registered methods one by one.
    Usage:
```
  // some initialization method
  public static void init () {
     WindowManager.getDefault().invokeWhenUIReady(new Runnable() {
        public void run() {
           // code to be invoked when system UI is ready
        }
     );
  }
 
```
    Note to WindowManager providers: This method is not abstract for backward compatibility reasons, please override and provide implementation.
    Parameters:
    
    run - the runnable that executes piece of code when UI of the system is ready
    
    Since:
    
    6.8
  - isEditorTopComponent
```
public boolean isEditorTopComponent(TopComponent tc)
```
    Check whether the given TopComponent will be/is docked into an 'editor' Mode.
    
    Please note that some TopComponents may be docked into 'editor' modes as well as 'view' modes, see method isTopComponentAllowedToMoveAnywhere().
    
    Parameters:
    
    tc - TopComponent to check.
    
    Returns:
    
    True if there is a Mode that the TopComponent will be/is docked to and the Mode is of 'editor' kind (i.e. holds editor windows).
    
    Since:
    
    6.13
  - isOpenedEditorTopComponent
```
public boolean isOpenedEditorTopComponent(TopComponent tc)
```
    Check whether the given TopComponent is opened and docked into an 'editor' Mode. It is safe to call this method outside the event dispatch thread.
    
    Please note that some TopComponents may be docked into 'editor' modes as well as 'view' modes, see method isTopComponentAllowedToMoveAnywhere().
    
    Parameters:
    
    tc - TopComponent to check.
    
    Returns:
    
    True if the TopComponent is opened and the Mode it is docked is of 'editor' kind (i.e. holds editor windows).
    
    Since:
    
    6.16
  - getOpenedTopComponents
```
public TopComponent[] getOpenedTopComponents(Mode mode)
```
    Convenience method to retrieve the list of all opened TopComponents for given mode.
    
    Parameters:
    
    mode - Mode to get the list of TopComponents from.
    
    Returns:
    
    Array of TopComponents that are opened in given mode.
    
    Since:
    
    6.28
  - isEditorMode
```
public boolean isEditorMode(Mode mode)
```
    Check whether the given Mode holds editor windows.
    
    Please note that some TopComponents may be docked into 'editor' modes as well as 'view' modes, see method isTopComponentAllowedToMoveAnywhere().
    
    Parameters:
    
    mode - Mode to check.
    
    Returns:
    
    True the Mode contains editor windows.
    
    Since:
    
    6.13
  - addWindowSystemListener
```
public void addWindowSystemListener(WindowSystemListener listener)
```
    Register window system listener to receive notifications when the window system loads or saves.
    
    Since:
    
    6.43
  - removeWindowSystemListener
```
public void removeWindowSystemListener(WindowSystemListener listener)
```
    Remove window system listener.
    
    Since:
    
    6.43
  - setRole
```
public void setRole(String roleName)
```
    Switches the window system to a new role (perspective).
    
    A role may customize the default window layout by adding/removing TopComponents, changing window positions and/or sizes etc. Roles are defined in XML layers in folder Window2/Roles. Each role has a unique name corresponding to a sub-folder in Window2/Roles. The content of a role sub-folder has the same syntax and meaning as the default window layout in Windows2 folder. The content of role sub-folder is merged with the defaults in Windows2 folder when the window system loads. User's changes to the window layout are persisted per role. So user's customizations in role A are not propagated to role B and vice versa.
    
    The default implementation of this method in core.windows module does the following:
    1. Hide the main window.
    2. Save the current window layout of the current role.
    3. Load new window layout from the given role.
    4. Show the main window.
    The whole operation may take a few seconds to complete.
    
    Windows that were opened in previous role but are not opened or present in the new role will receive TopComponent.componentClosed() notification.
    
    Note: To keep the main window showing while switching the role, use the following branding: org.netbeans.core.windows.WinSys.Show.Hide.MainWindow.While.Switching.Role=false
    
    Note: Action org.netbeans.core.windows.actions.SwitchRoleKeepDocumentsAction in Actions/Window layer folder can change the role too but it also attempts to keep documents from previous role opened in the new role as well. The new role name is ActionEvent.getActionCommand() argument.
    
    If the window system has been already loaded then the method must be called from EDT thread, otherwise it's safe to set the initial startup role in e.g. ModuleInstall.restored() method.
    Parameters:
    
    roleName - Name of the new role to switch to or null to switch to the default window layout.
    
    Since:
    
    6.43
    
    See Also:
    
    WindowManager.getRole()
  - isTopComponentMinimized
```
public boolean isTopComponentMinimized(TopComponent tc)
```
    Checks the minimized status of given TopComponent.
    
    Parameters:
    
    tc -
    
    Returns:
    
    True if the given TopComponent is minimized (slided-out), false otherwise.
    
    Since:
    
    6.57
  - setTopComponentMinimized
```
public void setTopComponentMinimized(TopComponent tc,
                                     boolean minimize)
```
    Minimizes the given TopComponent.
    
    Parameters:
    
    tc -
    
    minimize - True to minimize (slide-out) given TopComponent, false to pin it back to the main window.
    
    Since:
    
    6.57
  - isTopComponentFloating
```
public boolean isTopComponentFloating(TopComponent tc)
```
    Checks the floating status of given TopComponent.
    
    Returns:
    
    True if the given TopComponent is separated from the main window.
    
    Since:
    
    6.57
  - setTopComponentFloating
```
public void setTopComponentFloating(TopComponent tc,
                                    boolean floating)
```
    Floats the given TopComponent or docks it back to the main window.
    
    Parameters:
    
    tc -
    
    floating - True to separate the given TopComponent from the main window, false to dock it back to the main window.
    
    Since:
    
    6.57
  - getRole
```
public String getRole()
```
    Returns:
    
    The name of the current role or null if the default window system layout is being used.
    
    Since:
    
    6.43
    
    See Also:
    
    WindowManager.setRole(java.lang.String)
  - createModeFromXml
```
public Mode createModeFromXml(String xml)
```
    Given some XML, attempts to create a Mode that can subsequently be used to dock a TopComponent into. Usually this will be an anonymous Mode.
    
    Parameters:
    
    xml - ModeConfig XML that was originally produced by ModeUtilities.toXml(org.openide.windows.Mode)
    
    Returns:
    
    an instance of Mode or null if the attempt to create the Mode failed
    
    See Also:
    
    ModeUtilities
  - removeMode
```
public boolean removeMode(Mode mode)
```
    Before restoring a whole bunch of Modes (for example with XML that has been previously saved somewhere and now loaded), it is useful to remove the anonymous modes from the system.
    
    Parameters:
    
    mode - the Mode to be removed
    
    Returns:
    
    success or failure of the attempt to remove the Mode
  - updateModeConstraintsFromXml
```
public boolean updateModeConstraintsFromXml(String xml)
```
    Before restoring anonymous Modes, it is useful to update whatever defined Modes may exist like editor, explorer etc., so that all the Modes will eventually re-appear in the desired locations.
    
    Parameters:
    
    xml - ModeConfig XML that was originally produced by ModeUtilities.toXml(org.openide.windows.Mode)
    
    Returns:
    
    success or failure of the attempt to find the Mode and update it
    
    See Also:
    
    ModeUtilities

Class WindowManager

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PROP_WORKSPACES

PROP_CURRENT_WORKSPACE

PROP_MODES

Constructor Detail

WindowManager

Method Detail

getDefault

findMode

findMode

getModes

getMainWindow

updateUI

createTopComponentManager

componentRegistry

getRegistry

createWorkspace

createWorkspace

findWorkspace

getWorkspaces

setWorkspaces

getCurrentWorkspace

findTopComponentGroup

addPropertyChangeListener

removePropertyChangeListener

findComponentManager

activateComponent

componentOpenNotify

componentCloseNotify

componentShowing

componentHidden

topComponentOpen

topComponentOpenAtTabPosition

topComponentGetTabPosition

topComponentClose

topComponentRequestActive

topComponentRequestVisible

topComponentDisplayNameChanged

topComponentHtmlDisplayNameChanged

topComponentToolTipChanged

topComponentIconChanged

topComponentActivatedNodesChanged

topComponentIsOpened

topComponentDefaultActions

topComponentID

topComponentRequestAttention

topComponentMakeBusy

topComponentToFront

topComponentCancelRequestAttention

topComponentAttentionHighlight

findTopComponentID

findTopComponent

invokeWhenUIReady

isEditorTopComponent

isOpenedEditorTopComponent

getOpenedTopComponents

isEditorMode

addWindowSystemListener

removeWindowSystemListener

setRole

isTopComponentMinimized

setTopComponentMinimized

isTopComponentFloating

setTopComponentFloating

getRole

createModeFromXml

removeMode

updateModeConstraintsFromXml