repicea.gui

Class CommonGuiUtility

java.lang.Object

repicea.gui.CommonGuiUtility

public class CommonGuiUtility
extends java.lang.Object

The CommonGuiUtility class includes static methods that facilitates the Gui management.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CommonGuiUtility.FileChooserOutput This class provides the result of a file chooser dialog.

Constructor Summary

Constructors

Constructor and Description
CommonGuiUtility()

Method Summary

Modifier and Type	Method and Description
static CommonGuiUtility.FileChooserOutput	browseAction(java.awt.Component owner, int fileSelectionMode, java.lang.String originalFilename, java.util.List<javax.swing.filechooser.FileFilter> fileFilters, int dialogType) This method instantiates a JFileChooser and returns the result in the FileChooserOutput object.
static CommonGuiUtility.FileChooserOutput	browseAction(java.awt.Component owner, int fileSelectionMode, java.lang.String originalFilename, java.util.List<javax.swing.filechooser.FileFilter> fileFilters, int dialogType, javax.swing.filechooser.FileSystemView fsv) This method instantiates a JFileChooser and returns the result in the FileChooserOutput object.
static java.lang.String	convertFilenameForLabel(java.lang.String filename, int maxLength) This method truncates a filename and keeps only the last characters whose length is set through the maxLength parameter.
static javax.swing.JPanel	createSelectAFilePanel(javax.swing.JTextField textField, javax.swing.JButton browse, javax.swing.JLabel label)
static void	enableAllControls(java.awt.Container container, boolean enabled) This method is a recursive method that enables/disables all the controls, ie.
static void	enableThoseComponents(java.awt.Container container, java.lang.Class<? extends java.awt.Component> clazz, boolean enabled) This method is a recursive method that enables/disables all the buttons in a container.
static java.awt.Container	getParentComponent(java.awt.Component comp, java.lang.Class<? extends java.awt.Container> clazz) This method looks for the Container instance that owns this component.
static java.awt.Window	getParentWindow(java.awt.Component comp) This method looks for the Window instance that owns this component.
static java.util.List<java.awt.Component>	mapComponents(java.awt.Container container, java.lang.Class<? extends java.awt.Component> clazz) This method scans a container for all the instances of a particular class that extends the class parameter.
static boolean	popupWriteOverWarningDialog(java.awt.Component owner) This static method asks the user if he/she wants to write over an existing file.
static javax.swing.ImageIcon	retrieveIcon(java.lang.Class<?> clazz, java.lang.String iconName) This method retrieves the icon in a specific package.
static void	showErrorMessage(java.lang.String message, java.awt.Component parent) This method causes a JOptionPane.showErrorMessage to be sent on the Event Dispatch Thread.
static void	showInformationMessage(java.lang.String message, java.awt.Component parent) This method causes a JOptionPane.showErrorMessage to be sent on the Event Dispatch Thread.
static void	showWarningMessage(java.lang.String message, java.awt.Component parent) This method causes a JOptionPane.showErrorMessage to be sent on the Event Dispatch Thread.

Methods inherited from class java.lang.Object

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

Constructor Detail

CommonGuiUtility

public CommonGuiUtility()

Method Detail

browseAction

public static CommonGuiUtility.FileChooserOutput browseAction(java.awt.Component owner,
                                                              int fileSelectionMode,
                                                              java.lang.String originalFilename,
                                                              java.util.List<javax.swing.filechooser.FileFilter> fileFilters,
                                                              int dialogType)

This method instantiates a JFileChooser and returns the result in the FileChooserOutput object.

Parameters:

owner - a Component object that calls this JFileChooser

fileSelectionMode - either JFileChooser.FILES_ONLY (default), JFileChooser.DIRECTORIES_ONLY or JFileChooser.FILES_AND_DIRECTORIES

originalFilename - a String that indicates the initial path of the JFileChooser

fileFilters - a Vector of FileFilter instances

dialogType - either JFileChooser.SAVE_DIALOG or JFileChooser.OPEN_DIALOG

Returns:

a FileChooserOutput instance

Throws:

java.io.IOException - if the dialog type is not recognized

browseAction

public static CommonGuiUtility.FileChooserOutput browseAction(java.awt.Component owner,
                                                              int fileSelectionMode,
                                                              java.lang.String originalFilename,
                                                              java.util.List<javax.swing.filechooser.FileFilter> fileFilters,
                                                              int dialogType,
                                                              javax.swing.filechooser.FileSystemView fsv)

