GUIHelper (meka 1.9.1 API)

java.lang.Object
- meka.gui.core.GUIHelper

```
public class GUIHelper
extends Object
```
A little helper class for GUI related stuff.

Version:

$Revision$

Author:

fracpete (fracpete at waikato dot ac dot nz)

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`EMPTY_ICON` the empty icon name.
`static String`	`FILENAME` the name of the props file.
`static String`	`IMAGE_DIR` the directory with the images.
`protected static Properties`	`m_Properties` the properties.
`static char`	`MNEMONIC_INDICATOR` the mnemonic character indicator.

Constructor Summary

Constructors
Constructor and Description

GUIHelper()

Constructors
Constructor and Description
`GUIHelper()`

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static boolean`	`canPasteFromClipboard(DataFlavor flavor)` Checks whether the specified "flavor" can be obtained from the clipboard.
`static boolean`	`canPasteStringFromClipboard()` Checks whether a string can be obtained from the clipboard.
`static void`	`copyToClipboard(BufferedImage img)` Copies the given image to the system's clipboard.
`static void`	`copyToClipboard(String s)` Copies the given string to the system's clipboard.
`static void`	`copyToClipboard(Transferable t)` Copies the given transferable to the system's clipboard.
`static Dimension`	`getDefaultDimensions(String prefix, int defaultWidth, int defaultHeight)` Returns the default dimensions for this prefix.
`static Dimension`	`getDefaultFrameDimensions()` Returns the default frame dimensions.
`static Dimension`	`getDefaultFrameDimensions(Class cls)` Returns the default frame dimensions for this class.
`static String`	`getDefaultFrameIcon(Class cls)` Returns the default icon name for this frame class.
`static ImageIcon`	`getEmptyIcon()` Returns the ImageIcon for the empty icon.
`static ImageIcon`	`getExternalIcon(String filename)` Returns an ImageIcon from the given name.
`static ImageIcon`	`getIcon(Class cls)` Returns an ImageIcon for the given class.
`static ImageIcon`	`getIcon(String name)` Returns an ImageIcon from the given name.
`static String`	`getImageFilename(String name)` Adds the path of the images directory to the name of the image.
`static ImageIcon`	`getLogoIcon()` Returns an ImageIcon of the logo (icon sized image).
`static ImageIcon`	`getLogoImage()` Returns an ImageIcon of the logo (large image).
`static char`	`getMnemonic(String caption)` Returns the mnemonic for this caption, preceded by an underscore "_".
`static Font`	`getMonospacedFont()` Returns the system wide Monospaced font.
`static boolean`	`getPackFrame(Class cls)` Returns whether this application needs to be packed, rather than use a specific window size.
`static Object`	`getParent(Container cont, Class parentClass)` Tries to determine the parent this panel is part of.
`static Dialog`	`getParentDialog(Container cont)` Tries to determine the dialog this panel is part of.
`static Frame`	`getParentFrame(Container cont)` Tries to determine the frame the container is part of.
`static Properties`	`getProperties()` Initializes the properties if necessary.
`static boolean`	`hasImageFile(String name)` Checks whether the image is available.
`static boolean`	`hasMnemonic(String caption)` Checks the caption whether an underscore "_" is present to indicate that the following character is to act as mnemonic.
`static weka.gui.ConverterFileChooser`	`newConverterFileChooser()` Returns a new instance of a filechooser for datasets including the bookmarks panel.
`static MekaFileChooser`	`newFileChooser()` Returns a new instance of a filechooser including the bookmarks panel.
`static Object`	`pasteFromClipboard(DataFlavor flavor)` Obtains an object from the clipboard.
`static String`	`pasteStringFromClipboard()` Obtains a string from the clipboard.
`static String`	`stripMnemonic(String caption)` Removes the mnemonic indicator in this caption.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - FILENAME
```
public static final String FILENAME
```
    the name of the props file.
    
    See Also:
    
    Constant Field Values
  - IMAGE_DIR
```
public static final String IMAGE_DIR
```
    the directory with the images.
    
    See Also:
    
    Constant Field Values
  - EMPTY_ICON
```
public static final 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
  - m_Properties
```
protected static Properties m_Properties
```
    the properties.
- Constructor Detail
  - GUIHelper
```
public GUIHelper()
```
- Method Detail
  - hasImageFile
```
public static boolean hasImageFile(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 String getImageFilename(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 ImageIcon getIcon(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 ImageIcon getIcon(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 ImageIcon getExternalIcon(String filename)
```
    Returns an ImageIcon from the given name.
    
    Parameters:
    
    filename - the filename
    
    Returns:
    
    the ImageIcon or null if not available
  - getEmptyIcon
```
public static ImageIcon getEmptyIcon()
```
    Returns the ImageIcon for the empty icon.
    
    Returns:
    
    the ImageIcon
  - getLogoImage
```
public static ImageIcon getLogoImage()
```
    Returns an ImageIcon of the logo (large image).
    
    Returns:
    
    the logo or null if none available
  - getLogoIcon
```
public static ImageIcon getLogoIcon()
```
    Returns an ImageIcon of the logo (icon sized image).
    
    Returns:
    
    the logo or null if none available
  - getMonospacedFont
