com.ibm.as400.opnav
Interface WindowsListManager

All Known Implementing Classes:
NativeListManager

public interface WindowsListManager

An interface which defines Windows platform-specific methods. A WindowsListManager implementation is used to identify the icons which represent the plug-in's objects in the Operations Navigator hierarchy, and to supply platform-specific control information for the plug-in's custom toolbars. This interface should be implemented by the same class that implements ListManager.

When Operations Navigator is ported to a pure Java implementation, this interface will no longer be required. At that time, the plug-in's icons and toolbars will be re-implemented using standard image files supported in the Java environment.

Since:
v4r5m0
See Also:
ListManager

Field Summary
static int DEFAULT_ICON
          Indicates that the default icon is requested.
static int OPEN_ICON
          Indicates that the open icon is requested.
 
Method Summary
 int getIconIndex(ItemIdentifier item, int flags)
          Returns the icon index into the plug-in's resource DLL for a list object.
 WindowsToolBarInfo getWindowsToolBarInfo(ObjectName selectedContainer)
          Returns the toolbar information for a container in the Operations Navigator hierarchy.
 

Field Detail

DEFAULT_ICON

public static final int DEFAULT_ICON
Indicates that the default icon is requested.

OPEN_ICON

public static final int OPEN_ICON
Indicates that the open icon is requested.
Method Detail

getIconIndex

public int getIconIndex(ItemIdentifier item,
                        int flags)
Returns the icon index into the plug-in's resource DLL for a list object.

Called repeatedly when populating the view of a container. Long running operations should be avoided.

Parameters:
item - The item identifier for the object whose icon index is to be retrieved.
flags - A constant which indicates the type of icon requested.
Returns:
The index into the plug-in's resource DLL of the icon for the object.
Since:
v4r5m0
See Also:
ItemIdentifier

getWindowsToolBarInfo

public WindowsToolBarInfo getWindowsToolBarInfo(ObjectName selectedContainer)
Returns the toolbar information for a container in the Operations Navigator hierarchy. The toolbar information includes the resource ID of the toolbar bitmap, and an array of TBButtonDescriptors which contain control information associated with each toolbar button.
Parameters:
selectedContainer - An ObjectName which identifies the folder in the main Operations Navigator window that the user is currently working with.
Returns:
An instance of WindowsToolBarInfo.
Since:
v4r5m0
See Also:
WindowsToolBarInfo