com.alee.utils

Class CoreSwingUtils

java.lang.Object

com.alee.utils.CoreSwingUtils

public final class CoreSwingUtils
extends Object

This class provides a set of utilities to work with core Swing components, their settings and events.

Author:

Mikle Garin

Method Summary

Modifier and Type	Method and Description
static void	enableEventQueueLogging() Enables logging of all uncaught exceptions occurred within EDT.
static Rectangle	getBoundsInWindow(Component component) Returns component bounds inside its window.
static Rectangle	getBoundsOnScreen(Component component, boolean visibleOnly) Returns Component bounds on screen, either only visible or complete ones.
static AWTEvent	getCurrentEvent() Returns current EventQueue AWTEvent.
static int	getCurrentEventModifiers() Returns current EventQueue AWTEvent modifiers.
static Point	getMouseLocation() Returns mouse location on the screen.
static Point	getMouseLocation(Component component) Returns mouse location on the screen relative to specified component.
static JRootPane	getNonNullRootPane(Component component) Returns root pane for the specified component or null if it doesn't exist.
static Window	getNonNullWindowAncestor(Component component) Returns ancestor Window for specified Component.
static PointerInfo	getPointerInfo() Returns pointer information.
static List<JPopupMenu>	getPopupMenus() Returns List of displayed JPopupMenus.
static Rectangle	getRelativeBounds(Component component, Component relativeTo) Returns component bounds relative to another component.
static Point	getRelativeLocation(Component component, Component relativeTo) Returns component location relative to another component.
static JRootPane	getRootPane(Component component) Returns root pane for the specified component or null if it doesn't exist.
static Component	getTopComponentAt(Component component, int x, int y) Returns top component inside the specified container component at the specified point.
static Component	getTopComponentAt(Component component, Point point) Returns top component inside the specified container component at the specified point.
static Rectangle	getVisibleRect(Component component) Returns intersection of the visible rectangles for the component and all of its ancestors.
static Window	getWindowAncestor(Component component) Returns ancestor Window for specified Component or null if it doesn't exist.
static Insets	getWindowDecorationInsets(Window window) Returns window decoration insets.
static void	invokeAndWait(Runnable runnable) Will invoke the specified Runnable in EDT in case it is called from non-EDT thread.
static void	invokeAndWait(Runnable runnable, boolean ignoreInterrupts) Will invoke the specified Runnable in EDT in case it is called from non-EDT thread.
static void	invokeLater(Runnable runnable) Will invoke specified Runnable later in EDT.
static void	invokeOnEventDispatchThread(Runnable runnable) Executes specified Runnable on the current Thread if it is Event Dispatch Thread.
static boolean	isAncestorOf(Component ancestor, Component component) Returns whether or not specified ancestor is an ancestor of component.
static boolean	isEventDispatchThread() Returns whether or not current thread is an AWT event dispatching thread.
static boolean	isFullScreen(Component component) Returns whether or not specified component is placed on a fullscreen window.
static boolean	isHovered(Component component) Returns whether or not specified Component is currently hovered.
static boolean	isMenuShortcutKeyDown(InputEvent event) Returns whether or not specified InputEvent contains a menu shortcut key.
static boolean	isSameAncestor(Component component1, Component component2) Returns whether specified components have the same ancestor or not.
static boolean	isVisibleOnScreen(Component component) Returns whether or not specified Component is actually visible on screen.
static Point	locationOnScreen(Component component) Returns Component location on screen.

Methods inherited from class java.lang.Object

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

Method Detail

enableEventQueueLogging

public static void enableEventQueueLogging()

Enables logging of all uncaught exceptions occurred within EDT.

getCurrentEvent

@Nullable
public static AWTEvent getCurrentEvent()

Returns current EventQueue AWTEvent.

Returns:

current EventQueue AWTEvent

getCurrentEventModifiers

public static int getCurrentEventModifiers()

Returns current EventQueue AWTEvent modifiers.

Returns:

current EventQueue AWTEvent modifiers

getNonNullWindowAncestor

@NotNull
public static Window getNonNullWindowAncestor(@NotNull
                                                       Component component)

