PlatformDefaults (Jowidgets API Specification)

java.lang.Object
- org.jowidgets.api.layout.miglayout.PlatformDefaults

public final class PlatformDefaults
extends java.lang.Object

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`BASE_FONT_SIZE` I value indicating that the size of the font for the container of the component will be used as a base for calculating the logical pixel size.
`static int`	`BASE_REAL_PIXEL` I value indicating that the size of a logical pixel should always be a real pixel and thus no compensation will be made.
`static int`	`BASE_SCALE_FACTOR` I value indicating that the screen DPI will be used as a base for calculating the logical pixel size.
`static int`	`GNOME`
`static int`	`MAC_OSX`
`static int`	`WINDOWS_XP`

Method Summary

Methods
Modifier and Type	Method and Description
`static java.lang.String`	`getButtonOrder()` Returns the order for the typical buttons in a standard button bar.
`static int`	`getCurrentPlatform()` Returns the platform that the JRE is running on currently.
`static int`	`getDefaultDPI()`
`static int`	`getDefaultHorizontalUnit()` Returns the current default unit.
`static boolean`	`getDefaultRowAlignmentBaseline()` The default alignment for rows.
`static int`	`getDefaultVerticalUnit()` Returns the current default unit.
`static java.lang.Float`	`getHorizontalScaleFactor()` The forced scale factor that all screen relative units (e.g. millimeters, inches and logical pixels) will be multiplied with.
`static IPlatformDefaults`	`getInstance()`
`static float`	`getLabelAlignPercentage()` Returns the percentage used for alignment for labels (0 is left, 50 is center and 100 is right).
`static int`	`getLogicalPixelBase()` What base value should be used to calculate logical pixel sizes.
`static int`	`getModCount()` Returns how many times the defaults has been changed.
`static int`	`getPlatform()` Returns the current platform
`static java.lang.Float`	`getVerticalScaleFactor()` The forced scale factor that all screen relative units (e.g. millimeters, inches and logical pixels) will be multiplied with.
`static void`	`invalidate()` Tells all layout manager instances to revalidate and recalculated everything.
`static void`	`setButtonOrder(java.lang.String order)` Sets the order for the typical buttons in a standard button bar.
`static void`	`setDefaultDPI(java.lang.Integer dpi)` Sets the default platform DPI.
`static void`	`setDefaultHorizontalUnit(int unit)` Sets the default unit.
`static void`	`setDefaultRowAlignmentBaseline(boolean b)` The default alignment for rows.
`static void`	`setDefaultVerticalUnit(int unit)` Sets the default unit.
`static void`	`setHorizontalScaleFactor(java.lang.Float f)` The forced scale factor that all screen relative units (e.g. millimeters, inches and logical pixels) will be multiplied with.
`static void`	`setLogicalPixelBase(int base)` What base value should be used to calculate logical pixel sizes.
`static void`	`setPlatform(int plaf)` Set the defaults to the default for the platform
`static void`	`setVerticalScaleFactor(java.lang.Float f)` The forced scale factor that all screen relative units (e.g. millimeters, inches and logical pixels) will be multiplied with.

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

- Field Detail
  - WINDOWS_XP
```
public static final int WINDOWS_XP
```
    See Also:
    Constant Field Values
  - MAC_OSX
```
public static final int MAC_OSX
```
    See Also:
    Constant Field Values
  - GNOME
```
public static final int GNOME
```
    See Also:
    Constant Field Values
  - BASE_FONT_SIZE
```
public static final int BASE_FONT_SIZE
```
    I value indicating that the size of the font for the container of the component will be used as a base for calculating the logical pixel size. This is much as how Windows calculated DLU (dialog units).
    
    See Also:
    net.miginfocom.layout.UnitValue#LPX, net.miginfocom.layout.UnitValue#LPY, setLogicalPixelBase(int), Constant Field Values
  - BASE_SCALE_FACTOR
```
public static final int BASE_SCALE_FACTOR
```
    I value indicating that the screen DPI will be used as a base for calculating the logical pixel size.
    This is the default value.
    
    See Also:
    net.miginfocom.layout.UnitValue#LPX, net.miginfocom.layout.UnitValue#LPY, setLogicalPixelBase(int), setVerticalScaleFactor(Float), setHorizontalScaleFactor(Float), Constant Field Values
  - BASE_REAL_PIXEL
```
public static final int BASE_REAL_PIXEL
```
    I value indicating that the size of a logical pixel should always be a real pixel and thus no compensation will be made.
    
    See Also:
    net.miginfocom.layout.UnitValue#LPX, net.miginfocom.layout.UnitValue#LPY, setLogicalPixelBase(int), Constant Field Values
- Method Detail
  - getInstance
```
public static IPlatformDefaults getInstance()
```
  - getCurrentPlatform
