Utilities (Codion Framework API 0.17.16)

java.lang.Object
- is.codion.swing.common.ui.Utilities

public final class Utilities
extends Object

A utility class for UI related things.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`addInitialFocusHack(JComponent component, Action onFocusAction)` http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=5018574
`static void`	`collapseAll(JTree tree, TreePath parent)` Collapses all the paths from a parent in the given tree
`static Color`	`darker(Color color)` Returns a darker version of the given color, using 0.8 as the mulitiplication factor.
`static Color`	`darker(Color color, double factor)` Returns a darker version of the given color, using the given factor.
`static boolean`	`disposeParentWindow(Component component)` Finds the parent Window and disposes it if found.
`static void`	`expandAll(JTree tree, TreePath parent)` Expands all the paths from a parent in the given tree
`static JDialog`	`getParentDialog(Component component)` Finds the first component of type `JDialog` in the parent hierarchy of `component`.
`static JFrame`	`getParentFrame(Component component)` Finds the first component of type `JFrame` in the parent hierarchy of `component`.
`static <T> T`	`getParentOfType(Class<T> clazz, Component component)` Searches the parent component hierarchy of the given component for an ancestor of the given type
`static Window`	`getParentWindow(Component component)` Finds the first component of type `Window` in the parent hierarchy of `component`.
`static boolean`	`isSystemOrCrossPlatformLookAndFeelEnabled()`
`static void`	`linkBoundedRangeModels(BoundedRangeModel main, BoundedRangeModel linked)` Links the given BoundedRangeModels so that changes in `main` are reflected in `linked`
`static Action`	`linkToEnabledState(StateObserver enabledState, Action action)` Links the given action to the given StateObserver, so that the action is enabled only when the observed state is active
`static void`	`linkToEnabledState(StateObserver enabledState, JComponent... components)` Links the given components to the given StateObserver, so that each component is enabled only when the observed state is active
`static ImageIcon`	`loadIcon(Class<?> resourceClass, String resourceName)` Loads an icon as a resource
`static <T> EventObserver<T>`	`propertyChangeObserver(JComponent component, String property)` Returns a `EventObserver` notified each time the value of the given property changes in the given component.
`static void`	`setClipboard(String string)` Sets the given string as clipboard contents
`static void`	`setFontSizePercentage(int fontSizePercentage)` Sets a global font size percentage. 85 = decrease the default font size by 15% 100 = use the default font size 125 = increase the default font size by 25%
`static String`	`systemLookAndFeelClassName()` Note that GTKLookAndFeel is overridden with MetalLookAndFeel, since JTabbedPane does not respect the 'TabbedPane.contentBorderInsets' setting, making hierachical tabbed panes look bad
`static void`	`updateUI(Collection<? extends JComponent> components)` Calls `JComponent.updateUI()` for the given components, ignores null components.
`static void`	`updateUI(JComponent... components)` Calls `JComponent.updateUI()` for the given components, ignores null components.

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

- Method Detail
  - updateUI
```
public static void updateUI(JComponent... components)
```
    Calls JComponent.updateUI() for the given components, ignores null components.
    
    Parameters:
    
    components - the components to update the UI for
  - updateUI
```
public static void updateUI(Collection<? extends JComponent> components)
```
    Calls JComponent.updateUI() for the given components, ignores null components.
    
    Parameters:
    
    components - the components to update the UI for
  - linkToEnabledState
```
public static Action linkToEnabledState(StateObserver enabledState,
                                        Action action)
```
    Links the given action to the given StateObserver, so that the action is enabled only when the observed state is active
    
    Parameters:
    
    enabledState - the StateObserver with which to link the action
    
    action - the action
    
    Returns:
    
    the linked action
  - linkToEnabledState
```
public static void linkToEnabledState(StateObserver enabledState,
                                      JComponent... components)
```
    Links the given components to the given StateObserver, so that each component is enabled only when the observed state is active
    
    Parameters:
    
    enabledState - the StateObserver with which to link the components
    
    components - the components
  - propertyChangeObserver
```
public static <T> EventObserver<T> propertyChangeObserver(JComponent component,
                                                          String property)
```
    Returns a EventObserver notified each time the value of the given property changes in the given component.
    
    Type Parameters:
    
    T - the property data type
    
    Parameters:
    
    component - the component
    
    property - the property to listen to changes for
    
    Returns:
    
    a EventObserver notified each time the value of the given property changes
  - linkBoundedRangeModels
```
public static void linkBoundedRangeModels(BoundedRangeModel main,
                                          BoundedRangeModel linked)
```
    Links the given BoundedRangeModels so that changes in main are reflected in linked
    
    Parameters:
    
    main - the main model
    
    linked - the model to link with main
  - expandAll
