A NavItem provides three optional subcomponents, as well as properties for controlling rendering priority within the container, secured access and display of the item. The subcomponents are the search, context and action container components.

Applications that use the global context area add their NavItems to the NavContainer’s NavItems list within their own config layer using the += syntax.

NavItems contain the following configuration:

Name

Type

Description

id

string

IDs are optional. If you use an ID, it must be unique to the IDs that are specified by other navigational components within the global context area.

The ID is included when rendering the NavItem component within the DOM to enable custom CSS files to target the styling of the NavItem without having to modify the JSP file directly.

available

Boolean

Determines if the NavItem is available. If false, the NavItem will not be displayed in the UI

sortPriority

integer

Determines the position of the NavItem relative to other NavItems defined by the NavContainer. The NavContainer sorts the NavItems by this property in ascending order. Lower sort order numbers are rendered first.

accessRight

string

Defines the access right required to use the NavItem. If the agent does not have this right, the NavItem will not be included within the UI.

labelResourceKey

string

The resource key that identifies the label that appears under the NavItem in the UI.

resourceBundleName

string

Identifies the name of the resource bundle used to look up all resourced values.

navSearch

path

References the search subcomponent.

navContext

path

References the context subcomponent.

navActionContainer

path

References the navActionContainer subcomponent.


Copyright © 1997, 2013 Oracle and/or its affiliates. All rights reserved. Legal Notices