This component represents the context area on a NavItem. It provides a descriptive label for the NavItem that is relative to the current context. The base version of the NavContext component defines layout properties such as width limits, display strings and the JavaScript code snippet to execute.

The NavContext can be a static label or a dynamic value or a customized combination of the two. Customized label strings are generated using subclasses of NavContext.

The NavContext component contains the following configuration:

Name

Type

Description

id

string

IDs are optional. However, when used, they 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 NavContext component within the DOM to enable custom CSS files to target the styling of the NavContext without having to modify the JSP file directly.

labelResourceKey

string

The resource key used to identify the text that appears as the context element of the NavItem in the UI.

Note: Because NavContext displays contextual information, it is common for this text value to be dynamic in nature, depending on the current state of the agent’s environment. As such, it is common for the getLabel() API to be overridden to provide a dynamic value.

toolTipResourceKey

string

The resource key used to identify the tooltip text that appears when hovering over the context element of the NavItem in the UI.

minWidth

integer

Identifies the minimum width allowed. Defined in pixels.

maxWidth

integer

Identifies the maximum width allowed. Defined in pixels.

javaScriptFunctionCall

string

Defines the string that is rendered as the JavaScript function for the context label. This function is executed when the user clicks the context label.

resourceBundleName

string

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


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