```
public static void expandAll(JTree tree,
                             TreePath parent)
```
    Expands all the paths from a parent in the given tree
    
    Parameters:
    
    tree - the tree
    
    parent - the parent from which to exapand
  - collapseAll
```
public static void collapseAll(JTree tree,
                               TreePath parent)
```
    Collapses all the paths from a parent in the given tree
    
    Parameters:
    
    tree - the tree
    
    parent - the parent from which to collapse
  - addInitialFocusHack
```
public static void addInitialFocusHack(JComponent component,
                                       Action onFocusAction)
```
    http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=5018574
    
    Parameters:
    
    component - the component
    
    onFocusAction - the action to run when the focus has been requested
  - loadIcon
```
public static ImageIcon loadIcon(Class<?> resourceClass,
                                 String resourceName)
```
    Loads an icon as a resource
    
    Parameters:
    
    resourceClass - the class owning the resource
    
    resourceName - the resource name
    
    Returns:
    
    an icon
  - setFontSizePercentage
```
public static void setFontSizePercentage(int fontSizePercentage)
```
    Sets a global font size percentage.
    85 = decrease the default font size by 15%
    100 = use the default font size
    125 = increase the default font size by 25%
    
    Parameters:
    
    fontSizePercentage - the font size percentage
  - darker
```
public static Color darker(Color color)
```
    Returns a darker version of the given color, using 0.8 as the mulitiplication factor.
    
    Parameters:
    
    color - the color to darken
    
    Returns:
    
    a darker version of the given color
    
    See Also:
    
    Color.darker()
  - darker
```
public static Color darker(Color color,
                           double factor)
```
    Returns a darker version of the given color, using the given factor.
    
    Parameters:
    
    color - the color to darken
    
    factor - a number between 0 and 1, non-inclusive
    
    Returns:
    
    a darker version of the given color
    
    See Also:
    
    Color.darker()
  - setClipboard
```
public static void setClipboard(String string)
```
    Sets the given string as clipboard contents
    
    Parameters:
    
    string - the string to put on the clipboard
  - getParentOfType
```
public static <T> T getParentOfType(Class<T> clazz,
                                    Component component)
```
    Searches the parent component hierarchy of the given component for an ancestor of the given type
    
    Type Parameters:
    
    T - the type of parent to find
    
    Parameters:
    
    clazz - the class of the parent to find
    
    component - the component
    
    Returns:
    
    the parent of the given component of the given type, null if none is found
  - getParentWindow
```
public static Window getParentWindow(Component component)
```
    Finds the first component of type Window in the parent hierarchy of component. Note that if component is of type Window, it is returned.
    
    Parameters:
    
    component - the component
    
    Returns:
    
    the parent Window of the given component, null if none is found
  - getParentFrame
```
public static JFrame getParentFrame(Component component)
```
    Finds the first component of type JFrame in the parent hierarchy of component. Note that if component is of type JFrame, it is returned.
    
    Parameters:
    
    component - the component
    
    Returns:
    
    the parent JFrame of the given component, null if none is found
  - getParentDialog
```
public static JDialog getParentDialog(Component component)
```
    Finds the first component of type JDialog in the parent hierarchy of component. Note that if component is of type JDialog, it is returned.
    
    Parameters:
    
    component - the component
    
    Returns:
    
    the parent JDialog of the given component, null if none is found
  - disposeParentWindow
```
public static boolean disposeParentWindow(Component component)
```
    Finds the parent Window and disposes it if found. If no parent Window is found this method has no effect
    
    Parameters:
    
    component - the component which parent Window should be disposed
    
    Returns:
    
    true if a parent Window was found and disposed
  - systemLookAndFeelClassName
```
public static String systemLookAndFeelClassName()
```
    Note that GTKLookAndFeel is overridden with MetalLookAndFeel, since JTabbedPane does not respect the 'TabbedPane.contentBorderInsets' setting, making hierachical tabbed panes look bad
    
    Returns:
    
    the default look and feel for the platform we're running on
  - isSystemOrCrossPlatformLookAndFeelEnabled
```
public static boolean isSystemOrCrossPlatformLookAndFeelEnabled()
```
    Returns:
    
    true if the system or cross-platform look and feel is enabled
    
    See Also:
    
    systemLookAndFeelClassName()

Class Utilities

Method Summary

Methods inherited from class java.lang.Object

Method Detail

updateUI

updateUI

linkToEnabledState

linkToEnabledState

propertyChangeObserver

linkBoundedRangeModels

expandAll

collapseAll

addInitialFocusHack

loadIcon

setFontSizePercentage

darker

darker

setClipboard

getParentOfType

getParentWindow

getParentFrame

getParentDialog

disposeParentWindow

systemLookAndFeelClassName

isSystemOrCrossPlatformLookAndFeelEnabled