Package org.jdesktop.swingx.util

Class WindowUtils

java.lang.Object

org.jdesktop.swingx.util.WindowUtils

public final class WindowUtils
extends Object

Encapsulates various utilities for windows (ie: Frame and Dialog objects and descendants, in particular).

Author:

Richard Bair

Method Summary

Modifier and Type	Method	Description
static Window	findWindow(Component c)
static List<Component>	getAllComponents(Container c)
static Point	getPointForCentering(Window window)	Returns the Point at which a window should be placed to center that window on the screen.
static Point	getPointForCentering(JInternalFrame window)	Returns the Point at which a window should be placed to center that window on the given desktop.
static Point	getPointForStaggering(Window originWindow)	Returns the Point at which a window should be placed in order to be staggered slightly from another "origin" window to ensure that the title areas of both windows remain visible to the user.

Methods inherited from class java.lang.Object

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

Method Details

getPointForCentering

public static Point getPointForCentering(Window window)

Returns the Point at which a window should be placed to center that window on the screen.

Some thought was taken as to whether to implement a method such as this, or to simply make a method that, given a window, will center it. It was decided that it is better to not alter an object within a method.

Parameters:

window - The window to calculate the center point for. This object can not be null.

Returns:

the Point at which the window should be placed to center that window on the screen.

getPointForCentering

public static Point getPointForCentering(JInternalFrame window)

Returns the Point at which a window should be placed to center that window on the given desktop.

Some thought was taken as to whether to implement a method such as this, or to simply make a method that, given a window, will center it. It was decided that it is better to not alter an object within a method.

Parameters:

window - The window (JInternalFrame) to calculate the center point for. This object can not be null.

Returns:

the Point at which the window should be placed to center that window on the given desktop

getPointForStaggering

public static Point getPointForStaggering(Window originWindow)

Returns the Point at which a window should be placed in order to be staggered slightly from another "origin" window to ensure that the title areas of both windows remain visible to the user.

Parameters:

originWindow - Window from which the staggered location will be calculated

Returns:

location staggered from the upper left location of the origin window

findWindow

public static Window findWindow(Component c)

getAllComponents

public static List<Component> getAllComponents(Container c)