AWTUtil (XMLmind XML Editor Java[tm] API)

java.lang.Object
- com.xmlmind.guiutil.AWTUtil

```
public final class AWTUtil
extends Object
```
A collection of miscellaneous, low-level, utility functions (static methods).

Field Summary

Fields
Modifier and Type	Field and Description
`static String[]`	`GENERIC_FONT_FAMILIES` An array containing the 3 following generic font families: SansSerif, Serif, Monospaced.
`static boolean`	`isHeadless` Returns `true` if the computer has a display, keyboard and mouse; `false` otherwise.

Method Summary

All Methods Static Methods Concrete Methods
Modifier and Type	Method and Description
`static int`	`checkDisplayScaling(int scaling)` Checks that specified display scaling is consistent with the the system's display scaling and with what is supported by XXE.
`static Color`	`convertToGray(Color c, float increment, boolean createContrast)` Returns specified color converted to gray, possibly after changing its brightness.
`static Color`	`editHSB(Color color, int h, float incrS, float incrB, boolean createContrast)` Modify the hue, saturation and brightness of specified color.
`static Color`	`fromHexString(String spec)` Returns the color specified using its hexadecimal string representation #RRGGBB.
`static int`	`getDisplayScaling()` Returns the display scaling of the main screen of the computer.
`static String[]`	`getFontFamilies()` Equivalent to `getFontFamilies(Locale.getDefault())`, except that the resulting list is cached.
`static String[]`	`getFontFamilies(Locale locale)` Returns the list of all font family names, localized for specified locale, available on this platform.
`static Image`	`getScaledImage(Image image, int width, int height, boolean smooth)` Returns a scaled copy of specified image.
`static double`	`getScreenResolution()` Returns the resolution in DPI of the main screen of the computer.
`static int`	`getSystemDisplayScaling()` Returns the display scaling of the main screen of the computer as set by the system.
`static int[]`	`getUnscaledImageSize(Image image)` If specified image has been created using `getScaledImage(java.awt.Image, int, int, boolean)`, return the original dimensions of the image in the form of an array of 2 `int`s containing the image width and image height in pixels.
`static boolean`	`hasDrawThinRectBug()` Not part of the public documented API: Java 1.8 on Retina Mac: when drawing a thin rectangle, that is, using a 2 physical pixels line with, 1 physical pixel top and/or left lines are drawn outside the boundaries of the rectangle.
`static boolean`	`hasDrawUnscaledImageBug()` Not part of the public documented API: Java 1.9 on Windows HiDPI: unscaled images are drawn by Java at 150% to 300% of their normal size using a low-quality interpolation algorithm.
`static double`	`px(double pixels)` Converts specified virtual pixels to screen pixels.
`static float`	`px(float pixels)` Converts specified virtual pixels to screen pixels.
`static int`	`px(int pixels)` Converts specified virtual pixels to screen pixels.
`static Font`	`pxDeriveFont(Font font, int style, int delta)` Creates a font derived from specified font taking into account the display scaling if any.
`static int`	`pxFontSize(Font font, int delta)` Computes the size of the font returned by `pxDeriveFont(java.awt.Font, int, int)`.
`static int`	`setDisplayScaling(int scaling)` Allows to set the value returned by `getDisplayScaling()`.
`static void`	`setFocusable(Component component, boolean focusable)` Recursively invokes `setFocusable` on specified Component and all its descendants (if specified Component is a Container).
`static void`	`setLineAntialiasing(Graphics g, boolean antialias)` Convenience methods: allows to turn on and off line antialiasing in specified `Graphics`.
`static void`	`setTextAntialiasing(Graphics g)` Configures text antialiasing in specified `Graphics` in the same way as native desktop applications.
`static Color`	`toBorderColor(Color backgroundColor)` Returns specified color after changing its brightness to make it suitable for painting a border.
`static BufferedImage`	`toBufferedImage(Image original)` Converts specified image to an ARGB BufferedImage.
`static BufferedImage`	`toBufferedImage(Image original, int convertedType)` Converts specified image to a BufferedImage having specified type (`BufferedImage.TYPE_INT_RGB`, `BufferedImage.TYPE_INT_ARGB`, etc).
`static Color`	`toDarkShadowColor(Color backgroundColor)` Returns specified color after changing its brightness to make it suitable for painting a dark shadow.
`static String`	`toHexString(Color color)` Returns the hexadecimal string representation #RRGGBB of specified color.
`static Color`	`toHighlightColor(Color backgroundColor)` Returns specified color after changing its brightness to make it suitable for painting a highlight.
`static Color`	`toSeparatorColor(Color backgroundColor)` Returns specified color after changing its brightness to make it suitable for painting a separator.
`static Color`	`toShadowColor(Color backgroundColor)` Returns specified color after changing its brightness to make it suitable for painting a shadow.
`static void`	`union(Rectangle u, Rectangle r)` Updates first rectangle to be the union of specified rectangles.
`static double`	`vpx(double pixels)` Converts specified screen pixels to virtual pixels.
`static int`	`vpx(int pixels)` Converts specified screen pixels to virtual pixels.

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

