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

Interface FrameworkIcons

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

  • Field Details

    • SMALL_SIZE

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

    • LARGE_SIZE

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

    • FRAMEWORK_ICONS_CLASSNAME

      static final PropertyValue<String> FRAMEWORK_ICONS_CLASSNAME
      Specifies the name of the FrameworkIcons implementation class to use.

  • Method Details

    • color

      Value<Color> color()
      Follows the 'Button.foreground' color of the current Look and feel.
      Returns:
      the Value controlling the icon color

    • add

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

    • get

      ControlIcon get(org.kordamp.ikonli.Ikon ikon)
      Retrieves the ControlIcon associated with the given ikon.
      Parameters:
      ikon - the ikon
      Returns:
      the ControlIcon associated with the given ikon
      Throws:
      IllegalArgumentException - in case no icon has been associated with the given ikon
      See Also:

    • filter

      ControlIcon filter()
      Returns:
      icon for the 'filter' action.

    • search

      ControlIcon search()
      Returns:
      icon for the 'search' action.

    • add

      ControlIcon add()
      Returns:
      icon for the 'add' action.

    • delete

      ControlIcon delete()
      Returns:
      icon for the 'delete' action.

    • update

      ControlIcon update()
      Returns:
      icon for the 'update' action.

    • copy

      ControlIcon copy()
      Returns:
      icon for the 'copy' action.

    • refresh

      ControlIcon refresh()
      Returns:
      icon for the 'refresh' action.

    • clear

      ControlIcon clear()
      Returns:
      icon for the 'clear' action.

    • up

      ControlIcon up()
      Returns:
      icon for the 'up' action.

    • down

      ControlIcon down()
      Returns:
      icon for the 'down' action.

    • detail

      ControlIcon detail()
      Returns:
      icon for the 'detail' action.

    • print

      ControlIcon print()
      Returns:
      icon for the 'print' action.

    • clearSelection

      ControlIcon clearSelection()
      Returns:
      icon for the 'clear selection' action.

    • edit

      ControlIcon edit()
      Returns:
      icon for the 'edit' action.

    • summary

      ControlIcon summary()
      Returns:
      icon for the 'summary' action.

    • editPanel

      ControlIcon editPanel()
      Returns:
      icon for the 'edit panel' action.

    • dependencies

      ControlIcon dependencies()
      Returns:
      icon for the 'dependencies' action.

    • settings

      ControlIcon settings()
      Returns:
      icon for a 'settings' action.

    • calendar

      ControlIcon calendar()
      Returns:
      icon for a 'calendar' action

    • editText

      ControlIcon editText()
      Returns:
      icon for a 'editText' action

    • columns

      ControlIcon columns()
      Returns:
      icon for a 'columns' action

    • logo

      ImageIcon logo()
      Returns:
      the logo icon.

    • instance

      static FrameworkIcons instance()
      Returns:
      a FrameworkIcons implementation of the type specified by FRAMEWORK_ICONS_CLASSNAME.
      Throws:
      IllegalArgumentException - in case no such implementation is found