```
public static Font getMonospacedFont()
```
    Returns the system wide Monospaced font.
    
    Returns:
    
    the font
  - getParent
```
public static Object getParent(Container cont,
                               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 Frame getParentFrame(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 Dialog getParentDialog(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
  - hasMnemonic
```
public static boolean hasMnemonic(String caption)
```
    Checks the caption whether an underscore "_" is present to indicate that the following character is to act as mnemonic.
    
    Parameters:
    
    caption - the caption to analyze
    
    Returns:
    
    true if an underscore is present
    
    See Also:
    
    MNEMONIC_INDICATOR
  - getMnemonic
```
public static char getMnemonic(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
  - stripMnemonic
```
public static String stripMnemonic(String caption)
```
    Removes the mnemonic indicator in this caption.
    
    Parameters:
    
    caption - the caption to process
    
    Returns:
    
    the processed caption
    
    See Also:
    
    MNEMONIC_INDICATOR
  - getProperties
```
public static Properties getProperties()
```
    Initializes the properties if necessary.
  - copyToClipboard
```
public static void copyToClipboard(Transferable t)
```
    Copies the given transferable to the system's clipboard.
    
    Parameters:
    
    t - the transferable to copy
  - copyToClipboard
```
public static void copyToClipboard(String s)
```
    Copies the given string to the system's clipboard.
    
    Parameters:
    
    s - the string to copy
  - copyToClipboard
```
public static void copyToClipboard(BufferedImage img)
```
    Copies the given image to the system's clipboard.
    
    Parameters:
    
    img - the image to copy
  - canPasteFromClipboard
```
public static boolean canPasteFromClipboard(DataFlavor flavor)
```
    Checks whether the specified "flavor" can be obtained from the clipboard.
    
    Parameters:
    
    flavor - the type of data to look for
    
    Returns:
    
    true if the data can be obtained, false if not available
  - canPasteStringFromClipboard
```
public static boolean canPasteStringFromClipboard()
```
    Checks whether a string can be obtained from the clipboard.
    
    Returns:
    
    true if string can be obtained, false if not available
  - pasteFromClipboard
```
public static Object pasteFromClipboard(DataFlavor flavor)
```
    Obtains an object from the clipboard.
    
    Parameters:
    
    flavor - the type of object to obtain
    
    Returns:
    
    the obtained object, null if not available
  - pasteStringFromClipboard
```
public static String pasteStringFromClipboard()
```
    Obtains a string from the clipboard.
    
    Returns:
    
    the obtained string, null if not available
  - getDefaultFrameDimensions
```
public static Dimension getDefaultFrameDimensions()
```
    Returns the default frame dimensions.
    
    Returns:
    
    the dimensions
  - getDefaultFrameDimensions
```
public static Dimension getDefaultFrameDimensions(Class cls)
```
    Returns the default frame dimensions for this class.
    
    Parameters:
    
    cls - the class to get the default dimensions for
    
    Returns:
    
    the dimensions, default ones if not found
    
    See Also:
    
    getDefaultFrameDimensions()
  - getDefaultFrameIcon
```
public static String getDefaultFrameIcon(Class cls)
```
    Returns the default icon name for this frame class.
    
    Parameters:
    
    cls - the class to get the default icon name for
    
    Returns:
    
    the icon name, null if not found
  - getDefaultDimensions
```
public static Dimension getDefaultDimensions(String prefix,
                                             int defaultWidth,
                                             int defaultHeight)
```
    Returns the default dimensions for this prefix.
    
    Parameters:
    
    prefix - the prefix (+ .Height, .Width) to get the dimensions for
    
    defaultWidth - the default width
    
    defaultHeight - the default height
    
    Returns:
    
    the dimensions, default ones if not found
  - getPackFrame
```
public static boolean getPackFrame(Class cls)
```
    Returns whether this application needs to be packed, rather than use a specific window size.
    
    Returns:
    
    true if to be packed
  - newConverterFileChooser
```
public static weka.gui.ConverterFileChooser newConverterFileChooser()
```
    Returns a new instance of a filechooser for datasets including the bookmarks panel.
    
    Returns:
    
    the file chooser
  - newFileChooser
```
public static MekaFileChooser newFileChooser()
```
    Returns a new instance of a filechooser including the bookmarks panel.
    
    Returns:
    
    the file chooser

Class GUIHelper

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

FILENAME

IMAGE_DIR

EMPTY_ICON

MNEMONIC_INDICATOR

m_Properties

Constructor Detail

GUIHelper

Method Detail

hasImageFile

getImageFilename

getIcon

getIcon

getExternalIcon

getEmptyIcon

getLogoImage

getLogoIcon

getMonospacedFont

getParent

getParentFrame

getParentDialog

hasMnemonic

getMnemonic

stripMnemonic

getProperties

copyToClipboard

copyToClipboard

copyToClipboard

canPasteFromClipboard

canPasteStringFromClipboard

pasteFromClipboard

pasteStringFromClipboard

getDefaultFrameDimensions

getDefaultFrameDimensions

getDefaultFrameIcon

getDefaultDimensions

getPackFrame

newConverterFileChooser

newFileChooser