org.vizzini.ui.help
Class HelpModel

java.lang.Object
  org.vizzini.ui.help.HelpModel

public class HelpModel
extends Object

Provides a model to hold help information.

Since:

v0.2

Version:

v0.2

Author:

Jeffrey M. Thompson

Constructor Summary

HelpModel()
Construct this object with the given parameters.

HelpModel(Class owningClass)
Construct this object with the given parameter.

Method Summary

protected Class	getOwningClass() Return the owning class.
Iterator	iterator() Return an iterator over the help topics.
protected void	loadHelpTopics() Load the help topics.

Methods inherited from class java.lang.Object

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

Constructor Detail

HelpModel

public HelpModel()

Construct this object with the given parameters.

Since:

v0.2

HelpModel

public HelpModel(Class owningClass)

Construct this object with the given parameter.

Parameters:

owningClass - Class whose package to use to locate the help subdirectory.

Since:

v0.2

Method Detail

iterator

public Iterator iterator()

Return an iterator over the help topics.

Since:

v0.2

getOwningClass

protected Class getOwningClass()

Return the owning class.

Since:

v0.2

loadHelpTopics

protected void loadHelpTopics()
                       throws IOException

Load the help topics.

Throws:

IOException

Since:

v0.2