|
|
The toolbar framework forms an inevitable part of the Web NMS client user interface. There are two types of toolbars in Web NMS. One is the main toolbar that is displayed in the main frame just below the menu bar while the other one is that which is displayed inside the internal frames (e.g., Map toolbar). Every default NMS panel displayed in the client GUI is associated with a corresponding toolbar.
The toolbar comprises several buttons which vary as per the panel displayed in the client. Hence, the toolbar is known as panel specific in function. The toolbar buttons are designed to replicate the same function as some menu or menu item, which is also associated with the same panel as that the toolbar. The Web NMS toolbar framework is driven by XML and the toolbar buttons can be configured through the toolbar configuration file (i.e. toolbar.xml). The toolbar gets displayed for all three types of deployed clients.
The following image shows the general structure of the Toolbar :
The explanation of the highlighted areas in the above shown toolbar image is as follows :
The Dragged area, Hide textured area and Show textured area
By default, the dragged textured area is specific to the Map panel. It is possible to drag and place the toolbar anywhere in the panel. The toolbar can be placed horizontally, vertically and kept detached from the panel.
Hide or Show textured area enables you to hide or view the toolbar and it cannot be dragged.You need to click the displayed "dotted lines" to hide or show the toolbar.
The Toolbar buttons
The toolbar buttons perform the same actions as that of the menu items. There are two types of toolbar buttons as given below:
Default toolbar buttons
The function of the default toolbar buttons remain constant regardless of the panels where they are used. Hence, these toolbar buttons can be used in any panel including the user defined panels.
Panel specific toolbar buttons:
These toolbar buttons are specific to each panel. Hence, these buttons cannot be used in other panels.
The Separators
The Separators are used for just grouping the buttons and do not have any functional significance.
About the Toolbar Configuration File
The toolbar configuration file i.e. toolbar.xml is an XML based file, which contains the declaration of all the toolbar buttons that are to be displayed in the client GUI on selecting an NMS panel. This toolbar.xml file is located in <Web NMS Home>/html/defaultsToAllUsers directory. It is located in this directory because irrespective of the user, the toolbar.xml file must be accessible and the client GUI of the user must display the toolbar in the main frame.
The entries of the toolbar buttons in the toolbar.xml file for a panel is given in the following manner :
<PANEL-KEY name="NmsListView">
<TOOLBAR-BUTTON action_command="Back" mouseoverimage="../images/goback_mo.png"
image="../images/goback.png" tooltip="Go Back to Previous"/>
<TOOLBAR-BUTTON action_command="Forward" mouseoverimage="../images/goforward_mo.png" image="../images/goforward.png" tooltip="Go Forward to Next"/>
<TOOLBAR-BUTTON name="Separator"/>
<TOOLBAR-BUTTON action_command="Refresh" mouseoverimage="../images/refresh_mo.png" image="../images/refresh.png" tooltip="Refresh"/>
.
.
</PANEL-KEY>
From the above declaration it can be understood, that for the Network Database panel (i.e. PANEL-KEY is "NmsListView"), the set of toolbar buttons to be displayed can be specified inside the <TOOLBAR-BUTTON></TOOLBAR-BUTTON> tags in the toolbar.xml file. Similarly, toolbar buttons can be specified for all the panels (even user defined panels) by making respective panel entries (with specific PANEL-KEY value ) in the toolbar.xml file.
For displaying the toolbar buttons by default on the main frame (irrespective of the selected panel), you must make a separate entry in this file as given below :
<PANEL-KEY name="Default">
<TOOLBAR-BUTTON action_command="Back" mouseoverimage="../images/goback_mo.png" image="../images/goback.png" tooltip="Go Back to Previous"/>
<TOOLBAR-BUTTON action_command="Forward" mouseoverimage="../images/goforward_mo.png" image="../images/goforward.png" tooltip="Go Forward to Next"/>
<TOOLBAR-BUTTON name="Separator"/>
</PANEL-KEY>
If you want to configure the display of toolbar buttons for any specific user, then you must keep a configured toolbar.xml file under the <Web NMS Home>/root/<username> directory. By this, the respective user alone (on logging in) can view the set of configured toolbar buttons on logging into the client.
|
|