This element is required. It starts a menu bar definition
configuration file.
Purpose
The menu bar is located below the
banner area and provides space for the search box that is aligned
to the opposite side of the menus.
Elements and attributes
- name
- The name attribute defines the name that is used internally to
represent the menu bar. This name must be unique in the context of
all the menu bars in WSRR. Menu bars are referenced by perspectives
using the menu bar name. This attribute is required.
- menu-item
- The menu-item element defines the root of your menu-bar, and you must specify
one and only one menu-item element. The root menu-item is not displayed,
but contains multiple menu-item elements that form the top level menus
of the menu bar. Each child item of the root menu-item can then have
multiple child menu-item elements. These form the drop-downs and cascades
in the menu bar. The menu-item element includes the id, message-key,
resource bundle-name, forward, view-query-id, url, new-window, menu-item,
and custom-action elements and attributes; these are described in
the following sections:
- id
- The id attribute defines the id for the menu-item. This id must
be unique in the context of the menu items defined as part of the
same menu bar. This attribute is required
- message-key
- The message-key attribute defines the key that will be used to
lookup the locale specific display name for the menu item. This attribute
is required.
- resource-bundle-name
- The resource-bundle-name attribute defines the name of the resource
bundle that is used to resolve the message-key. The attribute is optional,
however, the WSRR web user interface module resource bundle is used
by default. The attribute must be the fully qualified name of a resource
bundle on the server class path.
- forward
- The forward attribute defines the action that will be run when
the menu item is clicked. You can specify one of the following values
for this element:
| Element |
Description |
|---|
| LoadDocument |
Navigates to a page that allows the user to
load a document into the WSRR and select the type of the document. |
| QueryWizardPrepare |
Navigates to a page that allows the user to
perform selected queries against objects stored in the registry. |
| LoadClassificationSystem |
Navigates to a page that allows the user to
load a classification system into WSRR. |
| BrowseClassificationSystems |
Navigates to a page that allows the user to
browse all classification systems that are currently loaded into WSRR. |
| ListMyFavorites |
Navigates to a page that shows the user the
collection of entities that they have added to their favorites list. |
| ImportDocuments |
Navigates to a page that allows the user to
load an import document containing content exported from a WSRR. |
| ShowPreferences |
Navigates to a page that shows the user their
WSRR web UI preference settings. |
| ListMySubscriptions |
Navigates to a page that shows the user the
collection of all subscriptions they have created. |
- The forward attribute is optional. If a value has been specified
for this attribute, no value must be specified for the view-query-id
attribute.
- view-query-id
- The view-query-id attribute defines the id of the view query that
will be run when the menu item is clicked. The id specified must match
the id of a view query defined in either the default view query definition
file or a user view query definition file. The view-query-id attribute
is optional. If a value has been specified for this attribute, no
value must be specified for the forward attribute.
- url
- The url attribute defines a URL to be visited when the menu item
is clicked.
- new-window
- The new-window attribute declares whether a URL that has been
visited should be opened in a new browser window or tab, depending
on the browser features and settings.
- menu-item
- Zero or more menu-item elements can be specified
- custom-action
- Zero or one custom-action elements can be specified. If a custom-action
element is specified, the forward and view-query-id attributes are
ignored. For details, see Custom-action element reference.
Example
The following example shows the menu-bar
element with a custom action defined, where the root item has an ID
of
menubar_root:
<menu-bar xmlns="http://www.ibm.com/xmlns/prod/serviceregistry/6/3/MenuBarDefinition"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.ibm.com/xmlns/prod/serviceregistry/6/3/MenuBarDefinition ../../schemas/MenuBarDefinition.xsd"
name="AdministratorMenuBar">
<menu-item id="menubar_root" message-key="navigationtree.service.registry">
<menu-item id="actions" message-key="menubar.actions">
<menu-item id="customaction1" message-key=" run.viewquery.wsdldocs" resource-bundle-name=" com.ibm.serviceregistry.customaction.examples.LabelsResourceBundle">
<custom-action>
…
</custom-action>
</menu-item>
</menu-item>
</menu-item>
</menu-bar>