Package docking.util.image

Class ToolIconURL

java.lang.Object
docking.util.image.ToolIconURL
All Implemented Interfaces:
Comparable<ToolIconURL>
public class ToolIconURL extends Object implements Comparable<ToolIconURL>
Container class for an icon and its location. If the location is not valid, then a default "bomb" icon is used as the icon.

  • Field Details

    • LARGE_ICON_SIZE

      public static final int LARGE_ICON_SIZE
      The large icon size (height and width)
      See Also:

    • MEDIUM_ICON_SIZE

      public static final int MEDIUM_ICON_SIZE
      The medium icon size (height and width)
      See Also:

    • SMALL_ICON_SIZE

      public static final int SMALL_ICON_SIZE
      The small icon size (height and width)
      See Also:

  • Constructor Details

    • ToolIconURL

      public ToolIconURL(String location)
      Constructor
      Parameters:
      location - filename for the icon (relative or absolute)

    • ToolIconURL

      public ToolIconURL(String location, byte[] bytes)

  • Method Details

    • compareTo

      public int compareTo(ToolIconURL that)
      Specified by:
      compareTo in interface Comparable<ToolIconURL>

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • isAnimated

      public boolean isAnimated()
      Returns true if the Icon is an animated image.

      WARNING: This call may block the Swing thread for up to MAX_IMAGE_LOAD_TIME milliseconds the first time it is called!

      Returns:
      true if animated

    • getLocation

      public String getLocation()
      Return the location of this icon
      Returns:
      the location of this icon

    • getSmallIcon

      public ImageIcon getSmallIcon()
      Return the icon as SMALL_ICON_SIZE pixel size.
      Returns:
      the icon

    • getIcon

      public ImageIcon getIcon()
      Return the icon as LARGE_ICON_SIZE pixel size.
      Returns:
      the icon

    • getIconBytes

      public byte[] getIconBytes()
      Returns the icon bytes
      Returns:
      the bytes