mvt.help
Class HelpIndexList

java.lang.Object
  |
  +--mvt.help.HelpIndexList

public class HelpIndexList

extends java.lang.Object

A list of HelpIndexNodes. This handles the list providing functionality for the nodes like:

• Searching (forward and backwards).

Author:

Patrick Simek

See Also:

tools.help.HelpIndexNode

Field Summary

(package private) java.util.Vector

indexNode List of HelpIndexNodes.

Constructor Summary

HelpIndexList()
Constructor - initializes the list.

Method Summary

void	addHelpNode(HelpIndexNode node) Add a HelpIndexNode to the list.
java.util.Vector	getHelpNodes() Returns the list of all the Nodes.
int	reverseSearch(java.lang.String s, int index) Searches backwards from the current index.
int	search(java.lang.String s) Searches the index for the false in s.
int	search(java.lang.String s, int index) Searches the lists of IndexNodes to find a particular instance.

Methods inherited from class java.lang.Object

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

Field Detail

indexNode

java.util.Vector indexNode

List of HelpIndexNodes.

Constructor Detail

HelpIndexList

public HelpIndexList()

Constructor - initializes the list.

Method Detail

addHelpNode

public void addHelpNode(HelpIndexNode node)

Add a HelpIndexNode to the list.

Parameters:

node - contains all the information eneded for the list.

See Also:

tools.help.HelpIndexNode

getHelpNodes

public java.util.Vector getHelpNodes()

Returns the list of all the Nodes.

Returns:

a Vector that contains all the nods.

See Also:

Vector

search

public int search(java.lang.String s)

Searches the index for the false in s.

Parameters:

s - the string to be searched for.

Returns:

the index at which the index is located. If the string is not found -1 is returned.

search

public int search(java.lang.String s,
                  int index)

Searches the lists of IndexNodes to find a particular instance. If index > list.length( )-1 then -1 is returned (can't go any further).

Parameters:

s - the string to be searched for.

index - where to start from.

Returns:

the index at which the string is located. If s is not found -1 is returned.

reverseSearch

public int reverseSearch(java.lang.String s,
                         int index)

Searches backwards from the current index. If the current index is greater than the length of the list, the list.length( )-1 is used.

Parameters:

s - a string to search for.

index - the current index to start from.

Returns:

the index at which the string is located. If s is not found -1 is returned.