com.lf.commons.gui

Class GUIUtils

java.lang.Object

com.lf.commons.gui.GUIUtils

public class GUIUtils
extends java.lang.Object

Some multipurpose utility methods for handling AWT/Swing GUIs.

Since:

1.5

Version:

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

Author:

Axel Schwolow

Field Summary

Fields

Modifier and Type	Field and Description
static java.awt.Color	COLOR_LF_BLUE Represents the Leisenfels blue.
static java.awt.Color	COLOR_LF_GREEN Represents the Leisenfels green.
static java.net.URL	COMBO_BOX_ICON_EMPTY Default combo box icon if not available.
static java.awt.datatransfer.DataFlavor	javaURLListFlavor Used for URL adresses deposited on the system's clipboard.

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
static void	addClipboardPopupMenu(java.awt.Component comp, ContentGetter getter) Creates a popup menu for component to copy text contents to clipboard.
static void	addGlobalAccelerators(javax.swing.JDialog dialog, javax.swing.JMenuItem[] items) Installs keyboard actions based on a main window menu items.
static void	addGlobalAccelerators(javax.swing.JFrame frame, javax.swing.JMenuItem[] items) Installs keyboard actions based on a main window menu items.
static void	addPopupMenu(java.awt.Component target, javax.swing.JPopupMenu menu) Creates a popup menu for a target component to show up automatically.
static javax.swing.JCheckBoxMenuItem	addViewMenuItem(javax.swing.JMenu menu, java.awt.Component comp, java.lang.String name) Creates a "View" menu item to make main window components visible/invisible.
static int	addXMLNode(javax.swing.tree.DefaultMutableTreeNode parent, org.jdom.Element element, int nodecount, boolean setelement, java.lang.String includeregex) Recursive method to add new DefaultMutableTreeNode for the given XML element.
static void	adjustColumnWidths(javax.swing.JTable table, int margin) Aligns the given table columns (set preferred widths to the maximum).
static void	alignHorizontally(AlignmentDef[] defs) Auto-aligns multiple panels with TableLayout vertically.
static void	alignHorizontally(java.awt.Component... comps) Aligns the given components (set preferred widths to the maximum).
static boolean	checkEmptyTextField(javax.swing.JTextField field) Checks if the given text field is empty and sets the background color appropriately.
static void	clearClipboard(java.awt.datatransfer.Clipboard clipboard) Removes all data from the given clipboard.
static void	clearMenuSeparators(javax.swing.JMenu menu) Removes redundant menu separators.
static void	collectAllChildren(java.util.Vector<javax.swing.tree.DefaultMutableTreeNode> container, javax.swing.tree.DefaultMutableTreeNode node) Collects all children of the specified node.
static void	collectAllExpandedChildren(java.util.Vector<javax.swing.tree.DefaultMutableTreeNode> container, javax.swing.tree.DefaultMutableTreeNode node, javax.swing.JTree tree) Collects all children of the specified node being currently expanded.
static boolean	containsItem(javax.swing.JComboBox box, java.lang.Object item) Determines whether the combo box already holds the specified item.
static void	copyToClipboard(java.io.File[] files) Copies the files to the system clipboard for other applications to use.
static void	copyToClipboard(org.apache.commons.vfs2.FileObject[] urls) Copies the URLs to the system clipboard for other applications to use.
static void	copyToClipboard(java.lang.String text) Copies the text to the system clipboard for other applications to use.
static java.awt.image.BufferedImage	createColorImage(int width, int height, java.awt.Color color) Creates a new image with specific background color and size.
static java.util.Vector<SuffixFilter>	createImageWriterSuffixFilters() Creates the supported image file suffices for writing.
static void	debugAWTEventType(java.awt.AWTEvent event) Prints info about the type of the given event.
static void	debugInputMap(javax.swing.JComponent comp) Prints info about the input map installed for the given component.
static void	editFile(java.io.File target, java.awt.Component comp, StatusBar statusbar) Let the system edit a file.
static void	editTemporaryFile(java.io.File tempdir, java.io.InputStream istream, java.awt.Component comp, boolean deleteonexit, java.lang.String suffix) Let the system open a file which is created temporarily from the given data stream.
static void	editURL(org.apache.commons.vfs2.FileObject target, java.awt.Component comp, StatusBar statusbar) Let the system edit a URL.
static void	enableToolBarLabels(javax.swing.JToolBar toolbar, boolean enable) Enables or disables the labels shown by the LabeledPanel instances of the toolbar.
static void	executeByEDT(java.lang.Runnable runner) Makes sure that the given code is executed by the EDT.
static java.lang.Thread	executeByThread(java.lang.Runnable runner) Makes sure that the given code is executed by a separate thread (not the EDT).
static void	expandAllNodes(javax.swing.JTree tree, javax.swing.tree.DefaultMutableTreeNode node) Causes the given node and it's childs to expand.
static java.lang.Thread	findEventDispatchThread() Searches for the current event dispatch thread.
static void	getAllComponents(java.awt.Component comp, java.util.Vector<java.awt.Component> collector, java.lang.String type) Determines the children of the given GUI component and collects them recursively.
static java.awt.image.BufferedImage	getBufferedImage(javax.swing.ImageIcon icon) Convenience to convert an ImageIcon into a BufferedImage.
static int	getColumnWidth(info.clearthought.layout.TableLayout layout, int column) Provides the width of the column in pixels for a TableLayout.
static java.util.Hashtable<java.lang.Integer,java.lang.Integer>	getColumnWidths(javax.swing.JTable table) Remembers the current column widths to be restored.
static java.lang.String	getComboBoxIconText(java.lang.String text, javax.swing.ImageIcon icon) Converts the given combo box text so that the given icon is also displayed (HTML code).
static int	getComponentIndex(java.awt.Container container, java.awt.Component comp) Determines the component's index within the container.
static javax.swing.ImageIcon	getGrayscaleIcon(javax.swing.ImageIcon icon) Provides the image as grayscale variant.
static java.lang.String	getHTMLColor(java.awt.Color color) Converts the Java color to a HTML compatible string representation.
static byte[]	getIconData(javax.swing.ImageIcon icon, java.lang.String format) Gets the binary data of an icon image in the desired format.
static long	getIconFileSize(javax.swing.ImageIcon icon) Provides the length of the icon file in bytes.
static javax.swing.ImageIcon	getIconVariant(javax.swing.ImageIcon icon, int newsize) Provides the image in a different size.
static byte[]	getImageData(java.awt.image.BufferedImage image, java.lang.String format) Gets the binary data of an image in the desired format.
static javax.swing.JPopupMenu	getPopupMenu(javax.swing.JMenuItem item) Recurses the parent containers as long as the popup component is found.
static java.awt.Image	getScaledInstance(java.awt.Image image, java.awt.Component observer, int shrink) Returns a scaled instance of the desired image.
static java.awt.Image	getScaledInstance(java.awt.Image image, java.awt.Component observer, int maxwidth, int maxheight) Returns a scaled instance of the desired image.
static java.awt.Component[]	getTabComponents(javax.swing.JTabbedPane tabbedPane) Returns the tab components if available.
static javax.swing.AbstractButton	getToolBarButton(javax.swing.JToolBar toolbar, java.lang.String actioncommand) Determines the tool bar button if one is associated with the menu items via action command.
static LabeledPanel	getToolBarButtonPanel(javax.swing.JToolBar toolbar, java.lang.String actioncommand) Determines the tool bar button panel if one is associated with the menu items via action command.
static boolean	hasTabComponent(javax.swing.JTabbedPane tabbedPane, java.awt.Component comp) Returns the tab components if available.
static int	indexOf(javax.swing.JMenu menu, javax.swing.JMenuItem item, int fallback) Determines the index of the given menu item within the given menu.
static void	installActionListeners(javax.swing.JCheckBox comp, java.awt.event.ActionListener[] listeners) Installs the ActionListeners.
static void	installChangeListeners(javax.swing.JCheckBox comp, javax.swing.event.ChangeListener[] listeners) Installs the ChangeListeners.
static void	installEnterListener(javax.swing.text.JTextComponent field, javax.swing.AbstractButton button) Installs a KeyListener listening for ENTER/RETURN hits to click a button.
static void	installEnterListener(javax.swing.text.JTextComponent field, java.lang.Runnable runner) Installs a KeyListener listening for ENTER/RETURN hits to execute some code.
static java.awt.event.FocusListener	installFocusClearListener(javax.swing.text.JTextComponent field) Installs a FocusListener to clear the text field if the user starts working.
static java.awt.event.FocusListener	installFocusSelectionListener(javax.swing.text.JTextComponent field) Installs a FocusListener detecting when the focus is gained and selects the text.
static void	installGroupPopup(java.util.Vector boxes) Creates popup menues for check boxes that auto-selects all or none of the boxes.
static java.awt.event.FocusListener	installHintListener(javax.swing.text.JTextComponent field, java.lang.String text) Shows a certain text and stops displaying it when the text field gets the focus.
static void	installResolutionMenuItems(javax.swing.JMenu menu, javax.swing.JFrame window) Creates the default menu items for main window resolutions.
static Configuration	installTextAreaPopup(javax.swing.JTextArea textarea, boolean autoscroll, boolean autoscrollenabled, boolean clearenabled, boolean copyenabled) Creates a popup menu for a text area with default items.
static void	installToolBarMenu(javax.swing.JMenu menu, javax.swing.JToolBar toolbar, boolean separators) Creates a menu for a toolbar with buttons including the enabled state.
static void	installToolBarPopup(javax.swing.JPopupMenu popupmenu, javax.swing.JToolBar toolbar, boolean separators) Creates a popup menu for a toolbar with buttons including the enabled state.
static javax.swing.JPopupMenu	installToolBarPopup(javax.swing.JToolBar toolbar, javax.swing.JMenuItem toolbaritem, javax.swing.JMenuItem labelsitem, boolean labeled) Installs the default toolbar popup to show/hide the component, the labels etc.
static java.awt.event.HierarchyBoundsListener	installWindowResizeListener(StatusBar statusbar, javax.swing.JDialog dialog) Installs listener to display the current window/dialog size when resized.
static java.awt.event.HierarchyBoundsListener	installWindowResizeListener(StatusBar statusbar, javax.swing.JFrame frame) Installs listener to display the current window/dialog size when resized.
static boolean	isChildOf(java.awt.Component comp, java.awt.Container container) Determines whether the given component is a child of the parent.
static boolean	isClipboardLoaded(java.awt.datatransfer.Clipboard clipboard) Determines whether the given clipboard is currently loaded.
static boolean	isEventDispatchThread(java.lang.Thread thread) Determines whether the given thread is the event dispatch thread or not.
static boolean	isScrollable(java.awt.Component comp) Checks the given component if any sub-component (if any) is a JScrollPane.
static javax.swing.ImageIcon	loadImage(byte[] data) Tries to load an Image object from a raw data array.
static javax.swing.ImageIcon	loadImage(java.io.InputStream istream) Tries to load an Image object from a raw data stream.
static javax.swing.ImageIcon	loadImage(java.lang.String url) Tries to load an Image object from a specified URL.
static javax.swing.ImageIcon	loadImage(java.net.URL url) Tries to load an Image object from a specified URL.
static javax.swing.ImageIcon	loadImageVFS(org.apache.commons.vfs2.FileObject target) Tries to load an Image object from a specified VFS URL.
static void	makeComponentVisible(java.awt.Component comp) Scroll automatically the viewport for the given component.
static void	makeRowVisible(javax.swing.JTable table, int row) Scroll automatically the viewport to the desired row.
static java.lang.String	mapFilterIDToImageMIME(java.lang.String filterid) Maps the image format identifiers from ModelDelegate to MIME types.
static java.lang.String	mapFilterIDToImageSuffix(java.lang.String filterid) Maps the image format identifiers from ModelDelegate to writer formats.
static java.lang.String	mapFromImageType(int type) Maps the given numerical image type to the corresponding text representation.
static java.lang.String	mapFromSwingConstant(int constant) Maps the given numerical constant to the corresponding text representation.
static java.lang.String	mapFromTransparency(int type) Maps the given numerical image type to the corresponding text representation.
static void	openFile(java.io.File target, java.awt.Component comp, StatusBar statusbar) Let the system open a file.
static void	openTemporaryFile(java.io.File tempdir, java.io.InputStream istream, java.awt.Component comp, boolean deleteonexit, java.lang.String suffix) Let the system open a file which is created temporarily from the given data stream.
static void	openURL(org.apache.commons.vfs2.FileObject target, java.awt.Component comp, StatusBar statusbar) Let the system open a URL.
static int	populateTreeFromXML(javax.swing.tree.DefaultMutableTreeNode root, boolean setelement, java.lang.String includeregex, org.jdom.Element... elements) Assembles a JTree from the given XML data.
static int	removeAllChildrenRecursively(javax.swing.tree.DefaultMutableTreeNode node) Removes all child nodes from the given node by removing each single node from its parent.
static boolean	replaceItem(javax.swing.JComboBox box, java.lang.Object olditem, java.lang.Object newitem) Determines whether the combo box already holds the specified item.
static java.awt.image.BufferedImage	rotate270(java.awt.image.BufferedImage image) Rotates the given image 270 degrees counter wise.
static java.awt.image.BufferedImage	rotate90(java.awt.image.BufferedImage image) Rotates the given image 90 degrees counter wise.
static void	setButtonGroup(javax.swing.JCheckBox... boxes) Implements mutual exclusion for the given JCheckBoxes.
static void	setEnabledAllComponents(java.awt.Container parent, boolean enable) Enables/disables the components of this given container.
static void	setEnabledAllComponents(java.awt.Container parent, boolean enable, java.lang.Class[] excludes) Enables/disables the components of this given container.
static void	setHeadlessMode(boolean value, boolean force) Sets/overwrite the headless parameter of this JVM.
static void	setNumericOnly(javax.swing.JTextField field, boolean beep) Configures a text field so that only numbers can be typed.
static void	setSelectedValues(javax.swing.JList list, java.util.Vector data, java.lang.Object[] selection) Compensates the lack of the JList.setSelectedValues() method.
static void	setShowErrorColors(javax.swing.JEditorPane editor, boolean error) Sets the default error colors for a text editor.
static void	setShowErrorColors(javax.swing.JTextArea textarea, boolean error) Sets the default error colors for a text editor.
static void	setShowErrorColors(javax.swing.JTextField field, boolean error) Sets the default error colors for a text field.
static java.awt.event.ItemListener	syncComponentsEnable(javax.swing.JCheckBox master, java.awt.Component... slaves) Enables/disables components depending on a check box state.
static java.awt.event.ItemListener	syncComponentsEnable(javax.swing.JRadioButton master, java.awt.Component... slaves) Enables/disables components depending on a radio button state.
static java.beans.PropertyChangeListener	syncCompsEnable(java.awt.Component master, java.awt.Component slave) Synchronizes the enabled state of two components.
static void	syncTableGroup(javax.swing.JTable[] tables) Synchronizes a group of table instances (column widths).
static void	syncToggleButtonGroup(javax.swing.JToggleButton[] buttons) Synchronizes a group of toggle buttons.
static java.awt.event.ActionListener[]	uninstallActionListeners(javax.swing.JCheckBox comp) Uninstalls the ActionListeners and provides them for re-install.
static javax.swing.event.ChangeListener[]	uninstallChangeListeners(javax.swing.JCheckBox comp) Uninstalls the ChangeListeners and provides them for re-install.
static void	uninstallWindowResizeListener(javax.swing.JDialog dialog, java.awt.event.HierarchyBoundsListener listener) Uninstalls listener to display the current window/dialog size when resized.
static java.lang.String	wrapButtonText(java.lang.String rawtext, int lines) Wraps the given text to be displayed at the bottom of a JButton.

