Oracle Fusion Middleware Tag Reference for Oracle ADF Faces 12c (12.2.1.4.0) E81455-03

# <af:navigationPane>

af:navigationPane navigationPane navigation pane

UIComponent class: oracle.adf.view.rich.component.rich.nav.RichNavigationPane
Component type: oracle.adf.RichNavigationPane

Naming container: Yes. When referring to children of this component ("partialTriggers", `findComponent()`, etc.), you must prefix the child's ID with this component's ID and a colon (':')

The navigationPane component creates a series of navigation items representing one level in a navigation hierarchy. These items may either be explicitly added as children using the commandNavigationItem component or a model of type `org.apache.myfaces.trinidad.model.MenuModel` may be bound to the navigationPane component. If a MenuModel is bound, a level along the focus path, or the next level down, will be rendered. A node that is on the focus path will be rendered as "selected".

Note: The 'level' attribute is temporary. It is used to indicate the level along the focusPath to render. It will likely be replaced with an el expression in a future release.

The MenuModel implementation that are supported out-of-the-box, namely `org.apache.myfaces.trinidad.model.ProcessMenuModel` and `org.apache.myfaces.trinidad.model.XmlMenuModel`, know how to go from the current viewId to the focusRowKey. Notice that the MenuModel has no special knowledge of page navigation and places no requirements on the nodes that go into the tree. The nodes in the tree are stamped out using the 'nodeStamp' facet, which should contain a commandNavigationItem component. This allows the default actionListener mechanism to be used for page navigation.

Note: When using Facelets for the page declaration language (PDL), the 'nodestamp' facet should still contain only one commandNavigationItem. Multiple components are not supported by this facet.

NavigationPane with hint='buttons' and hint='bar' look very similar. They have different separators. Additionally, here are the differences:

- navigationPane with hint='buttons'

- Used as global navigation items
- Generally used in global navigation area of the page
- When there is not have enough horizontal space to display all items, they wrap to the next line

- navigationPane with hint='bar'

- Used as 4th level navigation tabs
- When there is not have enough horizontal space to display all items, the overflow compressed layout manager is used and overflow button(s) are displayed.

The navigationPane component does not render on a printable page (<af:showPrintablePageBehavior>).

## Geometry Management

- This component can be stretched by a parent layout component that stretches its children if:
  - hint="tabs"
  - hint="bar"

This component cannot be stretched by a parent layout component that stretches its children if:

- hint="buttons"
- hint="choice"

- This component does not stretch its children.

## Supports Compressed Layout

NavigationPane with hint='tabs' or hint='bar' support compressed layout. For hint='bar', when the content is compressed the overflow compressed layout manager is used. For hint='tabs', when the content is compressed either overflow or conveyor belt compressed layout manager will be used. For this case, the compressed layout manager used depends on the assignment of the -tr-layout-type skinning key (see skinning documentation). In order for a compressed layout component to work properly, it must be part of a supported layout on the page.

A compressed layout (overflow or conveyor belt) component requires that it is either:

- in a container that stretches its children, or
- in a container that has a set width.

Under these circumstances, when the compressed layout component is larger than the parent container, the compressed layout component will display buttons to support its particular compressed layout mode (overflow or conveyor belt).

For overflow compressed layout mode, selecting the overflow button(s) will show a popup containing the items that didn't fit on the page.

For conveyor belt compressed layout mode, selecting the conveyor belt buttons will roll the shown content. In addition, there is a conveyor belt droplist button that shows a popup containing all of the managed items.

Setting up a compressed layout (overflow or conveyor belt) component with the following layouts is not supported. If you use one of these layouts, you may have unexpected and inconsistent results:

- in a container that does not stretch its children.
- in a container that displays multiple children horizontally without explicit sizes for each child. For example, a panelGroupLayout with layout='horizontal' would be invalid, but panelSplitter is OK because it has an explicitly set splitter position.
- setting the compressed layout component with a styleClass or inlineStyle that assigns a percentage width value. Note that this includes assigning styleClass='AFStretchWidth' on a compressed layout component.

## Screen Shot(s)

NavigationPane component with hint="tabs".

## Code Example(s)

    <af:navigationPane var="node" value="#{xmlMenuModel}" id="np1">
      <f:facet name="nodeStamp">
        <af:commandNavigationItem text="#{node.label}"
                                  action="#{node.doAction}"
                                  destination="#{node.destination}"
                                  id="cni1"/>
      </f:facet>
    </af:navigationPane>

