Package adams.gui.help

Class DefaultHelpGenerator

java.lang.Object

adams.gui.help.AbstractHelpGenerator

adams.gui.help.DefaultHelpGenerator

public class DefaultHelpGenerator
extends AbstractHelpGenerator

Just looks for the globalInfo method.

Author:

FracPete (fracpete at waikato dot ac dot nz)

Field Summary

Fields inherited from class adams.gui.help.AbstractHelpGenerator

m_Generators

Constructor Summary

Constructors

Constructor	Description
DefaultHelpGenerator()

Method Summary

Modifier and Type	Method	Description
String	generate(Class cls)	Generates and returns the help for the specified class.
String	generate(Object obj)	Generates and returns the help for the specified object.
boolean	handles(Class cls)	Returns whether this class is handled by this generator.
boolean	isHtml(Class cls)	Returns whether the generated help is HTML or plain text.

Methods inherited from class adams.gui.help.AbstractHelpGenerator

generateHelp, generateHelp, generateHelp, handles, initialize, initializeGenerator, isHtml

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultHelpGenerator

public DefaultHelpGenerator()

Method Detail

handles

public boolean handles(Class cls)

Returns whether this class is handled by this generator.

Specified by:

handles in class AbstractHelpGenerator

Parameters:

cls - the class to check

Returns:

true if handled

isHtml

public boolean isHtml(Class cls)

Returns whether the generated help is HTML or plain text.

Specified by:

isHtml in class AbstractHelpGenerator

Parameters:

cls - the class to generate the help for

Returns:

true if HTML

generate

public String generate(Class cls)

Generates and returns the help for the specified class.

Specified by:

generate in class AbstractHelpGenerator

Parameters:

cls - the class to generate the help for

Returns:

the help, null if failed to produce

generate

public String generate(Object obj)

Generates and returns the help for the specified object.

Specified by:

generate in class AbstractHelpGenerator

Parameters:

obj - the object to generate the help for

Returns:

the help, null if failed to produce