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

Interface Icons

All Known Subinterfaces:
FrameworkIcons
All Known Implementing Classes:
DefaultFrameworkIcons
public interface Icons
Provides icons for ui components. The icon color follows the 'Button.foreground' color of the current Look and feel. Add icons via add(Ikon...) (Ikon)} and retrieve them via icon(Ikon).
See Also:

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    DEFAULT_ICON_SIZE
     
    static final PropertyValue<Color>
    ICON_COLOR
    The icon color Value type: Color Default value: UIManager.getColor("Button.foreground")
    static final PropertyValue<Integer>
    ICON_SIZE
    The icon size, note that this will affect the size of buttons Value type: Integer Default value: 16

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    add(org.kordamp.ikonli.Ikon... ikons)
    Adds the given ikons to this FrameworkIcons instance.
    Icons
    disableIconColorConsumer()
    Disables the dynamic color change consumer
    Icons
    enableIconColorConsumer()
    Adds a consumer to the ICON_COLOR property value, dynamically changing the color of the icons in this instance.
    ImageIcon
    icon(org.kordamp.ikonli.Ikon ikon)
    Retrieves the ImageIcon associated with the given ikon from this FrameworkIcons instance.
    void
    iconColor(Color color)
    Sets the icon color
    static Icons
    icons()
     

  • Field Details

    • DEFAULT_ICON_SIZE

      static final int DEFAULT_ICON_SIZE
      See Also:

    • ICON_SIZE

      static final PropertyValue<Integer> ICON_SIZE
      The icon size, note that this will affect the size of buttons
      • Value type: Integer
      • Default value: 16

    • ICON_COLOR

      static final PropertyValue<Color> ICON_COLOR
      The icon color
      • Value type: Color
      • Default value: UIManager.getColor("Button.foreground")

  • Method Details

    • add

      void add(org.kordamp.ikonli.Ikon... ikons)
      Adds the given ikons to this FrameworkIcons instance. Retrieve an icon via icon(Ikon).
      Parameters:
      ikons - the ikons to add
      Throws:
      IllegalArgumentException - in case an icon has already been associated with any of the given ikons

    • icon

      ImageIcon icon(org.kordamp.ikonli.Ikon ikon)
      Retrieves the ImageIcon associated with the given ikon from this FrameworkIcons instance.
      Parameters:
      ikon - the ikon
      Returns:
      the ImageIcon associated with the given ikon
      Throws:
      IllegalArgumentException - in case no icon has been associated with the given ikon
      See Also:

    • iconColor

      void iconColor(Color color)
      Sets the icon color
      Parameters:
      color - the color

    • enableIconColorConsumer

      Icons enableIconColorConsumer()
      Adds a consumer to the ICON_COLOR property value, dynamically changing the color of the icons in this instance.
      Returns:
      this icons instance

    • disableIconColorConsumer

      Icons disableIconColorConsumer()
      Disables the dynamic color change consumer
      Returns:
      this icons instance

    • icons

      static Icons icons()
      Returns:
      a new Icons instance