votorola.a.web.wic

Class NavBar

java.lang.Object

NavBar

@ThreadSafe
public abstract class NavBar
extends Object

A navigation bar containing a series of tabs.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) static class	NavBar.SessionScope Session scope for instances of NavBar.

Constructor Summary

Constructors

Constructor and Description
NavBar()

Method Summary

Methods

Modifier and Type	Method and Description
int	defaultTabIndex() The index of the default tab.
(package private) NavBar.HashKey	hashKey() The hash key for this bar's session scope.
abstract SuperTab	superTab() The tab that controls the visibility of this bar.
abstract List<NavTab>	tabList() A list of the navigation tabs contained within this bar.
NavTab	tabOfType(Class<? extends Page> pageClass, VRequestCycle cycle) Returns the first tab of a particular tab type, within this bar.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NavBar

public NavBar()

Method Detail

defaultTabIndex

public int defaultTabIndex()

The index of the default tab. The implementation of this method in class NavBar returns zero, which corresponds to the left-hand tab.

hashKey

NavBar.HashKey hashKey()

The hash key for this bar's session scope.

superTab

public abstract SuperTab superTab()

The tab that controls the visibility of this bar.

Returns:

the super-tab; or null, if this bar is always visible

tabList

public abstract List<NavTab> tabList()

A list of the navigation tabs contained within this bar.

tabOfType

public final NavTab tabOfType(Class<? extends Page> pageClass,
               VRequestCycle cycle)

Returns the first tab of a particular tab type, within this bar.

Throws:

IllegalStateException - if this bar contains no tab of the specified type