oracle.ide.docking
Class DockUtil

java.lang.Object
  oracle.ide.docking.DockUtil

public final class DockUtil
extends java.lang.Object

Constructor Summary

DockUtil()

Method Summary

static void	hideDockableWindow(DockableView dw) Hides the DockableView and set the focus on the active Editor
static boolean	isMinimizedByDefault(Dockable dockable, Layout layout) Indicates whether the given dockable is minimized by default in the given layout.
static boolean	isRaisedByDefault(Dockable dockable, Layout layout) Indicates whether the given dockable is raised by default in the given layout.
static boolean	isShowingByDefault(Dockable dockable, Layout layout) Indicates whether the given dockable is showing by default in the given layout.
static void	showDockableWindow(DockableView dw) Shows and set the focus on the DockableView
static void	smartToggleDockableWindow(DockableView dw, Context context) 'Smart' Toggles the visibility of the DockableView.
static void	toggleDockableWindow(DockableView dw) Toggles the visibility of the DockableView

Methods inherited from class java.lang.Object

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

Constructor Detail

DockUtil

public DockUtil()

Method Detail

showDockableWindow

public static void showDockableWindow(DockableView dw)

Shows and set the focus on the DockableView

Parameters:

dw - the DockableView

hideDockableWindow

public static void hideDockableWindow(DockableView dw)

Hides the DockableView and set the focus on the active Editor

Parameters:

dw - the DockableView

toggleDockableWindow

public static void toggleDockableWindow(DockableView dw)

Toggles the visibility of the DockableView

Parameters:

dw - the DockableView

smartToggleDockableWindow

public static void smartToggleDockableWindow(DockableView dw,
                                             Context context)

'Smart' Toggles the visibility of the DockableView. The 'smart' behavior is the following:
If the action was issued from the menu or if the window is hidden, it behaves just like toggleDockableWindow(oracle.ide.docking.DockableView).
If the window is visible but does not have the focus, it puts the focus on the window.
If the window is visible and has the focus, the window is closed.

This behavior allows to use the same shortcut to access, to show and to hide the window.

Parameters:

dw - the DockableView

isShowingByDefault

public static boolean isShowingByDefault(Dockable dockable,
                                         Layout layout)

Indicates whether the given dockable is showing by default in the given layout.

Parameters:

dockable - the dockable to check.

layout - the layout.

Returns:

true if the dockable is showing by default in the layout, false otherwise.

isMinimizedByDefault

public static boolean isMinimizedByDefault(Dockable dockable,
                                           Layout layout)

Indicates whether the given dockable is minimized by default in the given layout.

Parameters:

dockable - the dockable to check.

layout - the layout.

Returns:

true if the dockable is minimized by default in the layout, false otherwise.

isRaisedByDefault

public static boolean isRaisedByDefault(Dockable dockable,
                                        Layout layout)

Indicates whether the given dockable is raised by default in the given layout.

Parameters:

dockable - the dockable to check.

layout - the layout.

Returns:

true if the dockable is raised by default in the layout, false otherwise.