```
public static int getCurrentPlatform()
```
    Returns the platform that the JRE is running on currently.
    
    Returns:
    The platform that the JRE is running on currently. E.g. MAC_OSX, WINDOWS_XP, or GNOME.
  - setPlatform
```
public static void setPlatform(int plaf)
```
    Set the defaults to the default for the platform
    
    Parameters:
    plaf - The platform. PlatformDefaults.WINDOWS_XP, PlatformDefaults.MAC_OSX, or PlatformDefaults.GNOME.
  - getPlatform
```
public static int getPlatform()
```
    Returns the current platform
    
    Returns:
    PlatformDefaults.WINDOWS or PlatformDefaults.MAC_OSX
  - getDefaultDPI
```
public static int getDefaultDPI()
```
  - setDefaultDPI
```
public static void setDefaultDPI(java.lang.Integer dpi)
```
    Sets the default platform DPI. Normally this is set in the setPlatform(int) for the different platforms but it can be tweaked here. For instance SWT on Mac does this.
    Note that this is not the actual current DPI, but the base DPI for the toolkit.
    
    Parameters:
    dpi - The base DPI. If null the default DPI is reset to the platform base DPI.
  - getHorizontalScaleFactor
```
public static java.lang.Float getHorizontalScaleFactor()
```
    The forced scale factor that all screen relative units (e.g. millimeters, inches and logical pixels) will be multiplied with. If null this will default to a scale that will scale the current screen to the default screen resolution (72 DPI for Mac and 92 DPI for Windows).
    
    Returns:
    The forced scale or null for default scaling.
    See Also:
    getHorizontalScaleFactor(), ComponentWrapper#getHorizontalScreenDPI()
  - setHorizontalScaleFactor
```
public static void setHorizontalScaleFactor(java.lang.Float f)
```
    The forced scale factor that all screen relative units (e.g. millimeters, inches and logical pixels) will be multiplied with. If null this will default to a scale that will scale the current screen to the default screen resolution (72 DPI for Mac and 92 DPI for Windows).
    
    Parameters:
    f - The forced scale or null for default scaling.
    See Also:
    getHorizontalScaleFactor(), ComponentWrapper#getHorizontalScreenDPI()
  - getVerticalScaleFactor
```
public static java.lang.Float getVerticalScaleFactor()
```
    The forced scale factor that all screen relative units (e.g. millimeters, inches and logical pixels) will be multiplied with. If null this will default to a scale that will scale the current screen to the default screen resolution (72 DPI for Mac and 92 DPI for Windows).
    
    Returns:
    The forced scale or null for default scaling.
    See Also:
    getHorizontalScaleFactor(), ComponentWrapper#getVerticalScreenDPI()
  - setVerticalScaleFactor
```
public static void setVerticalScaleFactor(java.lang.Float f)
```
    The forced scale factor that all screen relative units (e.g. millimeters, inches and logical pixels) will be multiplied with. If null this will default to a scale that will scale the current screen to the default screen resolution (72 DPI for Mac and 92 DPI for Windows).
    
    Parameters:
    f - The forced scale or null for default scaling.
    See Also:
    getHorizontalScaleFactor(), ComponentWrapper#getVerticalScreenDPI()
  - getLogicalPixelBase
```
public static int getLogicalPixelBase()
```
    What base value should be used to calculate logical pixel sizes.
    
    Returns:
    The current base. Default is BASE_SCALE_FACTOR
    See Also:
    BASE_FONT_SIZE, BASE_SCREEN_DPI_FACTOR, BASE_REAL_PIXEL
  - setLogicalPixelBase
```
public static void setLogicalPixelBase(int base)
```
    What base value should be used to calculate logical pixel sizes.
    
    Parameters:
    base - The new base. Default is BASE_SCALE_FACTOR
    See Also:
    BASE_FONT_SIZE, BASE_SCREEN_DPI_FACTOR, BASE_REAL_PIXEL
  - getButtonOrder
```
public static java.lang.String getButtonOrder()
```
    Returns the order for the typical buttons in a standard button bar. It is one letter per button type.
    
    Returns:
    The button order.
    See Also:
    setButtonOrder(String)
  - setButtonOrder
