com.novell.application.console.snapin
Interface ToolBarSnapin

All Superinterfaces:

Snapin

All Known Implementing Classes:

AbstractToolBarMenuSnapin, SnapinToolbarObject

public interface ToolBarSnapin

extends Snapin

Provides the interface used to add toolbar items to the shell's toolbar.

Snap-ins must implement this interface to place components on the shell's toolbar.

See Also:

AbstractToolBarMenuSnapin

Method Summary

java.awt.Component

getToolBarItem() Returns a component that will be placed on the shell's toolbar.

Methods inherited from interface com.novell.application.console.snapin.Snapin

getSnapinDescription, getSnapinName, initSnapin, shutdownSnapin

Method Detail

getToolBarItem

public java.awt.Component getToolBarItem()

Returns a component that will be placed on the shell's toolbar.

This can be any object derived from Component, such as a push button, a group of buttons, a combo box, a check box, and so forth. The following program snippet shows how an image button can be placed on the toolbar.

     public Component getToolBarItem()
     {
         Image image = getImage();
         JButton button = new JButton(new ImageIcon(image));
         button.addActionListener(this);
         return button;
     }
 

Returns:

Component to be added to the toolbar.