SwingUtils (jShred 19 API)

java.lang.Object
- net.shredzone.jshred.swing.SwingUtils

```
public final class SwingUtils
extends Object
```
This is a collection of static methods for your convenience.

Author:

Richard "Shred" Körber

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`copyToClipboard(String content)` Copies the given String content to the system's default clipboard.
`static JMenu`	`createJMenu(String title)` Creates a `JMenu` from a title.
`static void`	`enableRecursive(Component comp, boolean enable)` Recursively enables a `Component` and all its subcomponents.
`static Frame`	`getComponentFrame(Component comp)` Gets the `Frame` of a `Component`.
`static Collection<Component>`	`getComponentsRecursive(Component comp)` Recursively get a `Collection` of all `Component` in a `Component`.
`static String`	`getMenuName(String menu)` Gets the name of a menu.
`static Character`	`getMenuShortcut(String menu)` Gets the shortcut of a menu.
`static String`	`pasteFromClipboard(Object requestor)` Gets a String content from the system's default clipboard.
`static Dimension`	`scaleAspect(Dimension aspect, Dimension max)` Compute a `Dimension` that has the same aspect ratio as the first `Dimension`, but does not exceed any part of the second `Dimension`.
`static Dimension`	`scaleAspectMax(Dimension aspect, Dimension max)` Compute a `Dimension` that has the same aspect ratio as the first `Dimension`, but uses as much of the maximum `Dimension` as possible, without exceeding it.
`static void`	`setCancelKey(RootPaneContainer dialog, JButton cancel)` Sets the cancel button for a `RootPaneContainer`.
`static void`	`setConfirmKey(RootPaneContainer dialog, JButton confirm)` Sets the confirmation button for a `RootPaneContainer`.
`static void`	`setMenuKey(Action action, String menu)` Sets the `NAME` and `MNEMONIC_KEY` of an `Action` to the menu string.
`static void`	`setMinimumHeight(JComponent comp)` Sets the height of a `JComponent` to its minimum.
`static void`	`setMinimumWidth(JComponent comp)` Sets the width of a `JComponent` to its minimum.
`static void`	`spreadColumns(JTable table)` Adjusts each column of a `JTable` to show its entire content.
`static void`	`spreadColumns(JTable table, int maxwidth)` Adjusts each column of a `JTable` to show its entire content.
`static void`	`spreadColumns(JTable table, int minwidth, int maxwidth)` Adjusts each column of a `JTable` to show its entire content.

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

- Method Detail
  - setMinimumWidth
```
public static void setMinimumWidth(JComponent comp)
```
    Sets the width of a JComponent to its minimum. Use this to stack multiple JTextField and JComboBox in a BoxLayout along the x axis.
    
    Parameters:
    
    comp - JComponent to be minimized.
  - setMinimumHeight
```
public static void setMinimumHeight(JComponent comp)
```
    Sets the height of a JComponent to its minimum. Use this to stack multiple JTextField and JComboBox in a BoxLayout along the y axis.
    
    Parameters:
    
    comp - JComponent to be minimized.
  - setMenuKey
```
public static void setMenuKey(Action action,
                              String menu)
```
    Sets the NAME and MNEMONIC_KEY of an Action to the menu string. The menu string (with stripped underscore) will be the NAME, and the first character after the underscore will be the MNEMONIC_KEY.
    Example: "_Undo" results to a NAME "Undo" and a MNEMONIC_KEY of "U".
    If no underscore was found, MNEMONIC_KEY is unchanged.
    
    Parameters:
    
    action - Action to set NAME and MNEMONIC_KEY for
    
    menu - Menu name
  - getMenuName
```
public static String getMenuName(String menu)
```
    Gets the name of a menu. The result is the given menu name, with the first underscore being stripped. Subsequent underscores will be ignored. You can escape underscores by doubling them.
    
    Parameters:
    
    menu - Menu name
    
    Returns:
    
    Menu name without shortcut underscore
  - getMenuShortcut
```
public static Character getMenuShortcut(String menu)
```
    Gets the shortcut of a menu. The first char after an underscore will be returned. Underscores can be doubled to escape them.
    
    Parameters:
    
    menu - Menu name
    
    Returns:
    
    Shortcut character or null if none was found
  - createJMenu
```
public static JMenu createJMenu(String title)
```
    Creates a JMenu from a title. An underscore marks the menu shortcut.
    
    Parameters:
    
    title - Menu title
    
    Returns:
    
    Created JMenu having this title and shortcut set
  - getComponentFrame
```
public static Frame getComponentFrame(Component comp)
```
    Gets the Frame of a Component. If the Component was not shown in a frame, null will be returned.
    
    Parameters:
    
    comp - Component
    
    Returns:
    
    Frame this component belongs to, or null
  - spreadColumns
```
public static void spreadColumns(JTable table)
```
    Adjusts each column of a JTable to show its entire content. There is no maximum cell width given, which could result in unreadable tables on very long content.
    
    Parameters:
    
    table - JTable to be adjusted
  - spreadColumns
