meka.gui.core

Class GUIHelper

java.lang.Object

meka.gui.core.GUIHelper

public class GUIHelper
extends java.lang.Object

A little helper class for GUI related stuff.

Version:

$Revision: 66 $

Author:

fracpete (fracpete at waikato dot ac dot nz)

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	EMPTY_ICON the empty icon name.
static java.lang.String	IMAGE_DIR the directory with the images.
static char	MNEMONIC_INDICATOR the mnemonic character indicator.

Constructor Summary

Constructors

Constructor and Description
GUIHelper()

Method Summary

Methods

Modifier and Type	Method and Description
static javax.swing.ImageIcon	getEmptyIcon() Returns the ImageIcon for the empty icon.
static javax.swing.ImageIcon	getExternalIcon(java.lang.String filename) Returns an ImageIcon from the given name.
static javax.swing.ImageIcon	getIcon(java.lang.Class cls) Returns an ImageIcon for the given class.
static javax.swing.ImageIcon	getIcon(java.lang.String name) Returns an ImageIcon from the given name.
static java.lang.String	getImageFilename(java.lang.String name) Adds the path of the images directory to the name of the image.
static javax.swing.ImageIcon	getLogoIcon() Returns an ImageIcon of the logo (icon sized image).
static javax.swing.ImageIcon	getLogoImage() Returns an ImageIcon of the logo (large image).
static char	getMnemonic(java.lang.String caption) Returns the mnemonic for this caption, preceded by an underscore "_".
static java.awt.Font	getMonospacedFont() Returns the system wide Monospaced font.
static java.lang.Object	getParent(java.awt.Container cont, java.lang.Class parentClass) Tries to determine the parent this panel is part of.
static java.awt.Dialog	getParentDialog(java.awt.Container cont) Tries to determine the dialog this panel is part of.
static java.awt.Frame	getParentFrame(java.awt.Container cont) Tries to determine the frame the container is part of.
static boolean	hasImageFile(java.lang.String name) Checks whether the image is available.

Methods inherited from class java.lang.Object

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

Field Detail

IMAGE_DIR

public static final java.lang.String IMAGE_DIR

the directory with the images.

See Also:

Constant Field Values

EMPTY_ICON

public static final java.lang.String EMPTY_ICON

the empty icon name.

See Also:

Constant Field Values

MNEMONIC_INDICATOR

public static final char MNEMONIC_INDICATOR

the mnemonic character indicator.

See Also:

Constant Field Values

Constructor Detail

GUIHelper

public GUIHelper()

Method Detail

hasImageFile

public static boolean hasImageFile(java.lang.String name)

Checks whether the image is available.

Parameters:

name - the name of the image (filename without path but with extension)

Returns:

true if image exists

getImageFilename

public static java.lang.String getImageFilename(java.lang.String name)

Adds the path of the images directory to the name of the image.

Parameters:

name - the name of the image to add the path to

Returns:

the full path of the image

getIcon

public static javax.swing.ImageIcon getIcon(java.lang.Class cls)

Returns an ImageIcon for the given class.

Parameters:

cls - the class to get the icon for (gif, png or jpg)

Returns:

the ImageIcon or null if none found

getIcon

public static javax.swing.ImageIcon getIcon(java.lang.String name)

Returns an ImageIcon from the given name.

Parameters:

name - the filename without path

Returns:

the ImageIcon or null if not available

getExternalIcon

public static javax.swing.ImageIcon getExternalIcon(java.lang.String filename)

Returns an ImageIcon from the given name.

Parameters:

filename - the filename

Returns:

the ImageIcon or null if not available

getEmptyIcon

public static javax.swing.ImageIcon getEmptyIcon()

Returns the ImageIcon for the empty icon.

Returns:

the ImageIcon

getLogoImage

public static javax.swing.ImageIcon getLogoImage()

Returns an ImageIcon of the logo (large image).

Returns:

the logo or null if none available

getLogoIcon

public static javax.swing.ImageIcon getLogoIcon()

Returns an ImageIcon of the logo (icon sized image).

Returns:

the logo or null if none available

getMonospacedFont

public static java.awt.Font getMonospacedFont()

Returns the system wide Monospaced font.

Returns:

the font

getParent

public static java.lang.Object getParent(java.awt.Container cont,
                         java.lang.Class parentClass)

Tries to determine the parent this panel is part of.

Parameters:

cont - the container to get the parent for

parentClass - the class of the parent to obtain

Returns:

the parent if one exists or null if not

getParentFrame

public static java.awt.Frame getParentFrame(java.awt.Container cont)

Tries to determine the frame the container is part of.

Parameters:

cont - the container to get the frame for

Returns:

the parent frame if one exists or null if not

getParentDialog

public static java.awt.Dialog getParentDialog(java.awt.Container cont)

Tries to determine the dialog this panel is part of.

Parameters:

cont - the container to get the dialog for

Returns:

the parent dialog if one exists or null if not

getMnemonic

public static char getMnemonic(java.lang.String caption)

Returns the mnemonic for this caption, preceded by an underscore "_".

Parameters:

caption - the caption to extract

Returns:

the extracted mnemonic, \0 if none available

See Also:

MNEMONIC_INDICATOR