## Events

Type | Phases | Description
--- | --- | ---
oracle.adf.view.rich.event.ItemEvent | Apply, Request, Values | The itemEvent is triggered when a containing object has an event on one of its child items. For example, a panelTabbed will launch an itemEvent of type 'remove' for one of its child tabs.
org.apache.myfaces.trinidad.event.AttributeChangeEvent | Invoke, Application, Apply, Request, Values | Event delivered to describe an attribute change. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change event might include the width of a column that supported client-side resizing.

## Supported Facets

Name | Description
--- | ---
nodeStamp | the component to use to stamp each element in the navigation. A CommandNavigationItem is expected.

## Attributes

Name | Type | Supports EL? | Description
attributeChangeListener | javax.el.MethodExpression | Only EL | a method reference to an attribute change listener. Attribute change events are not delivered for any programmatic change to a property. They are only delivered when a renderer changes a property without the application's specific request. An example of an attribute change events might include the width of a column that supported client-side resizing.
binding | oracle.adf.view.rich.component.rich.nav.RichNavigationPane | Only EL | an EL reference that will store the component instance on a bean. This can be used to give programmatic access to a component from a backing bean, or to move creation of the component to a backing bean.
clientComponent | boolean | Yes | Default Value: false whether a client-side component will be generated. A component may be generated whether or not this flag is set, but if client Javascript requires the component object, this must be set to true to guarantee the component's presence. Client component objects that are generated today by default may not be present in the future; setting this flag is the only way to guarantee a component's presence, and clients cannot rely on implicit behavior. However, there is a performance cost to setting this flag, so clients should avoid turning on client components unless absolutely necessary. For the components outputText and outputFormatted, setting the clientComponent to true will render id attribute for the html DOM. This ID attribute can alternatively be generated by setting oracle.adf.view.rich.SUPPRESS_IDS to "auto" in web.xml.
customizationId | String | Yes | This attribute is deprecated. The 'id' attribute should be used when applying persistent customizations. This attribute will be removed in the next release.
disabled | boolean | Yes | Default Value: false whether the component is disabled.
hint | String | Yes | Valid Values: tabs, bar, buttons, choice, list Default Value: tabs how the navigational items are displayed. Options are: bar - display items separated by a bar buttons - display items with a vertical separator between them choice - display items in a popup list when icon is clicked list - display items in a bulleted list tabs - display each item in a tab
id | String | No | the identifier for the component. Every component may be named by a component identifier that must conform to the following rules: They must start with a letter (as defined by the Character.isLetter() method) or underscore ( _ ). Subsequent characters must be letters (as defined by the Character.isLetter() method), digits as defined by the Character.isDigit() method, dashes ( - ), or underscores ( _ ). To minimize the size of responses generated by JavaServer Faces, it is recommended that component identifiers be as short as possible. If a component has been given an identifier, it must be unique in the namespace of the closest ancestor to that component that is a NamingContainer (if any).
inlineStyle | String | Yes | the CSS styles to use for this component. This is intended for basic style changes. The inlineStyle is a set of CSS styles that are applied to the root DOM element of the component. Be aware that because of browser CSS precedence rules, CSS rendered on a DOM element takes precedence over external stylesheets like the skin file. Therefore skins will not be able to override what you set on this attribute. If the inlineStyle's CSS properties do not affect the DOM element you want affected, then you will have to create a skin and use the skinning keys which are meant to target particular DOM elements, like ::label or ::icon-style.
itemRemoval | String | Yes | Valid Values: none, all, allExceptLast Default Value: none Determines if item removal is enabled. Item removal is only supported if hint=tabs. This attribute supports these itemRemoval types: none - item removal is not enabled. This is the default value. all - item removal is enabled on all tabs, regardless if they are disclosed. The last tab in the navigationPane can be removed. allExceptLast - item removal is enabled on all tabs, regardless if they are disclosed. The last tab in the navigationPane cannot be removed. Choosing to remove an item will cause an ItemEvent of type 'remove' to be launched. This event can be listened for on a commandNavigationItem using the itemEventListener attribute. It is up to the developer to handle this event and code the actual removal of the tab. This is because of the dynamic nature of the navigationPane component, which may have dynamic children. This also allows a finer level of control by the developer, who can then choose a custom implementation that may (for example) include warning dialogs, and control of which item gains focus after an item is removed.
level | int | Yes | Default Value: 0 the level, based on a 0 based index, in the menuModel to render based on the focusPath of the menuModel.
maxTabSize | String | Yes | Default Value: infinity the maximum tab size that is rendered by default when the tab bar has more than enough space. The maxTabSize will take into effect only when truncationStyle attribute is set. Only fixed dimension units are supported, e.g. "px", "em", "pt" (not "auto" "nor "%").
minTabSize | String | Yes | Default Value: 0px the minimum tab size that a tab can shrink to before using a compressed layout manager (overflow or conveyor belt). Only fixed dimension units are supported, e.g. "px", "em", "pt" (not "auto" "nor "%").
partialTriggers | String[] | Yes | the IDs of the components that should trigger a partial update. This component will listen on the trigger components. If one of the trigger components receives an event that will cause it to update in some way, this component will request to be updated too. Identifiers are relative to the source component (this component), and must account for NamingContainers. If your component is already inside of a naming container, you can use a single colon to start the search from the root of the page, or multiple colons to move up through the NamingContainers - "::" will pop out of the component's naming container (or itself if the component is a naming container) and begin the search from there, ":::" will pop out of two naming containers (including itself if the component is a naming container) and begin the search from there, etc.
rendered | boolean | Yes | Default Value: true whether the component is rendered. When set to false, no output will be delivered for this component (the component will not in any way be rendered, and cannot be made visible on the client). If you want to change a component's rendered attribute from false to true using PPR, set the partialTrigger attribute of its parent component so the parent refreshes and in turn will render this component.
shortDesc | String | Yes | the short description of the component. The shortDesc text may be used in two different ways, depending on the component. For components with images, the shortDesc is often used to render an HTML alt attribute for the image. Please see the accessibility guidelines section for correct alt text usage of the shortDesc attribute. shortDesc is also commonly used to render an HTML title attribute, which is used by user agents to display tooltip help text. In this case the behavior for the tooltip is controlled by the user agent, e.g. Firefox 2 truncates long tooltips. For form components, the shortDesc is displayed in a note window. For components that support the helpTopicId attribute and are not using the shortDesc as image alt text, it is recommended that helpTopicId is used instead of shortDesc as it is more flexible and provides more accessible descriptive text than the use of the title attribute.
styleClass | String | Yes | a CSS style class to use for this component. The style class can be defined in your jspx page or in a skinning CSS file, for example, or you can use one of our public style classes, like 'AFInstructionText'.
title | String | Yes | the text that describes the items. (This attribute is only applicable if the rendering hint supports it, e.g. "choice".)
truncationStyle | String | Yes | Valid Values: none, ellipsis Default Value: none the truncation style applied to tab text when the text size exceeds the tab size.
unsecure | java.util.Set | Yes | A whitespace separated list of attributes whose values ordinarily can be set only on the server, but need to be settable on the client. Currently, this is supported only for the "disabled" attribute. Note that when you are able to set a property on the client, you will be allowed to by using the the .setProperty('attribute', newValue) method, but not the .setXXXAttribute(newValue) method. For example, if you have unsecure="disabled", then on the client you can use the method .setProperty('disabled', false), while the method .setDisabled(false) will not work and will provide a javascript error that setDisabled is not a function.
value | Object | Yes | the hierarchy of navigation data - must be of type org.apache.myfaces.trinidad.model.MenuModel
var | String | No | Name of the EL variable used to reference each element of this collection. Once this component has completed rendering, this variable is removed (or reverted back to its previous value).
varStatus | String | No | Name of the EL variable used to reference the varStatus information. Once this component has completed rendering, this variable is removed (or reverted back to its previous value). The VarStatus provides contextual information about the state of the component to EL expressions. For components that iterate, varStatus also provides loop counter information. Please see the this component's documentation for the specific properties on the varStatus. The common properties on varStatus include: "model" - returns the CollectionModel for this component "index" - returns the zero based row index
visible | boolean | Yes | Default Value: true the visibility of the component. If it is "false", the component will be hidden on the client. Unlike "rendered", this does not affect the lifecycle on the server - the component may have its bindings executed, etc. - and the visibility of the component can be toggled on and off on the client, or toggled with PPR. When "rendered" is false, the component will not in any way be rendered, and cannot be made visible on the client. In most cases, use the "rendered" property instead of the "visible" property. Not supported on the following renderkits: org.apache.myfaces.trinidad.core