Methods inherited from class java.lang.Object

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

Field Detail

COLOR_LF_GREEN

public static final java.awt.Color COLOR_LF_GREEN

Represents the Leisenfels green.

COLOR_LF_BLUE

public static final java.awt.Color COLOR_LF_BLUE

Represents the Leisenfels blue.

COMBO_BOX_ICON_EMPTY

public static final java.net.URL COMBO_BOX_ICON_EMPTY

Default combo box icon if not available.

javaURLListFlavor

public static final java.awt.datatransfer.DataFlavor javaURLListFlavor

Used for URL adresses deposited on the system's clipboard.

Constructor Detail

GUIUtils

public GUIUtils()
         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

getAllComponents

public static void getAllComponents(java.awt.Component comp,
                    java.util.Vector<java.awt.Component> collector,
                    java.lang.String type)

Determines the children of the given GUI component and collects them recursively.

If type is null, all components are collected.

Parameters:

comp - The AWT component to search

collector - The container to fill with results

type - Filtering class name, others are rejected

Throws:

java.lang.NullPointerException - If a parameter is null

Since:

1.5

getTabComponents

public static java.awt.Component[] getTabComponents(javax.swing.JTabbedPane tabbedPane)

Returns the tab components if available.

Parameters:

tabbedPane - The tabbed pane

