griffon.swing.support

Class SwingUtils

java.lang.Object

griffon.swing.support.SwingUtils

public class SwingUtils
extends Object

Additional utilities for Swing based applications.

Since:

2.0.0

Author:

Andres Almiray

Method Summary

Modifier and Type	Method and Description
static void	centerOnScreen(JInternalFrame internalFrame) Centers a JInternalFrame on the screen
static void	centerOnScreen(Window window) Centers a Window on the screen
static Window	createApplicationFrame(GriffonApplication application, Map<String,Object> attributes) Creates a Window based on the application's configuration.
static Component	findComponentByName(String name, Container root) Searches a component by name in a particular component hierarchy.
static float	getWindowOpacity(Window window) Returns the window's current opacity value.
static void	setWindowOpacity(Window window, float opacity) Sets the value for the window's opacity.
static Image	takeSnapshot(Component component) Takes a snapshot of the target component.
static Image	takeSnapshot(Component component, boolean usePrint) Takes a snapshot of the target component.

Methods inherited from class java.lang.Object

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

Method Detail

centerOnScreen

public static void centerOnScreen(@Nonnull
                                  Window window)

Centers a Window on the screen

Sets the window on the top left corner if the window's dimensions are bigger than the screen's.

Parameters:

window - a Window object

centerOnScreen

public static void centerOnScreen(@Nonnull
                                  JInternalFrame internalFrame)

Centers a JInternalFrame on the screen

Sets the internal frame on the top left corner if the frame's dimensions are bigger than the desktop's.

Parameters:

internalFrame - a JInternalFrame object

getWindowOpacity

public static float getWindowOpacity(@Nonnull
                                     Window window)

Returns the window's current opacity value.

Parameters:

window - the window on which the opacity will be queried

Returns:

the window's opacity value

setWindowOpacity

public static void setWindowOpacity(@Nonnull
                                    Window window,
                                    float opacity)

Sets the value for the window's opacity.

Parameters:

window - the window on which the opacity will be set

opacity - the new opacity value

findComponentByName

@Nullable
public static Component findComponentByName(@Nonnull
                                                      String name,
                                                      @Nonnull
                                                      Container root)

Searches a component by name in a particular component hierarchy.

A component must have a value for its name property if it's to be found with this method.
This method performs a depth-first search.

Parameters:

name - the value of the component's name property

root - the root of the component hierarchy from where searching searching should start

Returns:

the component reference if found, null otherwise

takeSnapshot

@Nonnull
public static Image takeSnapshot(@Nonnull
                                          Component component)

Takes a snapshot of the target component.

Parameters:

component - the component to draw

Returns:

a Graphics compatible image of the component

takeSnapshot

@Nonnull
public static Image takeSnapshot(@Nonnull
                                          Component component,
                                          boolean usePrint)

Takes a snapshot of the target component.

Parameters:

component - the component to draw

usePrint - whether print() or paint() is used to grab the snapshot

Returns:

a Graphics compatible image of the component

createApplicationFrame

@Nonnull
public static Window createApplicationFrame(@Nonnull
                                                     GriffonApplication application,
                                                     @Nonnull
                                                     Map<String,Object> attributes)

Creates a Window based on the application's configuration.

Class lookup order is

1. value in app.config.application.frameClass
2. 'org.jdesktop.swingx.JXFrame' if SwingX is in the classpath
3. 'javax.swing.JFrame'

Parameters:

application - the current running application

attributes - window attributes

Returns:

a newly instantiated window according to the application's preferences