- Field Detail
  - isHeadless
```
public static final boolean isHeadless
```
    Returns true if the computer has a display, keyboard and mouse; false otherwise.
  - GENERIC_FONT_FAMILIES
```
public static final String[] GENERIC_FONT_FAMILIES
```
    An array containing the 3 following generic font families: SansSerif, Serif, Monospaced.
- Method Detail
  - setDisplayScaling
```
public static int setDisplayScaling(int scaling)
```
    Allows to set the value returned by getDisplayScaling().
    Specified value is checked using checkDisplayScaling(int).
    
    Parameters:
    
    scaling - user-specified display scaling
    
    Returns:
    
    the value which will returned by getDisplayScaling(), possibly different from specified value
  - checkDisplayScaling
```
public static int checkDisplayScaling(int scaling)
```
    Checks that specified display scaling is consistent with the the system's display scaling and with what is supported by XXE.
    
    Parameters:
    
    scaling - user-specified display scaling
    
    Returns:
    
    checked value, possibly different from specified value
  - getSystemDisplayScaling
```
public static int getSystemDisplayScaling()
```
    Returns the display scaling of the main screen of the computer as set by the system. Returns 100 when this value cannot be determined (Linux, headless environments, etc).
    
    See Also:
    
    getDisplayScaling()
  - getDisplayScaling
```
public static int getDisplayScaling()
```
    Returns the display scaling of the main screen of the computer.
    It's a percentage. 100% means no display scaling.
    A negative value means that Java uses virtual pixels. Example: -200 on a Retina Mac.
    A positive value greater than 100 means that Java still uses physical (screen) pixels and that the client code needs to upscale images, layouts, etc. Example: 150 on a HiDPI Windows.
  - getScreenResolution
```
public static double getScreenResolution()
```
    Returns the resolution in DPI of the main screen of the computer.
    This resolution is 96 on the Mac, Retina or not and 96, 144, 192, etc, on Windows depending on the DPI scale factor (100%, 150%, 200%, etc).
  - px
```
public static int px(int pixels)
```
    Converts specified virtual pixels to screen pixels. Returns specified value as is if Java uses virtual pixels (Retina Mac).
    
    See Also:
    
    getDisplayScaling()
  - px
```
public static float px(float pixels)
```
    Converts specified virtual pixels to screen pixels. Returns specified value as is if Java uses virtual pixels (Retina Mac).
    
    See Also:
    
    getDisplayScaling()
  - px
```
public static double px(double pixels)
```
    Converts specified virtual pixels to screen pixels. Returns specified value as is if Java uses virtual pixels (Retina Mac).
    
    See Also:
    
    getDisplayScaling()
  - vpx
```
public static int vpx(int pixels)
```
    Converts specified screen pixels to virtual pixels. Returns specified value as is if Java uses virtual pixels (Retina Mac).
    This is the inverse operation of px(int)
    
    See Also:
    
    getDisplayScaling()
  - vpx
```
public static double vpx(double pixels)
```
    Converts specified screen pixels to virtual pixels. Returns specified value as is if Java uses virtual pixels (Retina Mac).
    This is the inverse operation of px(double)
    
    See Also:
    
    getDisplayScaling()
  - pxDeriveFont
