Package sc.fiji.snt.gui

Class IconFactory

java.lang.Object
sc.fiji.snt.gui.IconFactory
public class IconFactory extends Object
A factory for FADerivedIcons presets.
Author:
Tiago Ferreira

  • Constructor Details

    • IconFactory

      public IconFactory()

  • Method Details

    • disabledColor

      public static Color disabledColor()

    • get

      public static Icon get(IconFactory.GLYPH entry, float size, Color color)
      Creates a new icon from a Font Awesome glyph.
      Parameters:
      entry - the glyph defining the icon's Unicode ID
      size - the icon's size
      color - the icon's color
      Returns:
      the icon

    • getAsImage

      public static ImageIcon getAsImage(IconFactory.GLYPH entry, float size, Color color)
      Creates a new image icon from a Font Awesome glyph.
      Parameters:
      entry - the glyph defining the icon's Unicode ID
      size - the icon's size
      color - the icon's color
      Returns:
      the icon

    • buttonIcon

      public static Icon buttonIcon(IconFactory.GLYPH entry, Color color, float scalingFactor)

    • buttonIcon

      public static Icon buttonIcon(IconFactory.GLYPH entry, float scalingFactor)

    • buttonIcon

      public static Icon buttonIcon(char symbol, boolean solid, Color color)

    • buttonIcon

      public static Icon buttonIcon(char symbol, boolean solid)

    • listIcon

      public static Icon listIcon(JList<?> list, IconFactory.GLYPH entry)

    • listIcon

      public static Icon listIcon(JList<?> list, IconFactory.GLYPH entry, Color color)

    • listIcon

      public static Icon listIcon(JList<?> list, IconFactory.GLYPH entry1, IconFactory.GLYPH entry2)
      Two-glyph analog of listIcon(JList, GLYPH): composites entry1 and entry2 side by side (see doubleIcon(GLYPH, GLYPH, float, Color)), scaled to match single-glyph listIcon icons in the same list, rather than doubleIcon's own default-size-relative scaling (meant for toolbar buttons, not list rows).

    • listIcon

      public static Icon listIcon(JList<?> list, IconFactory.GLYPH entry1, IconFactory.GLYPH entry2, Color color)

    • assignTabIcon

      public static void assignTabIcon(JTabbedPane tabbedPane, int tabIndex, IconFactory.GLYPH entry)

    • bottomBorder

      public static TitledBorder bottomBorder(char symbol, boolean solid)

    • doubleIcon

      public static Icon doubleIcon(IconFactory.GLYPH entry1, IconFactory.GLYPH entry2, float scalingFactor, Color color)

    • doubleLetterIcon

      public static Icon doubleLetterIcon(char letter1, char letter2, boolean solid, float scalingFactor, Color color)
      Creates a two-letter icon (e.g., "CT"), analogous to doubleIcon(GLYPH, GLYPH, float, Color) but built from two plain characters rather than IconFactory.GLYPH entries. Useful for JMenuItem icons that combine single-letter tags, such as the "C"(hannel)/"T"(frame) Path Manager tags.
      Parameters:
      letter1 - the first (left) letter, e.g., 'C'
      letter2 - the second (right) letter, e.g., 'T'
      solid - whether the letters are rendered using the solid (vs. regular) weight font
      scalingFactor - the icon's scaling factor relative to the default size
      color - the icon's color
      Returns:
      the icon

    • doubleLetterIcon

      public static Icon doubleLetterIcon(char letter1, char letter2, Color color)
      Convenience method for doubleLetterIcon(char, char, boolean, float, Color) using a scaling factor of 1f and solid font weight.
      Parameters:
      letter1 - the first (left) letter, e.g., 'C'
      letter2 - the second (right) letter, e.g., 'T'
      color - the icon's color
      Returns:
      the icon

    • assignDoubleLetterIcon

      public static void assignDoubleLetterIcon(JMenuItem item, char letter1, char letter2, boolean solid)
      Assigns a two-letter icon (see doubleLetterIcon(char, char, Color)) to a menu item, including its disabled state.
      Parameters:
      item - the menu item to be assigned an icon
      letter1 - the first (left) letter, e.g., 'C'
      letter2 - the second (right) letter, e.g., 'T'
      solid - whether the letters are rendered using the solid (vs. regular) weight font

    • notificationIcon

      public static Icon notificationIcon(Icon icon, Color dotColor, Color ringColor)
      Overlays a small notification dot on an icon's upper right corner within the icon's own bounds (the icon's reported size is unchanged).
      Parameters:
      icon - the source icon
      dotColor - the dot's fill color
      ringColor - contrast ring color around the dot, or null for no ring
      See Also:

    • assignIcon

      public static void assignIcon(AbstractButton button, IconFactory.GLYPH glyph, Color color, float scalingFactor)

    • assignIcon

      public static void assignIcon(AbstractButton button, IconFactory.GLYPH glyph, Color defaultColor, Color disabledColor, float scalingFactor)

    • assignIcon

      public static void assignIcon(AbstractButton button, IconFactory.GLYPH defaultGlyph, IconFactory.GLYPH selectedGlyph, float scalingFactor)

    • assignIcon

      public static void assignIcon(AbstractButton button, IconFactory.GLYPH defaultGlyph, IconFactory.GLYPH selectedGlyph, Color color, float scalingFactor)

    • assignIcon

      public static void assignIcon(AbstractButton button, IconFactory.GLYPH defaultGlyph, IconFactory.GLYPH selectedGlyph, Color defaultColor, Color selectedColor, float scalingFactor)

    • assignIcon

      public static void assignIcon(AbstractButton button, IconFactory.GLYPH defaultGlyph, IconFactory.GLYPH selectedGlyph)

    • assignIcon

      public static void assignIcon(JMenuItem item, IconFactory.GLYPH defaultGlyph)

    • assignIcon

      public static void assignIcon(JMenuItem item, char symbol, boolean solid, Color color)

    • assignDoubleIcon

      public static void assignDoubleIcon(JMenuItem menuItem, IconFactory.GLYPH defaultIcon, IconFactory.GLYPH selectedIcon, IconFactory.GLYPH secondaryIcon)

    • assignNotification

      public static void assignNotification(AbstractButton button, Color dotColor)
      Decorates a button's icon(s) with a notification dot in the upper right corner, wrapping whichever icons are already assigned (including selected/disabled states for a JToggleButton)
      Parameters:
      button - the button to decorate
      dotColor - the dot's fill color (e.g., Color.RED)
      See Also:

    • defaultColor

      public static Color defaultColor()

    • secondaryColor

      public static Color secondaryColor()

    • selectedColor

      public static Color selectedColor()

    • disabledSelectedColor

      public static Color disabledSelectedColor()
      Returns:
      a faded version of selectedColor(), for a disabled icon/button that should still read as "selected"/"active".

    • nodeIcon

      public static Icon nodeIcon(Color color)

    • nodeIcon

      public static Icon nodeIcon(Color color, boolean isLeaf, boolean isExpanded)

    • nodeIconMulticolor

      public static Icon nodeIconMulticolor(boolean isLeaf, boolean isExpanded)

    • accentIcon

      public static Icon accentIcon(Color color, boolean squarify)

    • fixedWidthIcon

      public static Icon fixedWidthIcon(Icon icon, Icon refIcon)
      Wraps an icon in a fixed-width icon, centering it within a common reference.
      Parameters:
      icon - the icon to be matched to reference
      refIcon - reference icon, setting the target width
      Returns:
      the centered fixed-width icon

    • fixedWidthIcon

      public static Icon fixedWidthIcon(Icon icon, int refWidth)
      Wraps an icon in a fixed-width icon, centering it within a common reference.
      Parameters:
      icon - the icon to be matched to reference
      refWidth - the target width
      Returns:
      the centered fixed-width icon

    • defaultSize

      public static int defaultSize()