Returns:

The tab components, may have zero-length

Since:

1.5

hasTabComponent

public static boolean hasTabComponent(javax.swing.JTabbedPane tabbedPane,
                      java.awt.Component comp)

Returns the tab components if available.

Parameters:

tabbedPane - The tabbed pane

comp - The desired component

Returns:

Component does exist?

Since:

1.6

getScaledInstance

public static java.awt.Image getScaledInstance(java.awt.Image image,
                               java.awt.Component observer,
                               int maxwidth,
                               int maxheight)

Returns a scaled instance of the desired image.

Errors are reported with null return value. The result image does NOT exceed the maximum width or height. The method always scales it down with the correct ratio so that the width and height relation of the original image is kept. The default scaling method is SMOOTH.

Parameters:

image - The image to be scaled

observer - The component for the context

maxwidth - Desired width of the scaled instance

maxheight - Desired height of the scaled instance

Returns:

Scaled image

Since:

1.5

getScaledInstance

public static java.awt.Image getScaledInstance(java.awt.Image image,
                               java.awt.Component observer,
                               int shrink)

Returns a scaled instance of the desired image.

Errors are reported with null return value. The method always scales it down with the correct ratio so that the width and height relation of the original image is kept. The default scaling method is SMOOTH.

Parameters:

image - The image to be scaled

observer - The component for the context

shrink - Desired shrink factor between 1 and 100%

Returns:

Scaled image

Throws:

java.lang.IllegalArgumentException - If parameters are invalid

Since:

1.5

loadImage

public static javax.swing.ImageIcon loadImage(java.lang.String url)

Tries to load an Image object from a specified URL.

Parameters:

url - The location to load as an image

Returns:

The image or null if an error occurs

Since:

1.5

See Also:

loadImage(URL), loadImageVFS(FileObject)

loadImage

public static javax.swing.ImageIcon loadImage(java.net.URL url)

Tries to load an Image object from a specified URL.

This method directly loads the data without any caching. Perhaps you like to use the new ImageFactory functionality in order to increase performance.

Parameters:

url - The location to load as an image

Returns:

The image or null if an error occurs

Since:

1.5

See Also:

loadImage(String), loadImageVFS(FileObject), ImageFactory

loadImageVFS

public static javax.swing.ImageIcon loadImageVFS(org.apache.commons.vfs2.FileObject target)

