votorola.a.web
Class NavBar

java.lang.Object
  NavBar

@ThreadSafe
public abstract class NavBar
extends Object

A navigation bar, containing a series of tabs.

Nested Class Summary

(package private) static class

NavBar.SessionScope Session scope for instances of NavBar.

Field Summary

(package private) static int

DEFAULT_TAB_INDEX Designating the left-hand tab (zero) as the default view.

Constructor Summary

NavBar()

Method Summary

(package private) NavBar.HashKey	hashKey() The hash key for this bar's session scope.
RequestCycleRunner	lastRunner(VRequestCycle cycle) Returns the runner for the last page viewed beneath this bar; or, if none was viewed, the runner of the left-hand tab.
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 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

Field Detail

DEFAULT_TAB_INDEX

static final int DEFAULT_TAB_INDEX

Designating the left-hand tab (zero) as the default view.

See Also:

lastRunner(VRequestCycle), Constant Field Values

Constructor Detail

NavBar

public NavBar()

Method Detail

hashKey

NavBar.HashKey hashKey()

The hash key for this bar's session scope.

lastRunner

public final RequestCycleRunner lastRunner(VRequestCycle cycle)

Returns the runner for the last page viewed beneath this bar; or, if none was viewed, the runner of the left-hand tab.

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 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