Module io.github.tonywasher.joceanus.metis

Package io.github.tonywasher.joceanus.metis.help

Class MetisHelpModule

java.lang.Object

io.github.tonywasher.joceanus.metis.help.MetisHelpModule

public abstract class MetisHelpModule
extends Object

The help module that is implemented by each Help System.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	MetisHelpModule.MetisHelpId	HelpId.

Field Summary

Fields

Modifier and Type	Field	Description
protected static final String	ATTR_INITIAL	Attribute name for Initial page.
protected static final String	DOC_NAME	Document name for Help Contents.
protected static final int	HASH_PRIME	The Hash prime.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MetisHelpModule(String pTitle)	Constructor.

Method Summary

Modifier and Type	Method	Description
MetisHelpEntry	addRootEntry(MetisHelpEntry pEntry)	Add root entry.
static MetisHelpEntry	defineContentsEntry(String pName)	Define Contents Help entry.
static <K extends Enum<K> & MetisHelpModule.MetisHelpId> MetisHelpEntry	defineHelpEntry(String pName, K pHelpId)	Define Standard Help entry.
static MetisHelpEntry	defineTitledContentsEntry(String pName, String pTitle)	Define Contents Help entry.
static <K extends Enum<K> & MetisHelpModule.MetisHelpId> MetisHelpEntry	defineTitledHelpEntry(String pName, String pTitle, K pHelpId)	Define Titled Help entry.
protected TethysUIHTMLManager.TethysUIStyleSheetId	getCSS()	Obtain the CSS.
List<MetisHelpEntry>	getHelpEntries()	Obtain the help entries.
protected String	getInitialName()	Obtain the initial name.
protected String	getTitle()	Obtain the title.
protected <K extends Enum<K> & TethysUIHTMLManager.TethysUIStyleSheetId> void	loadCSS(K pKey)	Load CSS.
protected void	loadHelpPages()	Load Help entries from the file system.
void	setInitialName(String pInitial)	Set the initial name.

Methods inherited from class java.lang.Object

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

Field Details

HASH_PRIME

protected static final int HASH_PRIME

The Hash prime.

See Also:

• Constant Field Values

DOC_NAME

protected static final String DOC_NAME

Document name for Help Contents.

See Also:

• Constant Field Values

ATTR_INITIAL

protected static final String ATTR_INITIAL

Attribute name for Initial page.

See Also:

• Constant Field Values

Constructor Details

MetisHelpModule

protected MetisHelpModule(String pTitle)

Constructor.

Parameters:

pTitle - the title

Method Details

setInitialName

public void setInitialName(String pInitial)

Set the initial name.

Parameters:

pInitial - the initial name

getInitialName

protected String getInitialName()

Obtain the initial name.

Returns:

the initial name

getTitle

protected String getTitle()

Obtain the title.

Returns:

the title

getCSS

protected TethysUIHTMLManager.TethysUIStyleSheetId getCSS()

Obtain the CSS.

Returns:

the CSS

getHelpEntries

public List<MetisHelpEntry> getHelpEntries()

Obtain the help entries.

Returns:

the help entries

addRootEntry

public MetisHelpEntry addRootEntry(MetisHelpEntry pEntry)

Add root entry.

Parameters:

pEntry - the entry

Returns:

the HelpEntry

defineHelpEntry

public static <K extends Enum<K> & MetisHelpModule.MetisHelpId>
MetisHelpEntry defineHelpEntry(String pName,
 K pHelpId)

Define Standard Help entry.

Type Parameters:

K - the type of the key

Parameters:

pName - the name

pHelpId - the helpId

Returns:

the HelpEntry

defineTitledHelpEntry

public static <K extends Enum<K> & MetisHelpModule.MetisHelpId>
MetisHelpEntry defineTitledHelpEntry(String pName,
 String pTitle,
 K pHelpId)

Define Titled Help entry.

Type Parameters:

K - the type of the key

Parameters:

pName - the name

pTitle - the title

pHelpId - the helpId

Returns:

the HelpEntry

defineContentsEntry

public static MetisHelpEntry defineContentsEntry(String pName)

Define Contents Help entry.

Parameters:

pName - the name

Returns:

the HelpEntry

defineTitledContentsEntry

public static MetisHelpEntry defineTitledContentsEntry(String pName,
 String pTitle)

Define Contents Help entry.

Parameters:

pName - the name

pTitle - the title

Returns:

the HelpEntry

loadHelpPages

protected void loadHelpPages()
                      throws OceanusException

Load Help entries from the file system.

Throws:

OceanusException - on error

loadCSS

protected <K extends Enum<K> & TethysUIHTMLManager.TethysUIStyleSheetId>
void loadCSS(K pKey)
      throws OceanusException

Load CSS.

Type Parameters:

K - the keyType

Parameters:

pKey - the styleSheetKey

Throws:

OceanusException - on error