edu.udo.cs.yale.gui
Class SwingTools

java.lang.Object
  edu.udo.cs.yale.gui.SwingTools

public class SwingTools
extends java.lang.Object

This helper class provides some static methods and properties which might be useful for several GUI classes. These methods include

• the creation of gradient paints
• displaying (simple) error messages
• creation of file chosers
• creation of text panels
• escaping HTML messages

Version:

$Id: SwingTools.java,v 2.25 2006/09/12 21:38:20 ingomierswa Exp $

Author:

Ingo Mierswa, Simon Fischer

Field Summary

static java.awt.Color	DARK_BLUE Some color constants for Java Look and Feel.
static java.awt.Color	DARK_YELLOW Some color constants for Java Look and Feel.
static java.awt.Color	LIGHT_BLUE Some color constants for Java Look and Feel.
static java.awt.Color	LIGHT_YELLOW Some color constants for Java Look and Feel.
static java.awt.Color	LIGHTEST_BLUE Some color constants for Java Look and Feel.
static java.awt.Color	LIGHTEST_YELLOW Some color constants for Java Look and Feel.
static int	TABLE_ROW_EXTRA_HEIGHT Defines the extra height for each row in a table.

Constructor Summary

SwingTools()

Method Summary

private static java.io.File	chooseFile(java.awt.Component parent, java.io.File file, boolean open, boolean onlyDirs, javax.swing.filechooser.FileFilter[] fileFilters) Opens a file chooser with a reasonable start directory. onlyDirs indidcates if only files or only can be selected.
private static java.io.File	chooseFile(java.awt.Component parent, java.io.File file, boolean open, boolean onlyDirs, java.lang.String[] extensions, java.lang.String[] extensionDescriptions) Returns the user selected file.
static java.io.File	chooseFile(java.awt.Component parent, java.io.File file, boolean open, boolean onlyDirs, java.lang.String extension, java.lang.String extensionDescription) Opens a file chooser with a reasonable start directory.
static java.io.File	chooseFile(java.awt.Component parent, java.io.File file, boolean open, java.lang.String extension, java.lang.String extensionDescription) Opens a file chooser with a reasonable start directory.
static javax.swing.JFileChooser	createFileChooser(java.io.File file, boolean onlyDirs, javax.swing.filechooser.FileFilter[] fileFilters) Creates file chooser with a reasonable start directory.
static javax.swing.JPanel	createTextPanel(java.lang.String title, java.lang.String text) Creates a panel with title and text.
static java.awt.Color	getPointColor(double value) Returns a color equivalent to the value of value.
static java.awt.Color	getPointColor(double value, double max, double min) Returns a color equivalent to the value of value.
static java.lang.String	html2YaleText(java.lang.String html) Replaces simple html tags and quotes by Yale specific text elements.
static java.awt.GradientPaint	makeBluePaint(double width, double height)
static java.awt.GradientPaint	makeYellowPaint(double width, double height)
static void	showErrorMessage(java.lang.String message, java.lang.Throwable e)
static void	showSimpleErrorMessage(java.lang.String message, java.lang.Throwable e)
static void	showVerySimpleErrorMessage(java.lang.String message)
static java.lang.String	text2DisplayHtml(java.lang.String text) Replaces the Yale specific tag elements by normal html tags.
static java.lang.String	text2SimpleHtml(java.lang.String text) Replaces the Yale specific tag elements by normal html tags.

Methods inherited from class java.lang.Object

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

Field Detail

TABLE_ROW_EXTRA_HEIGHT

public static final int TABLE_ROW_EXTRA_HEIGHT

Defines the extra height for each row in a table.

See Also:

Constant Field Values

DARK_YELLOW

public static final java.awt.Color DARK_YELLOW

Some color constants for Java Look and Feel.

LIGHT_YELLOW

public static final java.awt.Color LIGHT_YELLOW

Some color constants for Java Look and Feel.

LIGHTEST_YELLOW

public static final java.awt.Color LIGHTEST_YELLOW

Some color constants for Java Look and Feel.

DARK_BLUE

public static final java.awt.Color DARK_BLUE

Some color constants for Java Look and Feel.

LIGHT_BLUE

public static final java.awt.Color LIGHT_BLUE