Tries to load an Image object from a specified VFS URL.

This method directly loads the data without any caching. Perhaps you like to use the new ImageFactory functionality in order to increase performance.

Parameters:

target - The VFS file to load as an image

Returns:

The image or null if an error occurs

Since:

1.5

See Also:

loadImage(String), loadImage(URL)

loadImage

public static javax.swing.ImageIcon loadImage(byte[] data)

Tries to load an Image object from a raw data array.

This method directly loads the data without any caching. Perhaps you like to use the new ImageFactory functionality in order to increase performance.

Parameters:

data - The raw data to load as an image

Returns:

The image or null if an error occurs

Since:

1.6

See Also:

loadImage(String), loadImage(URL)

loadImage

public static javax.swing.ImageIcon loadImage(java.io.InputStream istream)

Tries to load an Image object from a raw data stream.

This method directly loads the data without any caching. Perhaps you like to use the new ImageFactory functionality in order to increase performance.

Parameters:

istream - The stream to load as an image

Returns:

The image or null if an error occurs

Since:

1.6

See Also:

loadImage(String), loadImage(URL)

createImageWriterSuffixFilters

public static java.util.Vector<SuffixFilter> createImageWriterSuffixFilters()

Creates the supported image file suffices for writing.

Returns:

The container with suffix filters, empty if an error occurs

Since:

1.5

mapFilterIDToImageSuffix

public static java.lang.String mapFilterIDToImageSuffix(java.lang.String filterid)

Maps the image format identifiers from ModelDelegate to writer formats.

Parameters:

filterid - The identifier

Returns:

The format like "png", null otherwise

Since:

1.6

mapFilterIDToImageMIME

public static java.lang.String mapFilterIDToImageMIME(java.lang.String filterid)

Maps the image format identifiers from ModelDelegate to MIME types.

Parameters:

filterid - The identifier

Returns:

The MIME type like "image/png", null otherwise

Since:

1.6

rotate90

public static java.awt.image.BufferedImage rotate90(java.awt.image.BufferedImage image)

Rotates the given image 90 degrees counter wise.

Parameters:

image - The image to be rotated

Returns:

The rotation result

Since:

1.5

rotate270

public static java.awt.image.BufferedImage rotate270(java.awt.image.BufferedImage image)

Rotates the given image 270 degrees counter wise.

Parameters:

image - The image to be rotated

Returns:

The rotation result

Since:

1.5

getPopupMenu

public static javax.swing.JPopupMenu getPopupMenu(javax.swing.JMenuItem item)

Recurses the parent containers as long as the popup component is found.

Parameters:

item - The item where the recursion starts

Returns:

The popup menu, may be null

Since:

1.5

getComponentIndex

public static int getComponentIndex(java.awt.Container container,
                    java.awt.Component comp)

Determines the component's index within the container.

Parameters:

container - The container with components

comp - The desired component

Returns:

Index of the component, else -1

Since:

1.5

addViewMenuItem

public static javax.swing.JCheckBoxMenuItem addViewMenuItem(javax.swing.JMenu menu,
                                            java.awt.Component comp,
                                            java.lang.String name)

Creates a "View" menu item to make main window components visible/invisible.

Parameters:

menu - The target menu to add the item

comp - The desired component

name - The menu item name

Returns:

The created menu item for updates

Throws:

java.lang.NullPointerException - Error case

Since:

1.5

expandAllNodes

public static void expandAllNodes(javax.swing.JTree tree,
                  javax.swing.tree.DefaultMutableTreeNode node)

Causes the given node and it's childs to expand.

Parameters:

tree - The tree the node belongs to

node - The starting point for expansion

Since:

1.5

collectAllChildren

public static void collectAllChildren(java.util.Vector<javax.swing.tree.DefaultMutableTreeNode> container,
                      javax.swing.tree.DefaultMutableTreeNode node)

Collects all children of the specified node.

The given root node is added, too, so please remember to remove it if it is necessary!

Parameters:

container - Cache for the nodes

node - The starting point for te search

containsItem

public static boolean containsItem(javax.swing.JComboBox box,
                   java.lang.Object item)

Determines whether the combo box already holds the specified item.

Parameters:

box - The combo box to be searched

item - The item object

Returns:

Item does already exist?

Since:

1.5

replaceItem

public static boolean replaceItem(javax.swing.JComboBox box,
                  java.lang.Object olditem,
                  java.lang.Object newitem)

Determines whether the combo box already holds the specified item.

Parameters:

box - The combo box to be searched

olditem - The existing item object

newitem - The replacement

Returns:

Item does already exist?

Since:

1.5

collectAllExpandedChildren

public static void collectAllExpandedChildren(java.util.Vector<javax.swing.tree.DefaultMutableTreeNode> container,
                              javax.swing.tree.DefaultMutableTreeNode node,
                              javax.swing.JTree tree)

Collects all children of the specified node being currently expanded.

Parameters:

container - Cache for the expanded nodes

node - The starting point for the search

tree - The analyzed tree

removeAllChildrenRecursively

public static int removeAllChildrenRecursively(javax.swing.tree.DefaultMutableTreeNode node)

Removes all child nodes from the given node by removing each single node from its parent.

Parameters:

node - The starting point for the removal

Returns:

Number of removed nodes

isChildOf

public static boolean isChildOf(java.awt.Component comp,
                java.awt.Container container)

Determines whether the given component is a child of the parent.

Parameters:

comp - The assumed child component

container - The parental container

Returns:

Is it a child?

Throws:

java.lang.NullPointerException - Error case

Since:

1.5

getToolBarButton

public static javax.swing.AbstractButton getToolBarButton(javax.swing.JToolBar toolbar,
                                          java.lang.String actioncommand)

Determines the tool bar button if one is associated with the menu items via action command.

Parameters:

toolbar - The container to search for buttons

actioncommand - The action command, or null if not available

Returns:

The button

Since:

1.5

getToolBarButtonPanel

public static LabeledPanel getToolBarButtonPanel(javax.swing.JToolBar toolbar,
                                 java.lang.String actioncommand)

Determines the tool bar button panel if one is associated with the menu items via action command.

Parameters:

toolbar - The container to search for buttons

actioncommand - The action command, or null if not available

Returns:

The labeled panel

Since:

1.6

enableToolBarLabels

public static void enableToolBarLabels(javax.swing.JToolBar toolbar,
                       boolean enable)

Enables or disables the labels shown by the LabeledPanel instances of the toolbar.

Parameters:

toolbar - The container to search for buttons

