votorola.a.web.wic

Class NavTab

java.lang.Object

NavTab

Direct Known Subclasses:

SuperTab, WP_Votespace.VotespaceTab

@ThreadSafe
public abstract class NavTab
extends Object

A tab in a navigation bar, serving as a link to a page.

Constructor Summary

Constructors

Constructor and Description
NavTab()

Method Summary

Methods

Modifier and Type	Method and Description
abstract Bookmark	bookmark() The bookmark for the page to which this tab links.
boolean	isEnabled(VRequestCycle _cycle) Answers whether or not the tab is to be enabled, when it is off the selection path.
NavBar	navBar() The navigation bar that contains this tab.
Class<? extends Page>	pageClass() The class of pages to which this tab links, or null if there is no single class.
NavTab	setNavBar(NavBar navBar) Sets the navigation bar that contains this tab.
abstract String	shortTitle(VRequestCycle _cycle) A short title for this tab, suitable as the body of a link.

Methods inherited from class java.lang.Object

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

Constructor Detail

NavTab

public NavTab()

Method Detail

bookmark

public abstract Bookmark bookmark()

The bookmark for the page to which this tab links.

isEnabled

public boolean isEnabled(VRequestCycle _cycle)

Answers whether or not the tab is to be enabled, when it is off the selection path. Tabs on the selection path are always disabled. The default implementation of this method in NavTab returns true.

navBar

public final NavBar navBar()

The navigation bar that contains this tab.

Throws:

NullPointerException - if the navbar has not been set.

See Also:

setNavBar(NavBar)

setNavBar

public final NavTab setNavBar(NavBar navBar)

Sets the navigation bar that contains this tab. Called once only, during construction of the navigation bar.

Returns:

this navigation tab.

Throws:

IllegalStateException - if a second call to this method is detected, though such detection not guaranteed.

See Also:

navBar()

pageClass

public Class<? extends Page> pageClass()

The class of pages to which this tab links, or null if there is no single class. The default implementation of this method in NavTab returns the page class of this tab's bookmark.

shortTitle

public abstract String shortTitle(VRequestCycle _cycle)

A short title for this tab, suitable as the body of a link.