com.ibm.as400.opnav
Class IconDescriptor

java.lang.Object
  |
  +--com.ibm.as400.opnav.IconDescriptor
Direct Known Subclasses:
WindowsIconDescriptor

public class IconDescriptor
extends java.lang.Object

Describes an the icon to be used for an object. An IconDescriptor provides the icon location for an object and whether it should be cached for other objects of the same type in the list.

This class is not supported until Operations Navigator is ported to a pure Java implementation. Components should use the WindowsIconDescriptor class until that time.

Since:
v5r1m0
See Also:
IconManager, WindowsIconDescriptor

Constructor Summary
IconDescriptor()
          Constructs an icon descriptor.
IconDescriptor(boolean cached)
          Constructs an icon descriptor.
IconDescriptor(boolean cached, java.lang.String location)
          Constructs an icon descriptor.
 
Method Summary
 boolean getCached()
          Returns whether this IconDescriptor should be cached and used for subsequent requests for icons for the same object type in the list.
 java.lang.String getLocation()
          Returns the location path of the icon for this IconDescriptor.
 void setCached(boolean cached)
          Sets whether this IconDescriptor should be cached and used for subsequent requests for icons for the same object type in the list.
 void setLocation(java.lang.String location)
          Sets the location path of the icon for this IconDescriptor.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

IconDescriptor

public IconDescriptor()
Constructs an icon descriptor.

An icon descriptor constructed in this way indicates that the default icon for this object type will be used. The descriptor will be cached and the IconManager will not be called again for the type in the list.

Since:
v5r1m0

IconDescriptor

public IconDescriptor(boolean cached)
Constructs an icon descriptor.

An icon descriptor constructed in this way indicates that the default icon for this object type will be used.

Since:
v5r1m0

IconDescriptor

public IconDescriptor(boolean cached,
                      java.lang.String location)
Constructs an icon descriptor.
Since:
v5r1m0
Method Detail

getLocation

public java.lang.String getLocation()
Returns the location path of the icon for this IconDescriptor.
Returns:
null if no location path has been specified.

setLocation

public void setLocation(java.lang.String location)
Sets the location path of the icon for this IconDescriptor.

getCached

public boolean getCached()
Returns whether this IconDescriptor should be cached and used for subsequent requests for icons for the same object type in the list.
Returns:
true if it is to be cached, false otherwise.

setCached

public void setCached(boolean cached)
Sets whether this IconDescriptor should be cached and used for subsequent requests for icons for the same object type in the list.