com.lf.commons.dialog

Class DialogUtils

java.lang.Object

com.lf.commons.dialog.DialogUtils

public class DialogUtils
extends java.lang.Object

Some multipurpose utility methods for handling dialogs and windows in general.

Since:

1.6

Version:

$Revision: 1.28 $, $Date: 2012/12/28 11:44:25 $

Author:

Axel Schwolow

Constructor Summary

Constructors

Constructor and Description
DialogUtils() Constructor method for i18n purposes only.

Method Summary

Methods

Modifier and Type	Method and Description
static java.awt.Point	centerForScreen(int width, int height) Calculates the position for the current screen.
static java.awt.Point	centerForWindow(java.awt.Window parent, int width, int height) Calculates the position for a dialog window on the screen.
static void	copyScreenShot(java.awt.image.BufferedImage screenshot) Copies the screenshot to the system clipboard for other applications to use.
static javax.swing.JDialog	createComponentDialog(java.awt.Component comp, java.awt.Window window, java.lang.String title, javax.swing.ImageIcon icon) Creates a new separate dialog window to display a component.
static javax.swing.JFrame	createComponentFrame(java.awt.Component comp, java.awt.Window window, java.lang.String title, javax.swing.ImageIcon icon) Creates a new separate frame window to display a component.
static java.awt.Container[]	findParents(java.awt.Component comp, java.lang.Class type) Determines the component's parent containers of special type.
static java.awt.Container[]	findParents(java.awt.Component comp, java.lang.String clazz) Determines the component's parent containers of special type.
static java.awt.Window	getActiveWindow(java.awt.Component comp) Provides the window on top of the window hierarchy of the given component.
static ConfigurableUnit	getConfigurableUnit(javax.swing.JFileChooser chooser) Convenience to get a ConfigurableUnit for JFileChooser.
static java.awt.Dialog	getDialogParent(java.awt.Component comp) Determines the component's top-level container.
static java.lang.String	getDisplayType(java.lang.Class clazz) Convenience to get a display type for a certain Commons dialog type.
static java.awt.Frame	getFrameParent(java.awt.Component comp) Determines the component's top-level container.
static java.awt.image.BufferedImage	getScreenShot(java.awt.Component target) Takes a screenshot of the given window.
static java.awt.Window	getWindowParent(java.awt.Component comp) Determines the component's top-level container.
static void	printScreenShot(java.awt.image.BufferedImage screenshot, java.lang.String jobname) Takes a screenshot of the given window and opens a print dialog.
static boolean	saveData(java.io.InputStream istream, java.awt.Component parent, java.lang.String unitid, ApplicationModel model, java.lang.String filename, SuffixFilter[] filters, boolean allfilter, SuffixFilter defaultfilter, java.util.Vector<java.io.File> target) Presents a file chooser dialog and writes the data to the file.
static boolean	saveData(java.io.InputStream istream, java.awt.Component parent, java.lang.String unitid, ApplicationModel model, java.lang.String filename, SuffixFilter[] filters, boolean allfilter, SuffixFilter defaultfilter, java.util.Vector<org.apache.commons.vfs2.FileObject> target, java.util.Vector<VFSConnection> connections, VFSConnection vfsconn, DockingManager dockingmanager, boolean editingallowed) Presents a file chooser dialog and writes the data to the URL.
static boolean	saveData(java.io.InputStream istream, java.awt.Component parent, java.lang.String unitid, ApplicationModel model, java.lang.String filename, java.util.Vector<java.io.File> target) Presents a file chooser dialog and writes the data to the file.
static boolean	saveData(java.io.InputStream istream, java.awt.Component parent, java.lang.String unitid, ApplicationModel model, java.lang.String filename, java.util.Vector<org.apache.commons.vfs2.FileObject> target, java.util.Vector<VFSConnection> connections, VFSConnection vfsconn, DockingManager dockingmanager, boolean editingallowed) Presents a file chooser dialog and writes the data to the URL.
static java.io.File	saveScreenShot(java.awt.image.BufferedImage screenshot, java.awt.Component parent, java.lang.String unitid, ApplicationModel model, java.lang.String filename) Presents a file chooser dialog and writes the image to the file.

Methods inherited from class java.lang.Object

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

Constructor Detail

DialogUtils

public DialogUtils()
            throws java.lang.InstantiationException

Constructor method for i18n purposes only.

Can only be used if beans design time is set (e.g. by external tools like the I18NExtractor).

Throws:

java.lang.InstantiationException - Error indication

Since:

1.6

Method Detail