enable - The new state

Since:

1.6

setNumericOnly

public static void setNumericOnly(javax.swing.JTextField field,
                  boolean beep)

Configures a text field so that only numbers can be typed.

Parameters:

field - The text field

beep - Give acoustic feedback if non-digit is typed

Since:

1.5

addPopupMenu

public static void addPopupMenu(java.awt.Component target,
                javax.swing.JPopupMenu menu)

Creates a popup menu for a target component to show up automatically.

Parameters:

target - The component

menu - The menu to show

Since:

1.5

openFile

public static void openFile(java.io.File target,
            java.awt.Component comp,
            StatusBar statusbar)

Let the system open a file.

If the component is set then the wait cursor is displayed while the file is opened and later restored.

Parameters:

target - The target file to be opened

comp - The component to set the cursor

statusbar - The status bar for message (optional)

Since:

1.6

openURL

public static void openURL(org.apache.commons.vfs2.FileObject target,
           java.awt.Component comp,
           StatusBar statusbar)

Let the system open a URL.

If the component is set then the wait cursor is displayed while the entry is opened and later restored.

Parameters:

target - The target entry to be opened

comp - The component to set the cursor

statusbar - The status bar for message (optional)

Since:

1.6

openTemporaryFile

public static void openTemporaryFile(java.io.File tempdir,
                     java.io.InputStream istream,
                     java.awt.Component comp,
                     boolean deleteonexit,
                     java.lang.String suffix)

Let the system open a file which is created temporarily from the given data stream.

If the component is set then the wait cursor is displayed while the file is opened and later restored.

Parameters:

tempdir - The temporary directory

istream - The data stream

comp - The component to set the cursor

deleteonexit - Delete if application terminates?

suffix - The optional file extension e.g. ".png"

Since:

1.6

editTemporaryFile

public static void editTemporaryFile(java.io.File tempdir,
                     java.io.InputStream istream,
                     java.awt.Component comp,
                     boolean deleteonexit,
                     java.lang.String suffix)

Let the system open a file which is created temporarily from the given data stream.

If the component is set then the wait cursor is displayed while the file is opened and later restored.

Parameters:

tempdir - The temporary directory

istream - The data stream

comp - The component to set the cursor

deleteonexit - Delete if application terminates?

suffix - The optional file extension e.g. ".png"

Since:

1.6

editFile

public static void editFile(java.io.File target,
            java.awt.Component comp,
            StatusBar statusbar)

Let the system edit a file.

If the component is set then the wait cursor is displayed while the file is opened and later restored.

Parameters:

target - The target file to be opened

comp - The component to set the cursor

statusbar - The status bar for message (optional)

Since:

1.6

editURL

public static void editURL(org.apache.commons.vfs2.FileObject target,
           java.awt.Component comp,
           StatusBar statusbar)

Let the system edit a URL.

If the component is set then the wait cursor is displayed while the entry is opened and later restored.

Parameters:

target - The target entry to be opened

comp - The component to set the cursor

statusbar - The status bar for message (optional)

Since:

1.6

isEventDispatchThread

public static boolean isEventDispatchThread(java.lang.Thread thread)

Determines whether the given thread is the event dispatch thread or not.

Parameters:

thread - The thread to be checked

Returns:

Is it the EDT?

Since:

1.6

findEventDispatchThread

public static java.lang.Thread findEventDispatchThread()

Searches for the current event dispatch thread.

Returns:

The eevent dispatch thread, may be null

Since:

1.6

createColorImage

public static java.awt.image.BufferedImage createColorImage(int width,
                                            int height,
                                            java.awt.Color color)

Creates a new image with specific background color and size.

Parameters:

width - Desired image width

height - Desired image height

color - Background color of the image

Returns:

New image or null if an error occurred

makeRowVisible

public static void makeRowVisible(javax.swing.JTable table,
                  int row)

Scroll automatically the viewport to the desired row.

Found the tip here: http://forums.sun.com/thread.jspa?threadID=5349058&tstart=0

Parameters:

table - Target table

row - Desired row index

installGroupPopup

public static void installGroupPopup(java.util.Vector boxes)

Creates popup menues for check boxes that auto-selects all or none of the boxes.

Parameters:

boxes - The check boxes

Since:

1.5

alignHorizontally

public static void alignHorizontally(java.awt.Component... comps)

Aligns the given components (set preferred widths to the maximum).

Parameters:

comps - The components to align

Throws:

java.lang.NullPointerException - Error case

Since:

1.6

getHTMLColor

public static java.lang.String getHTMLColor(java.awt.Color color)

Converts the Java color to a HTML compatible string representation.

Parameters:

color - The Java color

Returns:

HTML value like "#DFF525" which is Leisenfels green :-)

Throws:

java.lang.NullPointerException - Error case

Since:

1.6

adjustColumnWidths

public static void adjustColumnWidths(javax.swing.JTable table,
                      int margin)

Aligns the given table columns (set preferred widths to the maximum).

Parameters:

table - The table component to get renderers etc.

margin - Optional margin width in pixels

Throws:

java.lang.NullPointerException - If the parameters are null

java.lang.IllegalArgumentException - If parameters are invalid

Since:

1.6

installToolBarPopup

public static void installToolBarPopup(javax.swing.JPopupMenu popupmenu,
                       javax.swing.JToolBar toolbar,
                       boolean separators)

Creates a popup menu for a toolbar with buttons including the enabled state.

The popup text is read via the getName() method. The separators are created if desired. The action command is set for the menu items to identify mouse clicks.

Parameters:

popupmenu - The popup menu to be filled

toolbar - The button container

separators - Synchronize separators?

Throws:

java.lang.NullPointerException - If the parameters are null

Since:

1.6

installToolBarMenu

public static void installToolBarMenu(javax.swing.JMenu menu,
                      javax.swing.JToolBar toolbar,
                      boolean separators)

Creates a menu for a toolbar with buttons including the enabled state.

The menu item text is read via the getName() method. The separators are created if desired. The action command is set for the menu items to identify mouse clicks.

Parameters:

menu - The menu to be filled

toolbar - The button container

separators - Synchronize separators?

Throws:

java.lang.NullPointerException - If the parameters are null

Since:

1.6

getColumnWidths

public static java.util.Hashtable<java.lang.Integer,java.lang.Integer> getColumnWidths(javax.swing.JTable table)

Remembers the current column widths to be restored.

Parameters:

table - The table component to get renderers etc.

Returns:

Cache with key = column index and value = width

Throws:

java.lang.NullPointerException - If the parameters are null

