Package adams.gui.help
Class WekaOptionHandlerHelpGenerator
- java.lang.Object
-
- adams.gui.help.AbstractHelpGenerator
-
- adams.gui.help.WekaOptionHandlerHelpGenerator
-
public class WekaOptionHandlerHelpGenerator extends adams.gui.help.AbstractHelpGenerator
Help generator forOptionHandler
.- Author:
- FracPete (fracpete at waikato dot ac dot nz)
-
-
Constructor Summary
Constructors Constructor Description WekaOptionHandlerHelpGenerator()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected String
addCapabilities(String title, weka.core.Capabilities c)
generates a string from the capapbilities, suitable to add to the help text.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.protected String
listCapabilities(weka.core.Capabilities c)
returns a comma-separated list of all the capabilities.
-
-
-
Method Detail
-
handles
public boolean handles(Class cls)
Returns whether this class is handled by this generator.- Specified by:
handles
in classadams.gui.help.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 classadams.gui.help.AbstractHelpGenerator
- Parameters:
cls
- the class to generate the help for- Returns:
- true if HTML
-
listCapabilities
protected String listCapabilities(weka.core.Capabilities c)
returns a comma-separated list of all the capabilities.- Parameters:
c
- the capabilities to get a string representation from- Returns:
- the string describing the capabilities
-
addCapabilities
protected String addCapabilities(String title, weka.core.Capabilities c)
generates a string from the capapbilities, suitable to add to the help text.- Parameters:
title
- the title for the capabilitiesc
- the capabilities- Returns:
- a string describing the capabilities
-
generate
public String generate(Class cls)
Generates and returns the help for the specified class.- Specified by:
generate
in classadams.gui.help.AbstractHelpGenerator
- Parameters:
cls
- the class to generate the help for- Returns:
- the help, null if failed to produce
-
-