Some color constants for Java Look and Feel.

LIGHTEST_BLUE

public static final java.awt.Color LIGHTEST_BLUE

Some color constants for Java Look and Feel.

Constructor Detail

SwingTools

public SwingTools()

Method Detail

makeBluePaint

public static java.awt.GradientPaint makeBluePaint(double width,
                                                   double height)

makeYellowPaint

public static java.awt.GradientPaint makeYellowPaint(double width,
                                                     double height)

showVerySimpleErrorMessage

public static void showVerySimpleErrorMessage(java.lang.String message)

showSimpleErrorMessage

public static void showSimpleErrorMessage(java.lang.String message,
                                          java.lang.Throwable e)

showErrorMessage

public static void showErrorMessage(java.lang.String message,
                                    java.lang.Throwable e)

chooseFile

public static java.io.File chooseFile(java.awt.Component parent,
                                      java.io.File file,
                                      boolean open,
                                      java.lang.String extension,
                                      java.lang.String extensionDescription)

Opens a file chooser with a reasonable start directory. If the extension is null, no file filters will be used.

chooseFile

public static java.io.File chooseFile(java.awt.Component parent,
                                      java.io.File file,
                                      boolean open,
                                      boolean onlyDirs,
                                      java.lang.String extension,
                                      java.lang.String extensionDescription)

Opens a file chooser with a reasonable start directory. If the extension is null, no file filters will be used. This method allows choosing directories.

chooseFile

private static java.io.File chooseFile(java.awt.Component parent,
                                       java.io.File file,
                                       boolean open,
                                       boolean onlyDirs,
                                       java.lang.String[] extensions,
                                       java.lang.String[] extensionDescriptions)

Returns the user selected file.

chooseFile

private static java.io.File chooseFile(java.awt.Component parent,
                                       java.io.File file,
                                       boolean open,
                                       boolean onlyDirs,
                                       javax.swing.filechooser.FileFilter[] fileFilters)

Opens a file chooser with a reasonable start directory. onlyDirs indidcates if only files or only can be selected.

Parameters:

file - The initially selected value of the file chooser dialog

open - Open or save dialog?

onlyDirs - Only allow directories to be selected

fileFilters - List of FileFilters to use

createFileChooser

public static javax.swing.JFileChooser createFileChooser(java.io.File file,
                                                         boolean onlyDirs,
                                                         javax.swing.filechooser.FileFilter[] fileFilters)

Creates file chooser with a reasonable start directory. You may use the following code snippet in order to retrieve the file:

        if (fileChooser.showOpenDialog(parent) == JFileChooser.APPROVE_OPTION)
            File selectedFile = fileChooser.getSelectedFile();
 

Usually, the method chooseFile(Component, File, boolean, boolean, FileFilter[]) or one of the convenience wrapper methods can be used to do this. This method is only useful if one is interested, e.g., in the selected file filter.

Parameters:

file - The initially selected value of the file chooser dialog

onlyDirs - Only allow directories to be selected

fileFilters - List of FileFilters to use

createTextPanel

public static javax.swing.JPanel createTextPanel(java.lang.String title,
                                                 java.lang.String text)

Creates a panel with title and text. The panel has a border layout and the text is placed into the NORTH section.

html2YaleText

public static java.lang.String html2YaleText(java.lang.String html)

Replaces simple html tags and quotes by Yale specific text elements. These can be used in XML files without confusing an XML parser.

text2DisplayHtml

public static java.lang.String text2DisplayHtml(java.lang.String text)

Replaces the Yale specific tag elements by normal html tags. Additionally the given text is embedded in an html and body tag with proper style sheet definitions.

text2SimpleHtml

public static java.lang.String text2SimpleHtml(java.lang.String text)

Replaces the Yale specific tag elements by normal html tags. This method does not embed the given text in a html tag.

getPointColor

public static java.awt.Color getPointColor(double value)

Returns a color equivalent to the value of value. The value has to be normalized between 0 and 1.

getPointColor

public static java.awt.Color getPointColor(double value,
                                           double max,
                                           double min)

Returns a color equivalent to the value of value. The value will be normalized between 0 and 1 using the parameters max and min. Which are the minimum and maximum of the complete dataset.