ToolIconURL

java.lang.Object
- docking.util.image.ToolIconURL

All Implemented Interfaces:

java.lang.Comparable<ToolIconURL>
```
public class ToolIconURL
extends java.lang.Object
implements java.lang.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 Summary

Fields
Change	Modifier and Type	Field	Description
NEW	`static int`	`LARGE_ICON_SIZE`	The large icon size (height and width)
NEW	`static int`	`MEDIUM_ICON_SIZE`	The medium icon size (height and width)
NEW	`static int`	`SMALL_ICON_SIZE`	The small icon size (height and width)

Constructor Summary

Constructors
Change Constructor Description

ToolIconURL(java.lang.String location)
Constructor

ToolIconURL(java.lang.String location, byte[] bytes)

Method Summary

All Methods Instance Methods Concrete Methods
Change	Modifier and Type	Method	Description
	`int`	`compareTo(ToolIconURL that)`
	`boolean`	`equals(java.lang.Object obj)`
	`javax.swing.ImageIcon`	`getIcon()`	Return the icon as `LARGE_ICON_SIZE` pixel size.
	`byte[]`	`getIconBytes()`	Returns the icon bytes
	`java.lang.String`	`getLocation()`	Return the location of this icon
	`javax.swing.ImageIcon`	`getSmallIcon()`	Return the icon as `SMALL_ICON_SIZE` pixel size.
	`int`	`hashCode()`
	`boolean`	`isAnimated()`	Returns true if the Icon is an animated image.
	`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - LARGE_ICON_SIZE NEW
    
    public static final int LARGE_ICON_SIZE
    
    The large icon size (height and width)
    
    See Also:
    
    Constant Field Values
  - MEDIUM_ICON_SIZE NEW
    
    public static final int MEDIUM_ICON_SIZE
    
    The medium icon size (height and width)
    
    See Also:
    
    Constant Field Values
  - SMALL_ICON_SIZE NEW
    
    public static final int SMALL_ICON_SIZE
    
    The small icon size (height and width)
    
    See Also:
    
    Constant Field Values

Constructor Detail

ToolIconURL
```
public ToolIconURL(java.lang.String location)
```
Constructor

Parameters:

location - filename for the icon (relative or absolute)

ToolIconURL

public ToolIconURL(java.lang.String location,
                   byte[] bytes)

Method Detail
- compareTo
```
public int compareTo(ToolIconURL that)
```
  Specified by:
  
  compareTo in interface java.lang.Comparable<ToolIconURL>
- hashCode
```
public int hashCode()
```
  Overrides:
  
  hashCode in class java.lang.Object
- equals
```
public boolean equals(java.lang.Object obj)
```
  Overrides:
  
  equals in class java.lang.Object
- toString
```
public java.lang.String toString()
```
  Overrides:
  
  toString in class java.lang.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 java.lang.String getLocation()
```
  Return the location of this icon
  
  Returns:
  
  the location of this icon
- getSmallIcon
```
public javax.swing.ImageIcon getSmallIcon()
```
  Return the icon as SMALL_ICON_SIZE pixel size.
  
  Returns:
  
  the icon
- getIcon
```
public javax.swing.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