org.carewebframework.help.javahelp

Class HelpView

java.lang.Object

org.carewebframework.help.javahelp.HelpView

All Implemented Interfaces:

IHelpView

Direct Known Subclasses:

HelpViewSearch

public class HelpView
extends Object
implements IHelpView

IHelpView implementation for JavaHelp navigator views.

Field Summary

Fields

Modifier and Type	Field and Description
protected javax.help.NavigatorView	view

Constructor Summary

Constructors

Constructor and Description
HelpView(javax.help.NavigatorView view, HelpViewType viewType) Create help view for given navigator view and view type.

Method Summary

Methods

Modifier and Type	Method and Description
protected DefaultMutableTreeNode	getDataAsTree() Invokes the "getDataAsTree" method on the underlying view, if such a method exists.
String	getName() Returns the view name.
protected HelpTopic	getTopic(TreeNode node) Retrieves the help topic associated with the given node.
HelpTopicNode	getTopicTree() Returns the root node of the topic tree.
HelpViewType	getViewType() Returns the view type.

Methods inherited from class java.lang.Object

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

Field Detail

view

protected final javax.help.NavigatorView view

Constructor Detail

HelpView

public HelpView(javax.help.NavigatorView view,
        HelpViewType viewType)

Create help view for given navigator view and view type.

Parameters:

view - JavaHelp navigator view.

viewType - View type.

Method Detail

getTopic

protected HelpTopic getTopic(TreeNode node)

Retrieves the help topic associated with the given node. Note that this also maintains a map of topic id --> topic mappings in the parent help set.

Parameters:

node - Tree node.

Returns:

A help topic instance.

getDataAsTree

protected DefaultMutableTreeNode getDataAsTree()

Invokes the "getDataAsTree" method on the underlying view, if such a method exists.

Returns:

The view's topic tree, or null if none.

getTopicTree

public HelpTopicNode getTopicTree()

Returns the root node of the topic tree.

Specified by:

getTopicTree in interface IHelpView

getName

public String getName()

Returns the view name.

Specified by:

getName in interface IHelpView

getViewType

public HelpViewType getViewType()

Returns the view type.

Specified by:

getViewType in interface IHelpView