de.caff.util

Class SwingHelper

java.lang.Object

de.caff.util.SwingHelper

public class SwingHelper
extends java.lang.Object

Helper class for getting things done in swing.

Author:

Rammi

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_MIN_FONT_SIZE The default value for a minimal font size when adjusting font sizes.

Constructor Summary

Constructors

Constructor and Description
SwingHelper()

Method Summary

Modifier and Type	Method and Description
static void	adjustFontSizes(int plusminus) Adjust all font sizes used in the application.
static void	adjustFontSizes(int plusminus, java.awt.Component... updateRoots) Adjust all font sizes used in the application.
static void	adjustFontSizes(int plusminus, java.awt.Component updateRoot) Adjust all font sizes used in the application.
static void	adjustFontSizes(int plusminus, int allowedMinSize) Adjust all font sizes used in the application.
static void	adjustFontSizes(int plusminus, int allowedMinSize, java.awt.Component... updateRoots) Adjust all font sizes used in the application.
static void	adjustFontSizes(int plusminus, int allowedMinSize, java.awt.Component updateRoot) Adjust all font sizes used in the application.
static void	enableHiDpiSupport(java.awt.Window mainWindow, java.awt.Component... moreRoots) Enable high DPI support for the given window.
static int	getAccumulatedFontSizeChanges() Get the accumulated font size changes.
static java.awt.Rectangle	getDrawableViewport(javax.swing.JComponent comp) Get the inner rectangle of a Swing component which is available for drawing.
static int	getMinUiFontSize() Get the minimal size used in the UI fonts.
static javax.swing.Icon	loadIconResource(java.lang.String resourcePath) Load a potentially scalable icon.
static int	setupDefaultHiDpi() Setup default high DPI settings.
static int	setupDefaultHiDpi(java.awt.GraphicsConfiguration config) Setup default high DPI settings.
static void	updateUI(java.awt.Component component) Calls the updateUI() method on swing components recursively.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MIN_FONT_SIZE

public static final int DEFAULT_MIN_FONT_SIZE

The default value for a minimal font size when adjusting font sizes.

See Also:

Constant Field Values

Constructor Detail

SwingHelper

public SwingHelper()

Method Detail

adjustFontSizes

public static void adjustFontSizes(int plusminus)

Adjust all font sizes used in the application. The given delta is just added to all font sizes in this application. This uses the default minimum size.

Parameters:

plusminus - how to adjust, if positive fonts used become larger, if negative smaller

adjustFontSizes

public static void adjustFontSizes(int plusminus,
                                   int allowedMinSize)

Adjust all font sizes used in the application. The given delta is just added to all font sizes in this application.

Parameters:

plusminus - how to adjust, if positive fonts used become larger, if negative smaller

allowedMinSize - the minimal font size result when shrinking

adjustFontSizes

public static void adjustFontSizes(int plusminus,
                                   java.awt.Component updateRoot)

Adjust all font sizes used in the application. The given delta is just added to all font sizes in this application. This uses the default minimum size.

Parameters:

plusminus - how to adjust, if positive fonts used become larger, if negative smaller

updateRoot - because for some reason the components don't update automatically, here a root component may be added which will be explicitely updated using the updateUI(java.awt.Component) method

adjustFontSizes

public static void adjustFontSizes(int plusminus,
                                   int allowedMinSize,
                                   java.awt.Component updateRoot)

Adjust all font sizes used in the application. The given delta is just added to all font sizes in this application.

Parameters:

plusminus - how to adjust, if positive fonts used become larger, if negative smaller

allowedMinSize - the minimal font size result when shrinking

updateRoot - because for some reason the components don't update automatically, here a root component may be added which will be explicitly updated using the updateUI(java.awt.Component) method

adjustFontSizes

public static void adjustFontSizes(int plusminus,
                                   java.awt.Component... updateRoots)

Adjust all font sizes used in the application. The given delta is just added to all font sizes in this application. This uses the default minimum size.

Parameters:

plusminus - how to adjust, if positive fonts used become larger, if negative smaller

updateRoots - because for some reason the components don't update automatically, here root components may be added which will be explicitly updated using the updateUI(java.awt.Component) method

adjustFontSizes

public static void adjustFontSizes(int plusminus,
                                   int allowedMinSize,
                                   java.awt.Component... updateRoots)

Adjust all font sizes used in the application. The given delta is just added to all font sizes in this application.

Parameters:

plusminus - how to adjust, if positive fonts used become larger, if negative smaller

allowedMinSize - the minimal font size result when shrinking

updateRoots - because for some reason the components don't update automatically, here root components may be added which will be explicitly updated using the updateUI(java.awt.Component) method

getMinUiFontSize

public static int getMinUiFontSize()

Get the minimal size used in the UI fonts.

Returns:

minimal UI font size

updateUI

public static void updateUI(java.awt.Component component)

Calls the updateUI() method on swing components recursively.

Parameters:

component - root component

getAccumulatedFontSizeChanges

public static int getAccumulatedFontSizeChanges()

Get the accumulated font size changes.

Returns:

accumulated font size changes

enableHiDpiSupport

public static void enableHiDpiSupport(java.awt.Window mainWindow,
                                      java.awt.Component... moreRoots)

Enable high DPI support for the given window. This goes recursively over the component tree(s) and enables high DPI support.

Parameters:

mainWindow - application's main window

moreRoots - more root components for recursive enablement

setupDefaultHiDpi

public static int setupDefaultHiDpi()

Setup default high DPI settings. This uses the default graphics configuration of the default screen device for setup.

Returns:

the font delta applied during setup

setupDefaultHiDpi

public static int setupDefaultHiDpi(java.awt.GraphicsConfiguration config)

Setup default high DPI settings.

Parameters:

config - graphics configuration used for setup

Returns:

the font delta applied during setup

loadIconResource

public static javax.swing.Icon loadIconResource(java.lang.String resourcePath)

Load a potentially scalable icon.

Parameters:

resourcePath - internal resource path to image

Returns:

icon

getDrawableViewport

public static java.awt.Rectangle getDrawableViewport(javax.swing.JComponent comp)

Get the inner rectangle of a Swing component which is available for drawing. This takes care of possible insets.

Parameters:

comp - component for which the draw rectangle is requested

Returns:

draw rectangle of component