jhelp.util.gui

Class UtilGUI

java.lang.Object

jhelp.util.gui.UtilGUI

public final class UtilGUI
extends java.lang.Object

Utilities for GUI

Author:

JHelp

Field Summary

Fields

Modifier and Type	Field and Description
private static java.awt.image.BufferedImage	EMPTY_IMAGE Empty image
private static java.awt.GraphicsDevice[]	GRAPHICS_DEVICES List of graphics devices
static java.awt.GraphicsEnvironment	GRAPHICS_ENVIRONMENT Current graphics environment
private static java.awt.Cursor	INVISIBLE_CURSOR Invisible cursor
private static java.awt.Robot	ROBOT Robot for simulate keyboard and mouse events
static java.awt.Toolkit	TOOLKIT Current toolkit

Constructor Summary

Constructors

Modifier	Constructor and Description
private	UtilGUI() For avoid instance

Method Summary

Methods

Modifier and Type	Method and Description
static void	centerOnScreen(java.awt.Window window) Center a window on its screen
static void	changeScreen(java.awt.Window window, int screenIndex) Change a window of screen
private static void	checkScreenIndex(int screenIndex) Check if a screen index is valid
static int	computeIntresectedArea(java.awt.Rectangle rectangle1, java.awt.Rectangle rectangle2) Compute intersection area between two rectangles
static java.awt.Dimension	computeMaximumDimension(java.awt.Component component) Compute the maximum dimension of a component
static java.awt.Dimension	computeMinimumDimension(java.awt.Component component) Compute the minimum dimension of a component
static java.awt.Dimension	computePreferredDimension(java.awt.Component component) Compute the preferred dimension of a component
static java.awt.Rectangle	computeScreenRectangle(java.awt.Window window) Compute the rectangle of the screen where is a window
static javax.swing.JFrame	getFrameParent(java.awt.Container container) Obtain frame parent of a container
static java.awt.Point	getLocationOn(java.awt.Component component, java.awt.Component parent) Give the relative of a component for an other one
static java.awt.Rectangle	getScreenBounds(int screen) Give bounds of a screen
static java.lang.String	getScreenIdentifier(int screenIndex) Screen identifier
static void	initializeGUI() Initialize GUI with operating system skin, call it before create any frame
static void	locateMouseAt(int x, int y) Place the mouse on a location on the screen
static void	locateMouseOver(java.awt.Component component) Place the mouse over the middle of a component
static void	locateMouseOver(java.awt.Component component, int x, int y) Place the mouse over a component
static int	numberOfScreen() Number of screen
static java.awt.Cursor	obtainInvisbleCursor() Invisible cursor
static int	obtainNumberOffScreen() Number of screen
static int	obtainScreenIndex(java.awt.Window window) Obtain index of the screen where is the window
static void	packedSize(java.awt.Window window) Put a window in it's pack size Size is automatic limited to the window's screen
static java.awt.image.BufferedImage	screenShot() Make a screen shot
static javax.swing.JFrame	searchFrameParent(java.awt.Component component) Search JFrame parent of a component
static void	simulateKeyPress(int keyCode) Simulate a key press
static void	simulateKeyRelease(int keyCode) Simulate a key release
static void	simulateMousePress(int button) Simulate a mouse press
static void	simulateMouseRelease(int button) Simulate a mouse release
static void	simulateReleasedPressed(int time) Simulate a release then press mouse button
static void	takeAllScreen(java.awt.Window window) Make widow take all it's screen

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_IMAGE

private static java.awt.image.BufferedImage EMPTY_IMAGE

Empty image

GRAPHICS_DEVICES

private static final java.awt.GraphicsDevice[] GRAPHICS_DEVICES

List of graphics devices

INVISIBLE_CURSOR

private static java.awt.Cursor INVISIBLE_CURSOR

Invisible cursor

ROBOT

private static final java.awt.Robot ROBOT

Robot for simulate keyboard and mouse events

GRAPHICS_ENVIRONMENT

public static final java.awt.GraphicsEnvironment GRAPHICS_ENVIRONMENT

Current graphics environment

TOOLKIT

public static final java.awt.Toolkit TOOLKIT

Current toolkit

Constructor Detail

UtilGUI

private UtilGUI()

For avoid instance

Method Detail

checkScreenIndex

private static void checkScreenIndex(int screenIndex)

Check if a screen index is valid

Parameters:

screenIndex - Screen index to check

centerOnScreen

public static void centerOnScreen(java.awt.Window window)

Center a window on its screen

Parameters:

window - Widow to center

changeScreen