saveScreenShot

public static java.io.File saveScreenShot(java.awt.image.BufferedImage screenshot,
                          java.awt.Component parent,
                          java.lang.String unitid,
                          ApplicationModel model,
                          java.lang.String filename)

Presents a file chooser dialog and writes the image to the file.

Parameters:

screenshot - The screenshot to be stored

parent - The parent component

unitid - The unique identifier for the instance, maybe null

model - The configuration, maybe null

filename - The desired filename, maybe null

Returns:

Created file, null indicates error

Since:

1.5

centerForWindow

public static java.awt.Point centerForWindow(java.awt.Window parent,
                             int width,
                             int height)

Calculates the position for a dialog window on the screen.

Can be used to center a dialog for its parent window. If the parent window is null then the point is calculated for the whole desktop automatically.

Parameters:

parent - The parent window to center the dialog, for desktop if null

width - The width of the dialog to be centered

height - The height of the dialog to be centered

Returns:

The position on the screen

Since:

1.5

centerForScreen

public static java.awt.Point centerForScreen(int width,
                             int height)

Calculates the position for the current screen.

Parameters:

width - The width of the dialog to be centered

height - The height of the dialog to be centered

Returns:

The position on the screen

Since:

1.6

getDialogParent

public static java.awt.Dialog getDialogParent(java.awt.Component comp)

Determines the component's top-level container.

Parameters:

comp - The desired component

Returns:

The parental dialog, may be null

Throws:

java.lang.NullPointerException - Error case

Since:

1.6

getFrameParent

public static java.awt.Frame getFrameParent(java.awt.Component comp)

Determines the component's top-level container.

Parameters:

comp - The desired component

Returns:

The parental frame, may be null

Throws:

java.lang.NullPointerException - Error case

Since:

1.6

getActiveWindow

public static java.awt.Window getActiveWindow(java.awt.Component comp)

Provides the window on top of the window hierarchy of the given component.

This may be a focussable main window or a modal dialog currently being displayed.

Parameters:

comp - The component to be analyzed

Returns:

The window on top, may be null

Throws:

java.lang.NullPointerException - If the parameters are null

Since:

1.6

getWindowParent

public static java.awt.Window getWindowParent(java.awt.Component comp)

Determines the component's top-level container.

Parameters:

comp - The desired component

Returns:

The parental window, may be null

Throws:

java.lang.NullPointerException - Error case

Since:

1.5

findParents

public static java.awt.Container[] findParents(java.awt.Component comp,
                               java.lang.String clazz)

Determines the component's parent containers of special type.

Returns all parents if the type is not specified (null).

Parameters:

comp - The desired component

clazz - The desired parent type in FQN, may be null

Returns:

The parental containers, zero-length if not found

Throws:

java.lang.NullPointerException - Error case

Since:

1.5

findParents

public static java.awt.Container[] findParents(java.awt.Component comp,
                               java.lang.Class type)

Determines the component's parent containers of special type.

Returns all parents if the type is not specified (null).

Parameters:

comp - The desired component

type - The desired parent type, may be null

Returns:

The parental window, zero-length if not found

Throws:

java.lang.NullPointerException - Error case

Since:

1.5

getScreenShot

public static java.awt.image.BufferedImage getScreenShot(java.awt.Component target)

Takes a screenshot of the given window.

If this method is called from a callback method of a menu or other active component which shall not be part of the screen shot, call this method by using invokeLater().

Parameters:

target - The GUI component to shoot, whole screen if null

Returns:

The screen shot image, null if an error occurs

Since:

1.5

printScreenShot

public static void printScreenShot(java.awt.image.BufferedImage screenshot,
                   java.lang.String jobname)

Takes a screenshot of the given window and opens a print dialog.

Parameters:

screenshot - The screenshot to be printed

jobname - The application specific job name, may be null

Since:

1.5

copyScreenShot

public static void copyScreenShot(java.awt.image.BufferedImage screenshot)

Copies the screenshot to the system clipboard for other applications to use.

Parameters:

screenshot - The screenshot to be copied

Since:

1.5

saveData

public static boolean saveData(java.io.InputStream istream,
               java.awt.Component parent,
               java.lang.String unitid,
               ApplicationModel model,
               java.lang.String filename,
               java.util.Vector<java.io.File> target)

Presents a file chooser dialog and writes the data to the file.

Parameters:

istream - The data stream to be stored

parent - The parent component

unitid - The unique identifier for the instance, maybe null

model - The configuration, maybe null

filename - The desired filename, maybe null

target - Data holder for target file, empty on cancel