```
public static void setButtonOrder(java.lang.String order)
```
    Sets the order for the typical buttons in a standard button bar. It is one letter per button type.
    Letter in upper case will get the minimum button width that the #getMinimumButtonWidth() specifies and letters in lower case will get the width the current look&feel specifies.
    Gaps will never be added to before the first component or after the last component. However, '+' (push) will be applied before and after as well, but with a minimum size of 0 if first/last so there will not be a gap before or after.
    If gaps are explicitly set on buttons they will never be reduced, but they may be increased.
    These are the characters that can be used:
    - 'L' - Buttons with this style tag will staticall end up on the left end of the bar.
    - 'R' - Buttons with this style tag will staticall end up on the right end of the bar.
    - 'H' - A tag for the "help" button that normally is supposed to be on the right.
    - 'E' - A tag for the "help2" button that normally is supposed to be on the left.
    - 'Y' - A tag for the "yes" button.
    - 'N' - A tag for the "no" button.
    - 'X' - A tag for the "next >" or "forward >" button.
    - 'B' - A tag for the "< back>" or "< previous" button.
    - 'I' - A tag for the "finish".
    - 'A' - A tag for the "apply" button.
    - 'C' - A tag for the "cancel" or "close" button.
    - 'O' - A tag for the "ok" or "done" button.
    - 'U' - All Uncategorized, Other, or "Unknown" buttons. Tag will be "other".
    - '+' - A glue push gap that will take as much space as it can and at least an "unrelated" gap. (Platform dependant)
    - '_' - (underscore) An "unrelated" gap. (Platform dependant)
    Even though the style tags are normally applied to buttons this works with all components.
    The normal style for MAC OS X is "L_HE+U+FBI_NYCOA_R", for Windows is "L_E+U+FBI_YNOCAH_R", and for GNOME is "L_HE+UNYACBXIO_R".
    Parameters:
    order - The new button order for the current platform.
  - getLabelAlignPercentage
```
public static float getLabelAlignPercentage()
```
    Returns the percentage used for alignment for labels (0 is left, 50 is center and 100 is right).
    
    Returns:
    The percentage used for alignment for labels
  - getModCount
```
public static int getModCount()
```
    Returns how many times the defaults has been changed. This can be used as a light weight check to see if layout caches needs to be refreshed.
    
    Returns:
    How many times the defaults has been changed.
  - invalidate
```
public static void invalidate()
```
    Tells all layout manager instances to revalidate and recalculated everything.
  - getDefaultHorizontalUnit
```
public static int getDefaultHorizontalUnit()
```
    Returns the current default unit. The default unit is the unit used if no unit is set. E.g. "width 10".
    
    Returns:
    The current default unit.
    See Also:
    net.miginfocom.layout.UnitValue#PIXEL, net.miginfocom.layout.UnitValue#LPX
  - setDefaultHorizontalUnit
```
public static void setDefaultHorizontalUnit(int unit)
```
    Sets the default unit. The default unit is the unit used if no unit is set. E.g. "width 10".
    
    Parameters:
    unit - The new default unit.
    See Also:
    net.miginfocom.layout.UnitValue#PIXEL, net.miginfocom.layout.UnitValue#LPX
  - getDefaultVerticalUnit
```
public static int getDefaultVerticalUnit()
```
    Returns the current default unit. The default unit is the unit used if no unit is set. E.g. "width 10".
    
    Returns:
    The current default unit.
    See Also:
    net.miginfocom.layout.UnitValue#PIXEL, net.miginfocom.layout.UnitValue#LPY
  - setDefaultVerticalUnit
```
public static void setDefaultVerticalUnit(int unit)
```
    Sets the default unit. The default unit is the unit used if no unit is set. E.g. "width 10".
    
    Parameters:
    unit - The new default unit.
    See Also:
    net.miginfocom.layout.UnitValue#PIXEL, net.miginfocom.layout.UnitValue#LPY
  - getDefaultRowAlignmentBaseline
```
public static boolean getDefaultRowAlignmentBaseline()
```
    The default alignment for rows. Pre v3.5 this was false but now it is true.
    
    Returns:
    The current value. Default is true.
    Since:
    
    3.5
  - setDefaultRowAlignmentBaseline
```
public static void setDefaultRowAlignmentBaseline(boolean b)
```
    The default alignment for rows. Pre v3.5 this was false but now it is true.
    
    Parameters:
    b - The new value. Default is true from v3.5.
    Since:
    
    3.5

Class PlatformDefaults

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

WINDOWS_XP

MAC_OSX

GNOME

BASE_FONT_SIZE

BASE_SCALE_FACTOR

BASE_REAL_PIXEL

Method Detail

getInstance

getCurrentPlatform

setPlatform

getPlatform

getDefaultDPI

setDefaultDPI

getHorizontalScaleFactor

setHorizontalScaleFactor

getVerticalScaleFactor

setVerticalScaleFactor

getLogicalPixelBase

setLogicalPixelBase

getButtonOrder

setButtonOrder

getLabelAlignPercentage

getModCount

invalidate

getDefaultHorizontalUnit

setDefaultHorizontalUnit

getDefaultVerticalUnit

setDefaultVerticalUnit

getDefaultRowAlignmentBaseline

setDefaultRowAlignmentBaseline