Interface FlatSystemProperties

public interface FlatSystemProperties
Defines/documents own system properties used in FlatLaf.

  • Field Details

    • UI_SCALE

      static final String UI_SCALE
      Specifies a custom scale factor used to scale the UI.

      If Java runtime scales (Java 9 or later), this scale factor is applied on top of the Java system scale factor. Java 8 does not scale and this scale factor replaces the user scale factor that FlatLaf computes based on the font. To replace the Java 9+ system scale factor, use system property "sun.java2d.uiScale", which has the same syntax as this one.

      Since FlatLaf 1.1.2: Scale factors less than 100% are allowed.

      Allowed Values e.g. 1.5, 1.5x, 150% or 144dpi (96dpi is 100%)

      See Also:

    • UI_SCALE_ENABLED

      static final String UI_SCALE_ENABLED
      Specifies whether user scaling mode is enabled.

      Allowed Values false and true
      Default true

      See Also:

    • UI_SCALE_ALLOW_SCALE_DOWN

      static final String UI_SCALE_ALLOW_SCALE_DOWN
      Specifies whether values smaller than 100% are allowed for the user scale factor (see UIScale.getUserScaleFactor()).

      Allowed Values false and true
      Default false

      Since:
      1.1.2
      See Also:

    • USE_UBUNTU_FONT

      static final String USE_UBUNTU_FONT
      Specifies whether Ubuntu font should be used on Ubuntu Linux. By default, if not running in a JetBrains Runtime, the Liberation Sans font is used because there are rendering issues (in Java) with Ubuntu fonts.

      Allowed Values false and true
      Default false

      See Also:

    • USE_WINDOW_DECORATIONS

      static final String USE_WINDOW_DECORATIONS
      Specifies whether native window decorations should be used when creating JFrame or JDialog.

      Setting this to true forces using native window decorations even if they are not enabled by the application.
      Setting this to false disables using native window decorations.

      This system property has higher priority than client property FlatClientProperties.USE_WINDOW_DECORATIONS and UI default TitlePane.useWindowDecorations.

      (requires Windows 10/11)

      Allowed Values false and true
      Default none

      See Also:

    • USE_JETBRAINS_CUSTOM_DECORATIONS

      @Deprecated static final String USE_JETBRAINS_CUSTOM_DECORATIONS
      Deprecated.
      No longer used since FlatLaf 3.3. Retained for API compatibility.
      Specifies whether JetBrains Runtime custom window decorations should be used when creating JFrame or JDialog. Requires that the application runs in a JetBrains Runtime (based on OpenJDK).

      Setting this to false disables using JetBrains Runtime custom window decorations. Then FlatLaf native window decorations are used.

      (requires Windows 10/11)

      Allowed Values false and true
      Default false (since v2; was true in v1)

      See Also:

    • ANIMATION

      static final String ANIMATION
      Specifies whether animations are enabled.

      Allowed Values false and true
      Default true

      See Also:

    • USE_ROUNDED_POPUP_BORDER

      static final String USE_ROUNDED_POPUP_BORDER
      Specifies whether native rounded popup borders should be used (if supported by operating system).

      (requires Windows 11 or macOS)

      Allowed Values false and true
      Default true; except in FlatLaf 3.5.x on macOS 14.4+ where it was false

      Since:
      3.5.2
      See Also:

    • USE_TEXT_Y_CORRECTION

      static final String USE_TEXT_Y_CORRECTION
      Specifies whether vertical text position is corrected when UI is scaled on HiDPI screens.

      Allowed Values false and true
      Default true

      See Also:

    • UPDATE_UI_ON_SYSTEM_FONT_CHANGE

      static final String UPDATE_UI_ON_SYSTEM_FONT_CHANGE
      Specifies whether FlatLaf updates the UI when the system font changes. If true, SwingUtilities.updateComponentTreeUI(java.awt.Component) gets invoked for all windows if the system font has changed. This is the similar to when switching to another look and feel (theme). Applications that do not work correctly when switching look and feel, should disable this option to avoid corrupted UI.

      Allowed Values false and true
      Default true

      Since:
      2.5
      See Also:

    • USE_NATIVE_LIBRARY

      static final String USE_NATIVE_LIBRARY
      Specifies whether FlatLaf native library should be used.

      Setting this to false disables loading native library, which also disables some features that depend on the native library.

      Allowed Values false and true
      Default true

      Since:
      3.2
      See Also:

    • NATIVE_LIBRARY_PATH

      static final String NATIVE_LIBRARY_PATH
      Specifies a directory in which the FlatLaf native libraries are searched for. The path can be absolute or relative to current application working directory. This can be used to avoid extraction of the native libraries to the temporary directory at runtime.

      If the value is "system" (supported since FlatLaf 2.6), then System.loadLibrary(String)RESTRICTED is used to load the native library. This searches for the native library in classloader of caller (using ClassLoader.findLibrary(String)) and in paths specified in system properties sun.boot.library.path and java.library.path.

      If the native library can not be loaded from the given path (or via System.loadLibrary(String)RESTRICTED), then the embedded native library is extracted to the temporary directory and loaded from there.

      The file names of the native libraries must be either:

      Note: Since FlatLaf 3.1 it is recommended to download the FlatLaf native libraries from Maven central and distribute them with your application in the same directory as flatlaf.jar. Then it is not necessary to set this system property. See https://www.formdev.com/flatlaf/native-libraries/ for details.

      Since:
      2
      See Also:

    • USE_SUB_MENU_SAFE_TRIANGLE

      static final String USE_SUB_MENU_SAFE_TRIANGLE
      Specifies whether safe triangle is used to improve usability of submenus.

      Allowed Values false and true
      Default true

      Since:
      3.5.1
      See Also:

  • Method Details

    • getBoolean

      static boolean getBoolean(String key, boolean defaultValue)
      Checks whether a system property is set and returns true if its value is "true" (case-insensitive), otherwise it returns false. If the system property is not set, defaultValue is returned.

    • getBooleanStrict

      static Boolean getBooleanStrict(String key, Boolean defaultValue)
      Checks whether a system property is set and returns Boolean.TRUE if its value is "true" (case-insensitive) or returns Boolean.FALSE if its value is "false" (case-insensitive). Otherwise defaultValue is returned.