```
public static Font pxDeriveFont(Font font,
                                int style,
                                int delta)
```
    Creates a font derived from specified font taking into account the display scaling if any.
    
    Parameters:
    
    font - the font to be derived
    
    style - the style of the derived font, for example Font.PLAIN
    
    delta - size difference in points: use a positive int to create a larger font and a negative int to create a smaller font
    
    Returns:
    
    derived font
    
    See Also:
    
    pxFontSize(java.awt.Font, int)
  - pxFontSize
```
public static int pxFontSize(Font font,
                             int delta)
```
    Computes the size of the font returned by pxDeriveFont(java.awt.Font, int, int).
    
    Parameters:
    
    font - the font to be derived
    
    delta - size difference in points: use a positive int to create a larger font and a negative int to create a smaller font
    
    Returns:
    
    the size of the derived font
  - hasDrawThinRectBug
```
public static boolean hasDrawThinRectBug()
```
    Not part of the public documented API: Java 1.8 on Retina Mac: when drawing a thin rectangle, that is, using a 2 physical pixels line with, 1 physical pixel top and/or left lines are drawn outside the boundaries of the rectangle.
  - hasDrawUnscaledImageBug
```
public static boolean hasDrawUnscaledImageBug()
```
    Not part of the public documented API: Java 1.9 on Windows HiDPI: unscaled images are drawn by Java at 150% to 300% of their normal size using a low-quality interpolation algorithm.
  - setTextAntialiasing
```
public static void setTextAntialiasing(Graphics g)
```
    Configures text antialiasing in specified Graphics in the same way as native desktop applications.
  - setLineAntialiasing
```
public static void setLineAntialiasing(Graphics g,
                                       boolean antialias)
```
    Convenience methods: allows to turn on and off line antialiasing in specified Graphics.
  - union
```
public static void union(Rectangle u,
                         Rectangle r)
```
    Updates first rectangle to be the union of specified rectangles.
  - getScaledImage
```
public static Image getScaledImage(Image image,
                                   int width,
                                   int height,
                                   boolean smooth)
```
    Returns a scaled copy of specified image.
    
    Parameters:
    
    image - source image
    
    width - desired width
    
    height - desired height
    
    smooth - if true favor quality over speed
    
    Returns:
    
    a scaled INT_ARGB BufferedImage or source image if desired width or height are invalid or if they happen to specify the original dimensions of the image
    
    See Also:
    
    getUnscaledImageSize(java.awt.Image)
  - getUnscaledImageSize
```
public static int[] getUnscaledImageSize(Image image)
```
    If specified image has been created using getScaledImage(java.awt.Image, int, int, boolean), return the original dimensions of the image in the form of an array of 2 ints containing the image width and image height in pixels.
  - toBufferedImage
```
public static BufferedImage toBufferedImage(Image original)
```
    Converts specified image to an ARGB BufferedImage.
  - toBufferedImage
```
public static BufferedImage toBufferedImage(Image original,
                                            int convertedType)
```
    Converts specified image to a BufferedImage having specified type (BufferedImage.TYPE_INT_RGB, BufferedImage.TYPE_INT_ARGB, etc).
  - setFocusable
```
public static void setFocusable(Component component,
                                boolean focusable)
```
    Recursively invokes setFocusable on specified Component and all its descendants (if specified Component is a Container).
  - getFontFamilies
```
public static String[] getFontFamilies()
```
    Equivalent to getFontFamilies(Locale.getDefault()), except that the resulting list is cached.
  - getFontFamilies
```
public static String[] getFontFamilies(Locale locale)
```
    Returns the list of all font family names, localized for specified locale, available on this platform.
    
    Parameters:
    
    locale - the desired locale. null means: default.
    
    Returns:
    
    A sorted list of font family names. This list contains at least Serif, SansSerif and Monospaced.
  - toHexString
```
public static String toHexString(Color color)
```
    Returns the hexadecimal string representation #RRGGBB of specified color.
    
    See Also:
    
    fromHexString(java.lang.String)
  - fromHexString
