Module is.codion.swing.common.ui
Package is.codion.swing.common.ui.laf

Interface LookAndFeelEnabler

public interface LookAndFeelEnabler
Provides and enables a LookAndFeel implementation.

  • Method Details

    • lookAndFeelInfo

      UIManager.LookAndFeelInfo lookAndFeelInfo()
      Returns:
      the look and feel info

    • enable

      void enable()
      Configures and enables the LookAndFeel represented by this enabler.

    • lookAndFeel

      LookAndFeel lookAndFeel()
      Returns:
      a new instance of the LookAndFeel represented by this enabler
      Throws:
      RuntimeException - in case the class is not found or if the LookAndFeel could not be instantiated

    • dark

      boolean dark()
      Returns:
      true if this enabler represents a dark look and feel

    • platform

      boolean platform()
      Whether this is one of the platform look and feels provided by UIManager.getInstalledLookAndFeels(), as opposed to one registered via LookAndFeelProvider. Determined when the enabler is created.
      Returns:
      true if this represents a platform look and feel

    • defaults

      default UIDefaults defaults()
      Returns:
      the UIDefaults for the look and feel this enabler represents

    • lookAndFeelEnabler

      static LookAndFeelEnabler lookAndFeelEnabler(UIManager.LookAndFeelInfo lookAndFeelInfo)
      Instantiates a new LookAndFeelEnabler, using UIManager.setLookAndFeel(String) to enable.
      Parameters:
      lookAndFeelInfo - the look and feel info
      Returns:
      a look and feel provider

    • lookAndFeelEnabler

      static LookAndFeelEnabler lookAndFeelEnabler(UIManager.LookAndFeelInfo lookAndFeelInfo, Consumer<UIManager.LookAndFeelInfo> enabler)
      Instantiates a new LookAndFeelEnabler.

      The enabler is responsible for configuring and enabling the look and feel as well as updating the component tree of all application windows, for example by calling Utilities.updateComponentTreeForAllWindows()

      Parameters:
      lookAndFeelInfo - the look and feel info
      enabler - configures and enables the look and feel as well as updates the component tree of all application windows
      Returns:
      a look and feel provider

    • lookAndFeelEnabler

      static LookAndFeelEnabler lookAndFeelEnabler(UIManager.LookAndFeelInfo lookAndFeelInfo, boolean dark, Consumer<UIManager.LookAndFeelInfo> enabler)
      Instantiates a new LookAndFeelEnabler.

      The enabler is responsible for configuring and enabling the look and feel as well as updating the component tree of all application windows, for example by calling Utilities.updateComponentTreeForAllWindows()

      Parameters:
      lookAndFeelInfo - the look and feel info
      dark - true if the resulting enabler should represent a dark look and feel
      enabler - configures and enables the look and feel as well as updates the component tree of all application windows
      Returns:
      a look and feel provider

    • enableLookAndFeel

      static void enableLookAndFeel(String userPreferencePropertyName)
      Enables the look and feel specified by the given user preference or the default system look and feel if no preference value is found.
      Parameters:
      userPreferencePropertyName - the name of the user preference look and feel property

    • enableLookAndFeel

      static boolean enableLookAndFeel(String userPreferencePropertyName, Class<? extends LookAndFeel> defaultLookAndFeel)
      Enables the look and feel specified by the given user preference or the default one if no preference value is found.
      Parameters:
      userPreferencePropertyName - the name of the user preference look and feel property
      defaultLookAndFeel - the default look and feel class to use if none is found in user preferences
      Returns:
      true if a look and feel was enabled, false if the neither the user preference nor default look and feels were available

    • enableLookAndFeel

      static boolean enableLookAndFeel(String userPreferencePropertyName, String defaultLookAndFeel)
      Enables the look and feel specified by the given user preference or the default one if no preference value is found.
      Parameters:
      userPreferencePropertyName - the name of the user preference look and feel property
      defaultLookAndFeel - the classname of the default look and feel to use if none is found in user preferences
      Returns:
      true if a look and feel was enabled, false if the neither the user preference nor default look and feels were available

    • systemLookAndFeelClassName

      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