Returns ancestor Window for specified Component.

Parameters:

component - Component to find ancestor Window for

Returns:

ancestor Window for specified Component.

getWindowAncestor

@Nullable
public static Window getWindowAncestor(@Nullable
                                                 Component component)

Returns ancestor Window for specified Component or null if it doesn't exist.

Parameters:

component - Component to find ancestor Window for

Returns:

ancestor Window for specified Component or null if it doesn't exist

getNonNullRootPane

@NotNull
public static JRootPane getNonNullRootPane(@NotNull
                                                    Component component)

Returns root pane for the specified component or null if it doesn't exist.

Parameters:

component - component to look under

Returns:

root pane for the specified component or null if it doesn't exist

getRootPane

@Nullable
public static JRootPane getRootPane(@Nullable
                                              Component component)

Returns root pane for the specified component or null if it doesn't exist.

Parameters:

component - component to look under

Returns:

root pane for the specified component or null if it doesn't exist

isVisibleOnScreen

public static boolean isVisibleOnScreen(@NotNull
                                        Component component)

Returns whether or not specified Component is actually visible on screen. Note that this method does not account for any other windows that may overlay current one, that needs to be checked separately.

Parameters:

component - Component to check visibility on screen for

Returns:

true if specified Component is actually visible on screen, false otherwise

getBoundsOnScreen

@NotNull
public static Rectangle getBoundsOnScreen(@NotNull
                                                   Component component,
                                                   boolean visibleOnly)

Returns Component bounds on screen, either only visible or complete ones. Visible only bounds will only include part of the Component that is actually visible on the screen. Complete Component bounds might include parts that are not actually visible on the screen due to layout or scroll pane.

Parameters:

component - Component to process

visibleOnly - whether or not only visible Component part bounds should be returned

Returns:

Component bounds on screen, either only visible or complete ones

getBoundsInWindow

@Nullable
public static Rectangle getBoundsInWindow(@NotNull
                                                    Component component)

Returns component bounds inside its window. This will return component bounds relative to window root pane location, not the window location.

Parameters:

component - component to process

Returns:

component bounds inside its window

getRelativeBounds

@NotNull
public static Rectangle getRelativeBounds(@NotNull
                                                   Component component,
                                                   @NotNull
                                                   Component relativeTo)

Returns component bounds relative to another component.

Parameters:

component - component to process

relativeTo - component relative to which bounds will be returned

Returns:

component bounds relative to another component

getRelativeLocation

@NotNull
public static Point getRelativeLocation(@NotNull
                                                 Component component,
                                                 @NotNull
                                                 Component relativeTo)

Returns component location relative to another component.

Parameters:

component - component to process

relativeTo - component relative to which location will be returned

Returns:

component location relative to another component

isAncestorOf

public static boolean isAncestorOf(@Nullable
                                   Component ancestor,
                                   @Nullable
                                   Component component)

Returns whether or not specified ancestor is an ancestor of component.

Parameters:

ancestor - ancestor component

component - child component

Returns:

true if specified ancestor is an ancestor of component, false otherwise

isSameAncestor

public static boolean isSameAncestor(@Nullable
                                     Component component1,
                                     @Nullable
                                     Component component2)

Returns whether specified components have the same ancestor or not.

Parameters:

component1 - first component

component2 - second component

Returns:

true if specified components have the same ancestor, false otherwise

getWindowDecorationInsets

@NotNull
public static Insets getWindowDecorationInsets(@Nullable
                                                        Window window)

Returns window decoration insets.

Parameters:

window - window to retrieve insets for

Returns:

window decoration insets

isFullScreen

public static boolean isFullScreen(@Nullable
                                   Component component)

Returns whether or not specified component is placed on a fullscreen window.

Parameters:

component - component to process

Returns:

true if specified component is placed on a fullscreen window, false otherwise

getPointerInfo

@NotNull
public static PointerInfo getPointerInfo()

Returns pointer information. todo Add some sort of caching to enhance performance? todo For example keep it for 10 ms in case there will be multiple incoming requests

