oracle.help.common.navigator
Interface BaseNavigator

All Known Implementing Classes:

Navigator

public interface BaseNavigator

The BaseNavigator interface defines a set of methods common to all navigators. Navigators can all be initialized with a set of views, and then views may be dynamically added and removed as necessary. Navigators also maintain topic selection, and they also correspond to types and labels.

Method Summary

void	addView(oracle.help.common.View view) Add a view to the navigator.
oracle.help.common.Topic	getCurrentSelection() Get the Topic currently selected in the navigator.
java.lang.String	getDefaultLabel() Get the default label for the navigator.
java.lang.String	getLabel() Get the label corresponding to the navigator.
java.lang.String	getType() Get the type corresponding to the navigator.
void	initNavigator(oracle.help.common.View[] initialViews) Initialize the navigator with the initialViews.
void	removeView(oracle.help.common.View view) Remove the specified view from the navigator.

Method Detail

initNavigator

public void initNavigator(oracle.help.common.View[] initialViews)

Initialize the navigator with the initialViews.

addView

public void addView(oracle.help.common.View view)

Add a view to the navigator.

removeView

public void removeView(oracle.help.common.View view)

Remove the specified view from the navigator.

getCurrentSelection

public oracle.help.common.Topic getCurrentSelection()

Get the Topic currently selected in the navigator.

getDefaultLabel

public java.lang.String getDefaultLabel()

Get the default label for the navigator.

getType

public java.lang.String getType()

Get the type corresponding to the navigator.

getLabel

public java.lang.String getLabel()

Get the label corresponding to the navigator.