This method instantiates a JFileChooser and returns the result in the FileChooserOutput object.

Parameters:

owner - a Component object that calls this JFileChooser

fileSelectionMode - either JFileChooser.FILES_ONLY (default), JFileChooser.DIRECTORIES_ONLY or JFileChooser.FILES_AND_DIRECTORIES

originalFilename - a String that indicates the initial path of the JFileChooser

fileFilters - a Vector of FileFilter instances

dialogType - either JFileChooser.SAVE_DIALOG or JFileChooser.OPEN_DIALOG

fsv - a FileSystemView instance

Returns:

a FileChooserOutput instance

Throws:

java.io.IOException - if the dialog type is not recognized

popupWriteOverWarningDialog

public static boolean popupWriteOverWarningDialog(java.awt.Component owner)

This static method asks the user if he/she wants to write over an existing file.

Returns:

true if the user accepts or false otherwise

createSelectAFilePanel

public static javax.swing.JPanel createSelectAFilePanel(javax.swing.JTextField textField,
                                                        javax.swing.JButton browse,
                                                        javax.swing.JLabel label)

getParentWindow

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

This method looks for the Window instance that owns this component. It returns null if the component has no parents of the Window class.

Parameters:

comp - a Component instance

Returns:

the Window instance or null

getParentComponent

public static java.awt.Container getParentComponent(java.awt.Component comp,
                                                    java.lang.Class<? extends java.awt.Container> clazz)

This method looks for the Container instance that owns this component. It returns null if the component has no parents of the class.

Parameters:

comp - a Component instance

clazz - a Class that extends Container

Returns:

the Container instance or null

showErrorMessage

public static void showErrorMessage(java.lang.String message,
                                    java.awt.Component parent)

This method causes a JOptionPane.showErrorMessage to be sent on the Event Dispatch Thread.

Parameters:

message - the error message to be displayed

parent - the Container instance that is the parent of this error message (can be null)

showInformationMessage

public static void showInformationMessage(java.lang.String message,
                                          java.awt.Component parent)

This method causes a JOptionPane.showErrorMessage to be sent on the Event Dispatch Thread.

Parameters:

message - the error message to be displayed

parent - the Container instance that is the parent of this error message (can be null)

showWarningMessage

public static void showWarningMessage(java.lang.String message,
                                      java.awt.Component parent)

This method causes a JOptionPane.showErrorMessage to be sent on the Event Dispatch Thread.

Parameters:

message - the error message to be displayed

parent - the Container instance that is the parent of this error message (can be null)

mapComponents

public static java.util.List<java.awt.Component> mapComponents(java.awt.Container container,
                                                               java.lang.Class<? extends java.awt.Component> clazz)

This method scans a container for all the instances of a particular class that extends the class parameter.

Parameters:

container - a Container instance

clazz - a Class instance that extends Component

Returns:

a List of Component instances

enableThoseComponents

public static void enableThoseComponents(java.awt.Container container,
                                         java.lang.Class<? extends java.awt.Component> clazz,
                                         boolean enabled)

This method is a recursive method that enables/disables all the buttons in a container.

Parameters:

container - a Container instance

clazz - a Class instance that extends Component

enabled - a boolean

enableAllControls

public static void enableAllControls(java.awt.Container container,
                                     boolean enabled)

This method is a recursive method that enables/disables all the controls, ie. buttons, textcomponents, comboboxes, list, menubar, slider, spinner, table, tableheader, toolbar, tree

Parameters:

container - a Container instance

enabled - a boolean

retrieveIcon

public static javax.swing.ImageIcon retrieveIcon(java.lang.Class<?> clazz,
                                                 java.lang.String iconName)

This method retrieves the icon in a specific package.

Parameters:

clazz - a class of the package for setting the path

iconName - the filename of the icon

Returns:

an ImageIcon instance

convertFilenameForLabel

public static java.lang.String convertFilenameForLabel(java.lang.String filename,
                                                       int maxLength)

This method truncates a filename and keeps only the last characters whose length is set through the maxLength parameter.

Parameters:

filename - the filename (String)

maxLength - the maximum number of characters (Integer)

Returns:

a String