Returns:

pointer information

getMouseLocation

@NotNull
public static Point getMouseLocation()

Returns mouse location on the screen.

Returns:

mouse location on the screen

getMouseLocation

@NotNull
public static Point getMouseLocation(@NotNull
                                              Component component)

Returns mouse location on the screen relative to specified component.

Parameters:

component - component

Returns:

mouse location on the screen relative to specified component

isHovered

public static boolean isHovered(@NotNull
                                Component component)

Returns whether or not specified Component is currently hovered.

Parameters:

component - Component

Returns:

true if specified Component is currently hovered, false otherwise

getTopComponentAt

@Nullable
public static Component getTopComponentAt(@Nullable
                                                    Component component,
                                                    @NotNull
                                                    Point point)

Returns top component inside the specified container component at the specified point.

Parameters:

component - container component to process

point - point on the component

Returns:

top component inside the specified container component at the specified point

getTopComponentAt

@Nullable
public static Component getTopComponentAt(@Nullable
                                                    Component component,
                                                    int x,
                                                    int y)

Returns top component inside the specified container component at the specified point.

Parameters:

component - container component to process

x - X coordinate on the component

y - Y coordinate on the component

Returns:

top component inside the specified container component at the specified point

locationOnScreen

@NotNull
public static Point locationOnScreen(@NotNull
                                              Component component)

Returns Component location on screen. Throws a detailed exception in case Component was not showing.

Parameters:

component - Component to determine locatin on screen for

Returns:

Component location on screen

getPopupMenus

@NotNull
public static List<JPopupMenu> getPopupMenus()

Returns List of displayed JPopupMenus. Multiple JPopupMenus can be displayed in case when submenus are visible.

Returns:

List of displayed JPopupMenus

isMenuShortcutKeyDown

public static boolean isMenuShortcutKeyDown(@NotNull
                                            InputEvent event)

Returns whether or not specified InputEvent contains a menu shortcut key.

Parameters:

event - InputEvent

Returns:

true if specified InputEvent contains a menu shortcut key, false otherwise

isEventDispatchThread

public static boolean isEventDispatchThread()

Returns whether or not current thread is an AWT event dispatching thread.

Returns:

true if the current thread is an AWT event dispatching thread, false otherwise

invokeLater

public static void invokeLater(@NotNull
                               Runnable runnable)

Will invoke specified Runnable later in EDT. It is highly recommended to perform all UI-related operations within EDT by invoking them through this method.

Parameters:

runnable - Runnable to execute

invokeOnEventDispatchThread

public static void invokeOnEventDispatchThread(@NotNull
                                               Runnable runnable)

Executes specified Runnable on the current Thread if it is Event Dispatch Thread. Otherwise specified Runnable will be executed later on Event Dispatch Thread.

Parameters:

runnable - Runnable to execute

invokeAndWait

public static void invokeAndWait(@NotNull
                                 Runnable runnable)

Will invoke the specified Runnable in EDT in case it is called from non-EDT thread. It will catch any exceptions thrown by SwingUtilities.invokeAndWait(Runnable) and wrap them in UtilityException. It is generally recommended to use invokeLater(Runnable) instead whenever it is possible to avoid stalling EDT.

Parameters:

runnable - Runnable to execute

invokeAndWait

public static void invokeAndWait(@NotNull
                                 Runnable runnable,
                                 boolean ignoreInterrupts)

Will invoke the specified Runnable in EDT in case it is called from non-EDT thread. It will catch any exceptions thrown by SwingUtilities.invokeAndWait(Runnable) and wrap them in UtilityException. It is generally recommended to use invokeLater(Runnable) instead whenever it is possible to avoid stalling EDT.

Parameters:

runnable - Runnable to execute

ignoreInterrupts - whether or not InterruptedExceptions should be ignored

getVisibleRect

@NotNull
public static Rectangle getVisibleRect(@NotNull
                                                Component component)

Returns intersection of the visible rectangles for the component and all of its ancestors.

Parameters:

component - Component

Returns:

intersection of the visible rectangles for the component and all of its ancestors