Returns:

Successful?

Since:

1.6

saveData

public static boolean saveData(java.io.InputStream istream,
               java.awt.Component parent,
               java.lang.String unitid,
               ApplicationModel model,
               java.lang.String filename,
               SuffixFilter[] filters,
               boolean allfilter,
               SuffixFilter defaultfilter,
               java.util.Vector<java.io.File> target)

Presents a file chooser dialog and writes the data to the file.

Parameters:

istream - The data stream to be stored

parent - The parent component

unitid - The unique identifier for the instance, maybe null

model - The configuration, maybe null

filename - The desired filename, maybe null

filters - The suffix filters (optional)

allfilter - Add the default filter *.*?

defaultfilter - Default filter to select initially (optional)

target - Data holder for target file, empty on cancel

Returns:

Successful?

Since:

1.6

saveData

public static boolean saveData(java.io.InputStream istream,
               java.awt.Component parent,
               java.lang.String unitid,
               ApplicationModel model,
               java.lang.String filename,
               java.util.Vector<org.apache.commons.vfs2.FileObject> target,
               java.util.Vector<VFSConnection> connections,
               VFSConnection vfsconn,
               DockingManager dockingmanager,
               boolean editingallowed)

Presents a file chooser dialog and writes the data to the URL.

Parameters:

istream - The data stream to be stored

parent - The parent component

unitid - The unique identifier for the instance, maybe null

model - The configuration, maybe null

filename - The desired filename, maybe null

target - Data holder for target URL, empty on cancel

connections - The VFS connections to present with combo box

vfsconn - The selected connection (optional)

dockingmanager - The docking manager (optional)

editingallowed - Connection management?

Returns:

Successful?

Since:

1.6

saveData

public static boolean saveData(java.io.InputStream istream,
               java.awt.Component parent,
               java.lang.String unitid,
               ApplicationModel model,
               java.lang.String filename,
               SuffixFilter[] filters,
               boolean allfilter,
               SuffixFilter defaultfilter,
               java.util.Vector<org.apache.commons.vfs2.FileObject> target,
               java.util.Vector<VFSConnection> connections,
               VFSConnection vfsconn,
               DockingManager dockingmanager,
               boolean editingallowed)

Presents a file chooser dialog and writes the data to the URL.

Parameters:

istream - The data stream to be stored

parent - The parent component

unitid - The unique identifier for the instance, maybe null

model - The configuration, maybe null

filename - The desired filename, maybe null

filters - The suffix filters (optional)

allfilter - Add the default filter *.*?

defaultfilter - Default filter to select initially (optional)

target - Data holder for target URL, empty on cancel

connections - The VFS connections to present with combo box

vfsconn - The selected connection (optional)

dockingmanager - The docking manager (optional)

editingallowed - Connection management?

Returns:

Successful?

Since:

1.6

getDisplayType

public static java.lang.String getDisplayType(java.lang.Class clazz)

Convenience to get a display type for a certain Commons dialog type.

Parameters:

clazz - The dialog class

Returns:

The type to be displayed

Since:

1.6

getConfigurableUnit

public static ConfigurableUnit getConfigurableUnit(javax.swing.JFileChooser chooser)

Convenience to get a ConfigurableUnit for JFileChooser.

Parameters:

chooser - The target file chooser

Returns:

The configurable unit

Since:

1.6

createComponentDialog

public static javax.swing.JDialog createComponentDialog(java.awt.Component comp,
                                        java.awt.Window window,
                                        java.lang.String title,
                                        javax.swing.ImageIcon icon)

Creates a new separate dialog window to display a component.

The component is NOT removed from its parent here. The size is kept, the component is centered for either the parental window or for the whole screen otherwise.

Parameters:

comp - The component

window - The parental window (optional)

title - The decoration text (optional)

icon - The dialog icon (optional)

Returns:

The new dialog

Throws:

java.lang.NullPointerException - If a parameter is null

Since:

1.6

createComponentFrame

public static javax.swing.JFrame createComponentFrame(java.awt.Component comp,
                                      java.awt.Window window,
                                      java.lang.String title,
                                      javax.swing.ImageIcon icon)

Creates a new separate frame window to display a component.

The component is NOT removed from its parent here. The size is kept, the component is centered for either the parental window or for the whole screen otherwise.

Parameters:

comp - The component

window - The parental window (optional)

title - The decoration text (optional)

icon - The dialog icon (optional)

Returns:

The new dialog

Throws:

java.lang.NullPointerException - If a parameter is null

Since:

1.6