Module io.github.tonywasher.joceanus.metis

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

Class MetisHelpWindow

java.lang.Object

io.github.tonywasher.joceanus.metis.help.MetisHelpWindow

All Implemented Interfaces:

OceanusEventRegistrar.OceanusEventProvider<TethysUIEvent>

public class MetisHelpWindow
extends Object
implements OceanusEventRegistrar.OceanusEventProvider<TethysUIEvent>

Help Manager class, responsible for displaying the help.

Field Summary

Fields

Modifier and Type	Field	Description
protected static final int	WINDOW_HEIGHT	The Height of the window.
protected static final int	WINDOW_WIDTH	The Height of the window.

Constructor Summary

Constructors

Constructor	Description
MetisHelpWindow(TethysUIFactory<?> pFactory)	Constructor.

Method Summary

Modifier and Type	Method	Description
void	closeWindow()	CloseWindow on parent termination.
protected void	fireEvent(TethysUIEvent pEventId, Object pValue)	Fire event.
OceanusEventRegistrar<TethysUIEvent>	getEventRegistrar()	Obtain registration object for listeners.
TethysUIHTMLManager	getHTMLManager()	Obtain the HTML Manager.
TethysUISplitTreeManager<MetisHelpEntry>	getSplitTreeManager()	Obtain the SplitTree Manager.
TethysUITreeManager<MetisHelpEntry>	getTreeManager()	Obtain the Tree Manager.
protected void	handleSplitTreeAction(OceanusEvent<TethysUIEvent> pEvent)	Handle the split tree action event.
void	hideDialog()	Hide the dialog.
void	setModule(MetisHelpModule pModule)	Set the help module.
void	showDialog()	show the dialog.

Methods inherited from class java.lang.Object

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

Field Details

WINDOW_WIDTH

protected static final int WINDOW_WIDTH

The Height of the window.

See Also:

• Constant Field Values

WINDOW_HEIGHT

protected static final int WINDOW_HEIGHT

The Height of the window.

See Also:

• Constant Field Values

Constructor Details

MetisHelpWindow

public MetisHelpWindow(TethysUIFactory<?> pFactory)

Constructor.

Parameters:

pFactory - the GUI factory

Method Details

getEventRegistrar

public OceanusEventRegistrar<TethysUIEvent> getEventRegistrar()

Description copied from interface: OceanusEventRegistrar.OceanusEventProvider

Obtain registration object for listeners.

Specified by:

getEventRegistrar in interface OceanusEventRegistrar.OceanusEventProvider<TethysUIEvent>

Returns:

the registrar

getSplitTreeManager

public TethysUISplitTreeManager<MetisHelpEntry> getSplitTreeManager()

Obtain the SplitTree Manager.

Returns:

the tree manager

getTreeManager

public TethysUITreeManager<MetisHelpEntry> getTreeManager()

Obtain the Tree Manager.

Returns:

the tree manager

getHTMLManager

public TethysUIHTMLManager getHTMLManager()

Obtain the HTML Manager.

Returns:

the HTML manager

fireEvent

protected void fireEvent(TethysUIEvent pEventId,
 Object pValue)

Fire event.

Parameters:

pEventId - the eventId

pValue - the relevant value

showDialog

public void showDialog()

show the dialog.

hideDialog

public void hideDialog()

Hide the dialog.

closeWindow

public void closeWindow()

CloseWindow on parent termination.

setModule

public void setModule(MetisHelpModule pModule)
               throws OceanusException

Set the help module.

Parameters:

pModule - the helpModule

Throws:

OceanusException - on error

handleSplitTreeAction

protected void handleSplitTreeAction(OceanusEvent<TethysUIEvent> pEvent)

Handle the split tree action event.

Parameters:

pEvent - the event