com.ibm.as400.opnav
Class WindowsToolBarInfo

java.lang.Object
  |
  +--com.ibm.as400.opnav.WindowsToolBarInfo

public class WindowsToolBarInfo
extends java.lang.Object

A data entity which describes the toolbar for an Operations Navigator plug-in. WindowsToolBarInfo supplies the resource ID of the toolbar bitmap, and an array of TBButtonDescriptors which contain the control information associated with each toolbar button. An instance of WindowsToolBarInfo is returned to Operations Navigator by the plug-in's implementation of WindowsListManager.getWindowsToolBarInfo.

The bitmap for the toolbar must be included in the Windows resource DLL associated with the plug-in.

Since:
v4r5m0
See Also:
WindowsListManager, TBButtonDescriptor

Constructor Summary
WindowsToolBarInfo(int bitmapID, TBButtonDescriptor[] tbButtons)
          Constructs a WindowsToolBarInfo object.
 
Method Summary
 int getBitmapID()
          Returns the resource ID of the toolbar bitmap.
 TBButtonDescriptor[] getButtons()
          Returns the list of button descriptors for the toolbar buttons.
 void setBitmapID(int bitmapID)
          Sets the resource ID of the toolbar bitmap.
 void setButtons(TBButtonDescriptor[] tbButtons)
          Sets the list of button descriptors for the toolbar buttons.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

WindowsToolBarInfo

public WindowsToolBarInfo(int bitmapID,
                          TBButtonDescriptor[] tbButtons)
Constructs a WindowsToolBarInfo object.
Parameters:
bitmapID - the resource ID of the toolbar bitmap defined in the plug-in's resource DLL.
tbButtons - the list of button descriptors for the toolbar buttons.
Since:
v4r5m0
Method Detail

getBitmapID

public int getBitmapID()
Returns the resource ID of the toolbar bitmap.
Returns:
the resource ID of the toolbar bitmap defined in the plug-in's resource DLL.
Since:
v4r5m0

setBitmapID

public void setBitmapID(int bitmapID)
Sets the resource ID of the toolbar bitmap.
Since:
v4r5m0

getButtons

public TBButtonDescriptor[] getButtons()
Returns the list of button descriptors for the toolbar buttons.
Returns:
an array of TBButtonDescriptors which contain the control information associated with each toolbar button.
Since:
v4r5m0

setButtons

public void setButtons(TBButtonDescriptor[] tbButtons)
Sets the list of button descriptors for the toolbar buttons.
Parameters:
tbButtons - an array of TBButtonDescriptors which contain the control information associated with each toolbar button.
Since:
v4r5m0