public static void changeScreen(java.awt.Window window,
                int screenIndex)

Change a window of screen

Parameters:

window - Widow to translate

screenIndex - Destination screen

computeIntresectedArea

public static int computeIntresectedArea(java.awt.Rectangle rectangle1,
                         java.awt.Rectangle rectangle2)

Compute intersection area between two rectangles

Parameters:

rectangle1 - First rectangle

rectangle2 - Second rectangle

Returns:

Computed area

computeMaximumDimension

public static java.awt.Dimension computeMaximumDimension(java.awt.Component component)

Compute the maximum dimension of a component

Parameters:

component - Component to compute it's maximum size

Returns:

Maximum size

computeMinimumDimension

public static java.awt.Dimension computeMinimumDimension(java.awt.Component component)

Compute the minimum dimension of a component

Parameters:

component - Component to compute it's minimum size

Returns:

Minimum size

computePreferredDimension

public static java.awt.Dimension computePreferredDimension(java.awt.Component component)

Compute the preferred dimension of a component

Parameters:

component - Component to compute it's preferred size

Returns:

Preferred size

computeScreenRectangle

public static java.awt.Rectangle computeScreenRectangle(java.awt.Window window)

Compute the rectangle of the screen where is a window

Parameters:

window - Window we looking for its screen

Returns:

Screen's rectangle

getFrameParent

public static javax.swing.JFrame getFrameParent(java.awt.Container container)

Obtain frame parent of a container

Parameters:

container - Container to get its parent

Returns:

Parent frame

getLocationOn

public static java.awt.Point getLocationOn(java.awt.Component component,
                           java.awt.Component parent)

Give the relative of a component for an other one

Parameters:

component - Component to search its position

parent - A component ancestor

Returns:

Relative position of null if parent is not an ancestor of component

getScreenBounds

public static java.awt.Rectangle getScreenBounds(int screen)

Give bounds of a screen

Parameters:

screen - Screen index

Returns:

Screen bounds

getScreenIdentifier

public static java.lang.String getScreenIdentifier(int screenIndex)

Screen identifier

Parameters:

screenIndex - Screen index

Returns:

Screen identifier

initializeGUI

public static void initializeGUI()

Initialize GUI with operating system skin, call it before create any frame

locateMouseAt

public static void locateMouseAt(int x,
                 int y)

Place the mouse on a location on the screen

Parameters:

x - X screen position

y - Y screen position

locateMouseOver

public static void locateMouseOver(java.awt.Component component)

Place the mouse over the middle of a component

Parameters:

component - Component mouse go over

locateMouseOver

public static void locateMouseOver(java.awt.Component component,
                   int x,
                   int y)

Place the mouse over a component

Parameters:

component - Component mouse go over

x - X relative to component up-left corner

y - Y relative to component up-left corner

numberOfScreen

public static int numberOfScreen()

Number of screen

Returns:

Number of screen

obtainInvisbleCursor

public static java.awt.Cursor obtainInvisbleCursor()

Invisible cursor

Returns:

Invisible cursor

obtainNumberOffScreen

public static int obtainNumberOffScreen()

Number of screen

Returns:

Number of screen

obtainScreenIndex

public static int obtainScreenIndex(java.awt.Window window)

Obtain index of the screen where is the window

Parameters:

window - Considered window

Returns:

Screen index

packedSize

public static void packedSize(java.awt.Window window)

Put a window in it's pack size
Size is automatic limited to the window's screen

Parameters:

window - Window to pack

screenShot

public static java.awt.image.BufferedImage screenShot()

Make a screen shot

Returns:

Screen shot

searchFrameParent

public static javax.swing.JFrame searchFrameParent(java.awt.Component component)

Search JFrame parent of a component

Parameters:

component - Component search it's JFram parent

Returns:

JFrame parent or null if component haven't a JFrame parent

simulateKeyPress

public static void simulateKeyPress(int keyCode)

Simulate a key press

Parameters:

keyCode - Key code

simulateKeyRelease

public static void simulateKeyRelease(int keyCode)

Simulate a key release

Parameters:

keyCode - Key code

simulateMousePress

public static void simulateMousePress(int button)

Simulate a mouse press

Parameters:

button - Mouse buttons

simulateMouseRelease

public static void simulateMouseRelease(int button)

Simulate a mouse release

Parameters:

button - Mouse buttons

simulateReleasedPressed

public static void simulateReleasedPressed(int time)

Simulate a release then press mouse button

Parameters:

time - Time between release and press

takeAllScreen

public static void takeAllScreen(java.awt.Window window)

Make widow take all it's screen

Parameters:

window - Window to maximize