```
public static void spreadColumns(JTable table,
                                 int maxwidth)
```
    Adjusts each column of a JTable to show its entire content. The cell width is limited to the given maximum width, though.
    It is suggested to apply setAutoResizeMode(AUTO_RESIZE_OFF) to the appropriate table before invoking this method.
    WARNING: In order to find out the maximum cell widths, this method will scan the entire table model! This will result in a major performance penalty for large models, and especial for dynamic models which will get their content from external sources.
    
    Parameters:
    
    table - JTable to be adjusted
    
    maxwidth - Maximum width of each table cell, in pixels.
  - spreadColumns
```
public static void spreadColumns(JTable table,
                                 int minwidth,
                                 int maxwidth)
```
    Adjusts each column of a JTable to show its entire content. The cell width is limited to the given maximum width, though. The minimum cell width is either the size of the title, or the given minimum width, whatever is bigger.
    It is suggested to apply setAutoResizeMode(AUTO_RESIZE_OFF) to the appropriate table before invoking this method.
    WARNING: In order to find out the maximum cell widths, this method will scan the entire table model! This will result in a major performance penalty for large models, and especial for dynamic models which will get their content from external sources.
    
    Parameters:
    
    table - JTable to be adjusted
    
    minwidth - Minimum width of each table cell, in pixels.
    
    maxwidth - Maximum width of each table cell, in pixels.
    
    Since:
    
    R4
  - setConfirmKey
```
public static void setConfirmKey(RootPaneContainer dialog,
                                 JButton confirm)
```
    Sets the confirmation button for a RootPaneContainer. Usually the confirmation button has a broader frame, so the user can identify the default confirmation option of a dialog. Pressing the return key will usually result in triggering that button.
    
    Parameters:
    
    dialog - RootPaneContainer to set the confirmation button for
    
    confirm - Confirmation JButton.
    
    Since:
    
    R7
  - setCancelKey
```
public static void setCancelKey(RootPaneContainer dialog,
                                JButton cancel)
```
    Sets the cancel button for a RootPaneContainer. Pressing the escape key will also trigger that JButton.
    
    Parameters:
    
    dialog - RootPaneContainer to set the cancel button for
    
    cancel - Cancel JButton.
    
    Since:
    
    R7
  - copyToClipboard
```
public static void copyToClipboard(String content)
```
    Copies the given String content to the system's default clipboard.
    
    Parameters:
    
    content - String content to be copied to the clipboard.
    
    Since:
    
    R8
  - pasteFromClipboard
```
public static String pasteFromClipboard(Object requestor)
```
    Gets a String content from the system's default clipboard. If the clipboard is empty, or if it does not contain a String, then null will be returned. On some systems null will also be returned if the clipboard is currently accessed by another application.
    The requestor parameter is required by the JDK, but currently unused. Anyhow please pass a reference to the invoking class (usually this).
    
    Parameters:
    
    requestor - Requestor, usually this.
    
    Returns:
    
    The String currently found in the clipboard, or null.
    
    Since:
    
    R8
  - scaleAspect
```
public static Dimension scaleAspect(Dimension aspect,
                                    Dimension max)
```
    Compute a Dimension that has the same aspect ratio as the first Dimension, but does not exceed any part of the second Dimension. The returned Dimension will also never be larger than the aspect Dimension.
    This method can be used to scale down images that are bigger than the displaying pane. Smaller images are not scaled up, though, but are keeping their original size.
    
    Parameters:
    
    aspect - Dimension to keep the aspect ratio
    
    max - Maximum Dimension
    
    Returns:
    
    The scaled Dimension
    
    Since:
    
    R9
  - scaleAspectMax
```
public static Dimension scaleAspectMax(Dimension aspect,
                                       Dimension max)
```
    Compute a Dimension that has the same aspect ratio as the first Dimension, but uses as much of the maximum Dimension as possible, without exceeding it. The returned Dimension may be larger than the aspect Dimension.
    This method can be used to scale images to fit into the maximum dimensions at the best.
    
    Parameters:
    
    aspect - Dimension to keep the aspect ratio
    
    max - Maximum Dimension
    
    Returns:
    
    The scaled Dimension
    
    Since:
    
    R9
  - getComponentsRecursive
```
public static Collection<Component> getComponentsRecursive(Component comp)
```
    Recursively get a Collection of all Component in a Component.
    
    Parameters:
    
    comp - Root Component
    
    Returns:
    
    Collection of the Component and all its sub Components.
    
    Since:
    
    R14
  - enableRecursive
```
public static void enableRecursive(Component comp,
                                   boolean enable)
```
    Recursively enables a Component and all its subcomponents. Usually if you disable a Container, only the container itself is disabled, but not the children Components.
    
    Parameters:
    
    comp - Root Component
    
    enable - enable flag
    
    Since:
    
    R14

Class SwingUtils

Method Summary

Methods inherited from class java.lang.Object

Method Detail

setMinimumWidth

setMinimumHeight

setMenuKey

getMenuName

getMenuShortcut

createJMenu

getComponentFrame

spreadColumns

spreadColumns

spreadColumns

setConfirmKey

setCancelKey

copyToClipboard

pasteFromClipboard

scaleAspect

scaleAspectMax

getComponentsRecursive

enableRecursive