Since:

1.6

setEnabledAllComponents

public static void setEnabledAllComponents(java.awt.Container parent,
                           boolean enable)

Enables/disables the components of this given container.

Parameters:

parent - The parental container

enable - New component state

Since:

1.5

setEnabledAllComponents

public static void setEnabledAllComponents(java.awt.Container parent,
                           boolean enable,
                           java.lang.Class[] excludes)

Enables/disables the components of this given container.

Parameters:

parent - The parental container

enable - New component state

excludes - List of classes to be excluded e.g. labels (optional)

Since:

1.6

getColumnWidth

public static int getColumnWidth(info.clearthought.layout.TableLayout layout,
                 int column)

Provides the width of the column in pixels for a TableLayout.

Parameters:

layout - The layout manager

column - Index of desired column

Returns:

The column size in pixels

Throws:

java.lang.NullPointerException - If the parameters are null

java.lang.IllegalArgumentException - If parameters are invalid

Since:

1.6

alignHorizontally

public static void alignHorizontally(AlignmentDef[] defs)

Auto-aligns multiple panels with TableLayout vertically.

This method allows for proper alignment of separate panels which are grouped together within a container in multiple rows. Simply specify the layout, the column to be aligned and the column to be resized (normally a column holding a label or with no content at all).

Parameters:

defs - The alignment definitions

Since:

1.6

syncCompsEnable

public static java.beans.PropertyChangeListener syncCompsEnable(java.awt.Component master,
                                                java.awt.Component slave)

Synchronizes the enabled state of two components.

Parameters:

master - The component to get the enabled state from

slave - The component to set the enabled state

Returns:

The property change listener that has been added

Since:

1.5

installEnterListener

public static void installEnterListener(javax.swing.text.JTextComponent field,
                        javax.swing.AbstractButton button)

Installs a KeyListener listening for ENTER/RETURN hits to click a button.

Parameters:

field - The input field to listen for ENTER/RETURN

button - The button to click

Throws:

java.lang.NullPointerException - If the parameters are null

Since:

1.6

installEnterListener

public static void installEnterListener(javax.swing.text.JTextComponent field,
                        java.lang.Runnable runner)

Installs a KeyListener listening for ENTER/RETURN hits to execute some code.

Parameters:

field - The input field to listen for ENTER/RETURN

runner - The code to be executed

Throws:

java.lang.NullPointerException - If the parameters are null

Since:

1.6

installFocusSelectionListener

public static java.awt.event.FocusListener installFocusSelectionListener(javax.swing.text.JTextComponent field)

Installs a FocusListener detecting when the focus is gained and selects the text.

Parameters:

field - The input field to be observed

Returns:

The listener

Throws:

java.lang.NullPointerException - If the parameters are null

Since:

1.6

installHintListener

public static java.awt.event.FocusListener installHintListener(javax.swing.text.JTextComponent field,
                                               java.lang.String text)

Shows a certain text and stops displaying it when the text field gets the focus.

Parameters:

field - The input field to be observed

text - The hint text

Returns:

The listener

Throws:

java.lang.NullPointerException - If the parameters are null

Since:

1.6

getIconVariant

public static javax.swing.ImageIcon getIconVariant(javax.swing.ImageIcon icon,
                                   int newsize)

Provides the image in a different size.

The Commons classes use the icon file schema [name_resolution.png]. The icon names are stored within the description attribute of the icons and can be used to search the desired icon variants. The method return null if the desired image cannot be loaded from the same directory as the original image.

Parameters:

icon - The original icon

newsize - The desired image size

Returns:

The icon variant or null if it does not exist

Throws:

java.lang.NullPointerException - If the parameters are null

Since:

1.6

getComboBoxIconText

public static java.lang.String getComboBoxIconText(java.lang.String text,
                                   javax.swing.ImageIcon icon)

Converts the given combo box text so that the given icon is also displayed (HTML code).

If the given icon is null then an empty placeholder is displayed instead.

Parameters:

text - The original text for the combo

icon - The icon for the combo

Returns:

The combined icon and text

Throws:

java.lang.NullPointerException - If the parameters are null

Since:

1.6

debugInputMap

public static void debugInputMap(javax.swing.JComponent comp)

Prints info about the input map installed for the given component.

Parameters:

comp - The component to be analyzed

Throws:

java.lang.NullPointerException - If the parameters are null

Since:

1.6

setSelectedValues

public static void setSelectedValues(javax.swing.JList list,
                     java.util.Vector data,
                     java.lang.Object[] selection)

Compensates the lack of the JList.setSelectedValues() method.

Parameters:

list - The component

data - The container (list model)

selection - The desired selection

Throws:

java.lang.NullPointerException - If the parameters are null

Since:

1.6

checkEmptyTextField

public static boolean checkEmptyTextField(javax.swing.JTextField field)

Checks if the given text field is empty and sets the background color appropriately.

Parameters:

field - The component

Returns:

Text field empty?

Throws:

java.lang.NullPointerException - If the parameters are null

Since:

1.6

setShowErrorColors

public static void setShowErrorColors(javax.swing.JTextField field,
                      boolean error)

Sets the default error colors for a text field.

Parameters:

field - The component

error - Indicate error?

Throws:

java.lang.NullPointerException - If the parameters are null

Since:

1.6

setShowErrorColors

public static void setShowErrorColors(javax.swing.JEditorPane editor,
                      boolean error)

Sets the default error colors for a text editor.

Parameters:

editor - The component

error - Indicate error?

Throws:

java.lang.NullPointerException - If the parameters are null

Since:

1.6

setShowErrorColors

public static void setShowErrorColors(javax.swing.JTextArea textarea,
                      boolean error)

Sets the default error colors for a text editor.

Parameters:

textarea - The component

error - Indicate error?

Throws:

java.lang.NullPointerException - If the parameters are null

Since:

1.6

debugAWTEventType

public static void debugAWTEventType(java.awt.AWTEvent event)

Prints info about the type of the given event.

Parameters:

event - The event to be analyzed

Throws:

java.lang.NullPointerException - If the parameters are null

Since:

1.6

syncComponentsEnable

public static java.awt.event.ItemListener syncComponentsEnable(javax.swing.JCheckBox master,
                                               java.awt.Component... slaves)

Enables/disables components depending on a check box state.

Parameters:

master - The check box to get the enabled state from

slaves - The follower components

Returns:

The property change listener that has been added

Since:

1.6

syncComponentsEnable

public static java.awt.event.ItemListener syncComponentsEnable(javax.swing.JRadioButton master,
                                               java.awt.Component... slaves)

