org.apache.isis.core.progmodel.facetdecorators.help.file.internal
Class HelpManagerUsingFiles

java.lang.Object
  org.apache.isis.core.progmodel.facetdecorators.help.HelpManagerAbstract
      org.apache.isis.core.progmodel.facetdecorators.help.file.internal.HelpManagerUsingFiles

All Implemented Interfaces:

org.apache.isis.core.commons.components.ApplicationScopedComponent, org.apache.isis.core.commons.components.Component, HelpManager

public class HelpManagerUsingFiles
extends HelpManagerAbstract

Field Summary

static String

DEFAULT_FILE_NAME The name of the file used unless overridden with setFileName(String).

Constructor Summary

HelpManagerUsingFiles(org.apache.isis.core.commons.config.IsisConfiguration configuration)

Method Summary

String	getHelpText(org.apache.isis.applib.Identifier identifier) Returns help text for the specified Identifier.
protected BufferedReader	getReader()
void	setFileName(String fileName)

Methods inherited from class org.apache.isis.core.progmodel.facetdecorators.help.HelpManagerAbstract

init, shutdown

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_FILE_NAME

public static final String DEFAULT_FILE_NAME

The name of the file used unless overridden with setFileName(String).

See Also:

Constant Field Values

Constructor Detail

HelpManagerUsingFiles

public HelpManagerUsingFiles(org.apache.isis.core.commons.config.IsisConfiguration configuration)

Method Detail

setFileName

public void setFileName(String fileName)

getHelpText

public String getHelpText(org.apache.isis.applib.Identifier identifier)

Description copied from interface: HelpManager

Returns help text for the specified Identifier.

If no help text is available then an empty String should be returned.

Specified by:

getHelpText in interface HelpManager

Specified by:

getHelpText in class HelpManagerAbstract

getReader

protected BufferedReader getReader()
                            throws FileNotFoundException

Throws:

FileNotFoundException