```
public static Color fromHexString(String spec)
```
    Returns the color specified using its hexadecimal string representation #RRGGBB. Returns null if specification cannot be parsed.
    
    See Also:
    
    toHexString(java.awt.Color)
  - editHSB
```
public static Color editHSB(Color color,
                            int h,
                            float incrS,
                            float incrB,
                            boolean createContrast)
```
    Modify the hue, saturation and brightness of specified color.
    Examples:
    - Dimmed blue-ish: editHSB(panel_bg, 240, 0.3F, -0.4F, true) or editHSB(list_bg, 240, 0.3F, -0.5F, true).
    - Blue-ish: editHSB(panel_bg, 240, 0.5F, -0.2F, true).
    - Dimmed yellow-ish: editHSB(list_bg, 60, 0.1F, 0.05, true).
    Parameters:
    
    color - color to be modified
    
    h - new hue, a number between 0 and 360 (degrees). Examples: blue=240deg, yellow=60deg.
    Specify -1 to preserve hue.
    
    incrS - saturation increment, a number between -1 and 1. A negative value means less saturated. A positive value means more saturated.
    Specify 0 to preserve saturation.
    
    incrB - brightness increment, a number between -1 and 1. A negative value means darker. A positive value means brighter.
    Specify 0 to preserve brightness.
    createContrast - if this option is true,
    
    A negative incrB value means darker if color is light. A positive incrB value means brighter if color is light.
    incrB is automatically negated when color is dark. Therefore always assume that color is light.
    Returns:
    
    modified color
  - toHighlightColor
```
public static Color toHighlightColor(Color backgroundColor)
```
    Returns specified color after changing its brightness to make it suitable for painting a highlight.
    
    See Also:
    
    editHSB(java.awt.Color, int, float, float, boolean)
  - toShadowColor
```
public static Color toShadowColor(Color backgroundColor)
```
    Returns specified color after changing its brightness to make it suitable for painting a shadow.
    
    See Also:
    
    editHSB(java.awt.Color, int, float, float, boolean)
  - toDarkShadowColor
```
public static Color toDarkShadowColor(Color backgroundColor)
```
    Returns specified color after changing its brightness to make it suitable for painting a dark shadow.
    
    See Also:
    
    editHSB(java.awt.Color, int, float, float, boolean)
  - toBorderColor
```
public static Color toBorderColor(Color backgroundColor)
```
    Returns specified color after changing its brightness to make it suitable for painting a border.
    
    See Also:
    
    editHSB(java.awt.Color, int, float, float, boolean)
  - toSeparatorColor
```
public static Color toSeparatorColor(Color backgroundColor)
```
    Returns specified color after changing its brightness to make it suitable for painting a separator.
    
    See Also:
    
    editHSB(java.awt.Color, int, float, float, boolean)
  - convertToGray
```
public static Color convertToGray(Color c,
                                  float increment,
                                  boolean createContrast)
```
    Returns specified color converted to gray, possibly after changing its brightness.
    Parameters:
    
    c - color to be converted to gray
    
    increment - brightness increment, a number between -1 and 1. A negative value means darker. A positive value means brighter.
    createContrast - if this option is true,
    
    A negative increment value means darker if c is light. A positive increment value means brighter if c is light.
    increment is automatically negated when c is dark. Therefore always assume that c is light.
    Returns:
    
    specified color converted to gray

Class AWTUtil

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

isHeadless

GENERIC_FONT_FAMILIES

Method Detail

setDisplayScaling

checkDisplayScaling

getSystemDisplayScaling

getDisplayScaling

getScreenResolution

px

px

px

vpx

vpx

pxDeriveFont

pxFontSize

hasDrawThinRectBug

hasDrawUnscaledImageBug

setTextAntialiasing

setLineAntialiasing

union

getScaledImage

getUnscaledImageSize

toBufferedImage

toBufferedImage

setFocusable

getFontFamilies

getFontFamilies

toHexString

fromHexString

editHSB

toHighlightColor

toShadowColor

toDarkShadowColor

toBorderColor

toSeparatorColor

convertToGray