Enables/disables components depending on a radio button state.

Parameters:

master - The radio box to get the enabled state from

slaves - The follower components

Returns:

The property change listener that has been added

Since:

1.6

getBufferedImage

public static java.awt.image.BufferedImage getBufferedImage(javax.swing.ImageIcon icon)

Convenience to convert an ImageIcon into a BufferedImage.

Parameters:

icon - The image icon

Returns:

The buffered image, may be null

Since:

1.6

installFocusClearListener

public static java.awt.event.FocusListener installFocusClearListener(javax.swing.text.JTextComponent field)

Installs a FocusListener to clear the text field if the user starts working.

The listener is automatically removed if the text component gains the focus for the first time.

Parameters:

field - The input field to be observed

Returns:

The listener

Throws:

java.lang.NullPointerException - If the parameters are null

Since:

1.6

getIconFileSize

public static long getIconFileSize(javax.swing.ImageIcon icon)

Provides the length of the icon file in bytes.

Parameters:

icon - The image icon

Returns:

The icon file total size, -1 if not available

Since:

1.6

getIconData

public static byte[] getIconData(javax.swing.ImageIcon icon,
                 java.lang.String format)

Gets the binary data of an icon image in the desired format.

Parameters:

icon - The image icon

format - png|gif|...

Returns:

The icon image data, null indicates error

Since:

1.6

getImageData

public static byte[] getImageData(java.awt.image.BufferedImage image,
                  java.lang.String format)

Gets the binary data of an image in the desired format.

Parameters:

image - The image

format - png|gif|...

Returns:

The icon image data, null indicates error

Since:

1.6

mapFromImageType

public static java.lang.String mapFromImageType(int type)

Maps the given numerical image type to the corresponding text representation.

Parameters:

type - The value BufferedImage.TYPE_INT_RGB|...

Returns:

The type text, null if not a valid type

Since:

1.6

mapFromTransparency

public static java.lang.String mapFromTransparency(int type)

Maps the given numerical image type to the corresponding text representation.

Parameters:

type - The value BufferedImage.TYPE_INT_RGB|...

Returns:

The type text, null if not a valid type

Since:

1.6

mapFromSwingConstant

public static java.lang.String mapFromSwingConstant(int constant)

Maps the given numerical constant to the corresponding text representation.

Parameters:

constant - The internal value

Returns:

The constant text, null if not a valid mode

Since:

1.6

installWindowResizeListener

public static java.awt.event.HierarchyBoundsListener installWindowResizeListener(StatusBar statusbar,
                                                                 javax.swing.JDialog dialog)

Installs listener to display the current window/dialog size when resized.

This type of listener prints the current size while a window is being resized.

Parameters:

statusbar - The output component

dialog - The monitored component

Returns:

The listener

Throws:

java.lang.NullPointerException - If the parameters are null

Since:

1.6

uninstallWindowResizeListener

public static void uninstallWindowResizeListener(javax.swing.JDialog dialog,
                                 java.awt.event.HierarchyBoundsListener listener)

Uninstalls listener to display the current window/dialog size when resized.

Parameters:

dialog - The monitored component

listener - The listener

Throws:

java.lang.NullPointerException - If the parameters are null

Since:

1.6

installWindowResizeListener

public static java.awt.event.HierarchyBoundsListener installWindowResizeListener(StatusBar statusbar,
                                                                 javax.swing.JFrame frame)

Installs listener to display the current window/dialog size when resized.

This type of listener prints the current size while a window is being resized.

Parameters:

statusbar - The output component

frame - The monitored component

Returns:

The listener

Throws:

java.lang.NullPointerException - If the parameters are null

Since:

1.6

installResolutionMenuItems

public static void installResolutionMenuItems(javax.swing.JMenu menu,
                              javax.swing.JFrame window)

Creates the default menu items for main window resolutions.

Parameters:

menu - The parental menu

window - The target window

Since:

1.6

getGrayscaleIcon

public static javax.swing.ImageIcon getGrayscaleIcon(javax.swing.ImageIcon icon)

Provides the image as grayscale variant.

Parameters:

icon - The original icon

Returns:

The icon variant or null if not available

Throws:

java.lang.NullPointerException - If the parameters are null

Since:

1.6

isScrollable

public static boolean isScrollable(java.awt.Component comp)

Checks the given component if any sub-component (if any) is a JScrollPane.

Parameters:

comp - The AWT component to search

Returns:

Holds a JScrollPane?

Throws:

java.lang.NullPointerException - If a parameter is null

Since:

1.6

makeComponentVisible

public static void makeComponentVisible(java.awt.Component comp)

Scroll automatically the viewport for the given component.

Parameters:

comp - Component to be made visible

Since:

1.6

addGlobalAccelerators

public static void addGlobalAccelerators(javax.swing.JDialog dialog,
                         javax.swing.JMenuItem[] items)

Installs keyboard actions based on a main window menu items.

Here global accelerators like F1 for the application help system can be expanded to be also used by dialogs.

Parameters:

dialog - The dialog

items - The menu items holding the accelerators and listeners

Throws:

java.lang.NullPointerException - If a parameter is null

Since:

1.6

addGlobalAccelerators

public static void addGlobalAccelerators(javax.swing.JFrame frame,
                         javax.swing.JMenuItem[] items)

Installs keyboard actions based on a main window menu items.

Here global accelerators like F1 for the application help system can be expanded to be also used by separate windows.

Parameters:

frame - The window

items - The menu items holding the accelerators and listeners

Throws:

java.lang.NullPointerException - If a parameter is null

Since:

1.6

syncToggleButtonGroup

public static void syncToggleButtonGroup(javax.swing.JToggleButton[] buttons)

Synchronizes a group of toggle buttons.

If one button is selected then all other buttons are also selected.

Parameters:

buttons - The toggle buttons

Throws:

java.lang.NullPointerException - If the parameters are null

Since:

1.6

syncTableGroup

public static void syncTableGroup(javax.swing.JTable[] tables)

Synchronizes a group of table instances (column widths).

If one column is resized then all other tables are also adjusted.

Parameters:

tables - The tables

Throws:

java.lang.NullPointerException - If the parameters are null

Since:

1.6

installTextAreaPopup

public static Configuration installTextAreaPopup(javax.swing.JTextArea textarea,
                                 boolean autoscroll,
                                 boolean autoscrollenabled,
                                 boolean clearenabled,
                                 boolean copyenabled)

Creates a popup menu for a text area with default items.

Parameters:

textarea - The text area

