com.ibm.as400.opnav
Class WindowsIconDescriptor

java.lang.Object
  |
  +--com.ibm.as400.opnav.IconDescriptor
        |
        +--com.ibm.as400.opnav.WindowsIconDescriptor

public class WindowsIconDescriptor
extends IconDescriptor

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

This class will not be supported when Operations Navigator is ported to a pure Java implementation. Components should use the IconDescriptor class at that time.

Since:
v5r1m0
See Also:
IconManager

Constructor Summary
WindowsIconDescriptor()
          Constructs a Windows icon descriptor.
WindowsIconDescriptor(boolean cached)
          Constructs a Windows icon descriptor.
WindowsIconDescriptor(boolean cached, int index)
          Constructs a Windows icon descriptor.
 
Method Summary
 int getIndex()
          Returns the index into the plug-in's resource DLL of the icon for the object.
 void setIndex(int index)
          Sets the index into the plug-in's resource DLL of the icon for the object.
 
Methods inherited from class com.ibm.as400.opnav.IconDescriptor
getCached, getLocation, setCached, setLocation
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WindowsIconDescriptor

public WindowsIconDescriptor()
Constructs a Windows icon descriptor.

A Windows icon descriptor constructed in this way indicates that the icon at index 0 will be used from the component's Windows resource dll. The descriptor will be cached and the IconManager will not be called again for the type in the list.

Since:
v5r1m0

WindowsIconDescriptor

public WindowsIconDescriptor(boolean cached)
Constructs a Windows icon descriptor.

A Windows icon descriptor constructed in this way indicates that the icon at index 0 will be used from the component's Windows resource dll.

Since:
v5r1m0

WindowsIconDescriptor

public WindowsIconDescriptor(boolean cached,
                             int index)
Constructs a Windows icon descriptor.

A Windows icon descriptor constructed in this way indicates the index to be used from the component's Windows resource dll and whether the index is cached and used for other objects of the same type.

Since:
v5r1m0
Method Detail

getIndex

public int getIndex()
Returns the index into the plug-in's resource DLL of the icon for the object.
Returns:
The icon index into the plug-in's resource DLL.

setIndex

public void setIndex(int index)
Sets the index into the plug-in's resource DLL of the icon for the object.