mvt.help
Class HelpIndexNode

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

public final class HelpIndexNode

extends java.lang.Object

A help index node. This node handles the information for the following:

• Topic - the topic that is going to be covered.
• Location - which HTML 3.2 file corresponds to the topic.
• Level - the level of indention.

Author:

Patrick Simek

Constructor Summary

HelpIndexNode()
Default constructor.

HelpIndexNode(java.lang.String topic, java.lang.String location)
Constructor.

HelpIndexNode(java.lang.String topic, java.lang.String location, int level)
Constructor.

Method Summary

boolean	equals(java.lang.Object o) Indicates whether the object is equal to this.
int	getLevel() Get the current level of idention.
java.lang.String	getLocation() Get the current location.
java.lang.String	getTopic() Get the current topic.
void	setLevel(int level) Sets the level of idention.
void	setLocation(java.lang.String location) Set the location.
void	setTopic(java.lang.String topic) Set the topic.
java.lang.String	toString() Returns the topic with spaces in front of it.

Methods inherited from class java.lang.Object

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

Constructor Detail

HelpIndexNode

public HelpIndexNode()

Default constructor. Sets topic/location to "" and level to 0.

HelpIndexNode

public HelpIndexNode(java.lang.String topic,
                     java.lang.String location)

Constructor. Takes a topic and the location, and sets the level to the default: 0.

Parameters:

topic - the topic of the help.

location - the location of the help.

HelpIndexNode

public HelpIndexNode(java.lang.String topic,
                     java.lang.String location,
                     int level)

Constructor. Takes a topic and the location, and sets the level to the default: 0.

Parameters:

topic - the topic of the help.

location - the location of the help.

level - the level of idention.

Method Detail

setLevel

public void setLevel(int level)

Sets the level of idention.

Parameters:

level - the level of idention.

getLevel

public int getLevel()

Get the current level of idention.

Returns:

the level of idention.

setTopic

public void setTopic(java.lang.String topic)

Set the topic.

Parameters:

topic - the topic of the help

getTopic

public java.lang.String getTopic()

Get the current topic.

Returns:

the topic of the help.

setLocation

public void setLocation(java.lang.String location)

Set the location.

Parameters:

location - the location of the help

getLocation

public java.lang.String getLocation()

Get the current location.

Returns:

the location of the help.

toString

public java.lang.String toString()

Returns the topic with spaces in front of it. The number of spaces in front of the topic is equal to the level.

Overrides:

toString in class java.lang.Object

Returns:

the topic with spaces in front of it.

equals

public boolean equals(java.lang.Object o)

Indicates whether the object is equal to this. Checks the topic and location, not level.

Overrides:

equals in class java.lang.Object

Returns:

true if o equals this, otherwise it returns false