autoscroll - Item "Auto-scroll" is selected (toggle)?

autoscrollenabled - Item "Auto-scroll" is enabled?

clearenabled - Item "Clear" is enabled?

copyenabled - Item "Copy" is enabled?

Returns:

Container with current state

Throws:

java.lang.NullPointerException - If the parameters are null

Since:

1.6

populateTreeFromXML

public static int populateTreeFromXML(javax.swing.tree.DefaultMutableTreeNode root,
                      boolean setelement,
                      java.lang.String includeregex,
                      org.jdom.Element... elements)

Assembles a JTree from the given XML data.

For each XML element a new node is added in the hierarchy defined by the XML document.

Parameters:

root - The starting point to add nodes

setelement - Set the Element's as user object in nodes?

includeregex - Regular expression to include elements (optional)

elements - The XML data on the top-level

Returns:

Number of nodes, -1 indicates error

Since:

1.6

addXMLNode

public static int addXMLNode(javax.swing.tree.DefaultMutableTreeNode parent,
             org.jdom.Element element,
             int nodecount,
             boolean setelement,
             java.lang.String includeregex)

Recursive method to add new DefaultMutableTreeNode for the given XML element.

Parameters:

parent - The starting point to add nodes

element - The XML data to add

nodecount - The number of nodes added so far

setelement - Set the Element's as user object in nodes?

includeregex - Regular expression to include elements (optional)

Returns:

Total number of nodes

Since:

1.6

uninstallChangeListeners

public static javax.swing.event.ChangeListener[] uninstallChangeListeners(javax.swing.JCheckBox comp)

Uninstalls the ChangeListeners and provides them for re-install.

Parameters:

comp - The component

Returns:

The removed listeners, may have zero-length

Throws:

java.lang.NullPointerException - If the parameters are null

Since:

1.6

installChangeListeners

public static void installChangeListeners(javax.swing.JCheckBox comp,
                          javax.swing.event.ChangeListener[] listeners)

Installs the ChangeListeners.

Parameters:

comp - The component

listeners - The new listeners

Throws:

java.lang.NullPointerException - If the parameters are null

Since:

1.6

uninstallActionListeners

public static java.awt.event.ActionListener[] uninstallActionListeners(javax.swing.JCheckBox comp)

Uninstalls the ActionListeners and provides them for re-install.

Parameters:

comp - The component

Returns:

The removed listeners, may have zero-length

Throws:

java.lang.NullPointerException - If the parameters are null

Since:

1.6

installActionListeners

public static void installActionListeners(javax.swing.JCheckBox comp,
                          java.awt.event.ActionListener[] listeners)

Installs the ActionListeners.

Parameters:

comp - The component

listeners - The new listeners

Throws:

java.lang.NullPointerException - If the parameters are null

Since:

1.6

wrapButtonText

public static java.lang.String wrapButtonText(java.lang.String rawtext,
                              int lines)

Wraps the given text to be displayed at the bottom of a JButton.

Parameters:

rawtext - The unformatted text

lines - The number of lines, -1 = dynamic

Returns:

The formatted text

Since:

1.6

installToolBarPopup

public static javax.swing.JPopupMenu installToolBarPopup(javax.swing.JToolBar toolbar,
                                         javax.swing.JMenuItem toolbaritem,
                                         javax.swing.JMenuItem labelsitem,
                                         boolean labeled)

Installs the default toolbar popup to show/hide the component, the labels etc.

Parameters:

toolbar - The toolbar

toolbaritem - The associated menu item (optional)

labelsitem - The associated menu item (optional)

labeled - Show the component labels?

Returns:

The new popup menu

Since:

1.6

executeByEDT

public static void executeByEDT(java.lang.Runnable runner)

Makes sure that the given code is executed by the EDT.

Parameters:

runner - The code to be executed

executeByThread

public static java.lang.Thread executeByThread(java.lang.Runnable runner)

Makes sure that the given code is executed by a separate thread (not the EDT).

Parameters:

runner - The code to be executed

Returns:

The created thread, null otherwise

copyToClipboard

public static void copyToClipboard(java.lang.String text)

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

Parameters:

text - The text to be copied

Since:

1.5

copyToClipboard

public static void copyToClipboard(java.io.File[] files)

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

Parameters:

files - The files to be copied

Since:

1.6

copyToClipboard

public static void copyToClipboard(org.apache.commons.vfs2.FileObject[] urls)

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

Parameters:

urls - The network files to be copied

Since:

1.6

clearClipboard

public static void clearClipboard(java.awt.datatransfer.Clipboard clipboard)

Removes all data from the given clipboard.

Parameters:

clipboard - The clipboard to be cleared

Throws:

java.lang.IllegalStateException - If the clipboard is currently unavailable

Since:

1.5

isClipboardLoaded

public static boolean isClipboardLoaded(java.awt.datatransfer.Clipboard clipboard)

Determines whether the given clipboard is currently loaded.

Parameters:

clipboard - The clipboard to be checked

Returns:

Currently loaded with data?

Throws:

java.lang.IllegalStateException - If the clipboard is currently unavailable

Since:

1.5

indexOf

public static int indexOf(javax.swing.JMenu menu,
          javax.swing.JMenuItem item,
          int fallback)

Determines the index of the given menu item within the given menu.

Parameters:

menu - The parental menu

item - The item to search for

fallback - The failsafe index

Returns:

The index, -1 otherwise

Since:

1.6

clearMenuSeparators

public static void clearMenuSeparators(javax.swing.JMenu menu)

Removes redundant menu separators.

Parameters:

menu - The parental menu

Throws:

java.lang.NullPointerException - If a parameter is null

Since:

1.6

setButtonGroup

public static void setButtonGroup(javax.swing.JCheckBox... boxes)

Implements mutual exclusion for the given JCheckBoxes.

Parameters:

boxes - The check boxes

Throws:

java.lang.NullPointerException - If the parameters are null

Since:

1.6

addClipboardPopupMenu

public static void addClipboardPopupMenu(java.awt.Component comp,
                         ContentGetter getter)

Creates a popup menu for component to copy text contents to clipboard.

Parameters:

comp - The component

getter - Instance getting the text to be copied

Throws:

java.lang.NullPointerException - If the parameters are null

Since:

1.6

setHeadlessMode

public static void setHeadlessMode(boolean value,
                   boolean force)

Sets/overwrite the headless parameter of this JVM.

Parameters:

value - The new value

force - Overwrite via refelection?

Throws:

java.lang.NullPointerException - If the parameters are null

Since:

1.6