Package adams.gui.help

Class AdamsOptionHandlerHelpGenerator

java.lang.Object

adams.gui.help.AbstractHelpGenerator

adams.gui.help.AdamsOptionHandlerHelpGenerator

All Implemented Interfaces:

UserModeSupporter

public class AdamsOptionHandlerHelpGenerator
extends AbstractHelpGenerator
implements UserModeSupporter

For ADAMS OptionHandler.

Author:

FracPete (fracpete at waikato dot ac dot nz)

Field Summary

Fields

Modifier and Type	Field	Description
protected UserMode	m_UserMode	the user mode to use.

Fields inherited from class adams.gui.help.AbstractHelpGenerator

m_Generators

Constructor Summary

Constructors

Constructor	Description
AdamsOptionHandlerHelpGenerator()

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.
UserMode	getUserMode()	Returns the user mode to use for displaying the properties.
boolean	handles(Class cls)	Returns whether this class is handled by this generator.
void	initializeGenerator()	Hook method for initializing the generator.
boolean	isHtml(Class cls)	Returns whether the generated help is HTML or plain text.
void	setUserMode(UserMode value)	Sets the user mode to use for displaying the properties.

Methods inherited from class adams.gui.help.AbstractHelpGenerator

generateHelp, generateHelp, generateHelp, handles, initialize, isHtml

Methods inherited from class java.lang.Object

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

Field Detail

m_UserMode

protected UserMode m_UserMode

the user mode to use.

Constructor Detail

AdamsOptionHandlerHelpGenerator

public AdamsOptionHandlerHelpGenerator()

Method Detail

initializeGenerator

public void initializeGenerator()

Hook method for initializing the generator.

Overrides:

initializeGenerator in class AbstractHelpGenerator

setUserMode

public void setUserMode(UserMode value)

Sets the user mode to use for displaying the properties.

Specified by:

setUserMode in interface UserModeSupporter

Parameters:

value - the mode

getUserMode

public UserMode getUserMode()

Returns the user mode to use for displaying the properties.

Specified by:

getUserMode in interface UserModeSupporter

Returns:

the mode

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