Module io.github.tonywasher.joceanus.metis

Package io.github.tonywasher.joceanus.metis.report

Class MetisReportManager<F>

java.lang.Object

io.github.tonywasher.joceanus.metis.report.MetisReportManager<F>

Type Parameters:

F - the filter type

All Implemented Interfaces:

OceanusEventRegistrar.OceanusEventProvider<MetisReportEvent>

public class MetisReportManager<F>
extends Object
implements OceanusEventRegistrar.OceanusEventProvider<MetisReportEvent>

Provides functionality to hide and restore sections of an HTML document. This is useful for displaying HTML documents in a jEditorPane, allowing a click to open/close sections of the document.

Constructor Summary

Constructors

Constructor	Description
MetisReportManager(MetisReportHTMLBuilder pBuilder)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	fireActionEvent(F pFilter)	fire action event.
String	formatXML()	Format XML.
MetisReportHTMLBuilder	getBuilder()	Obtain the builder.
OceanusEventRegistrar<MetisReportEvent>	getEventRegistrar()	Obtain registration object for listeners.
protected String	hideSection(String pId)	Hide section.
protected boolean	isHiddenId(String pId)	check whether id is currently hidden.
void	processReference(String pId, TethysUIHTMLManager pHTMLPane)	Process link reference.
(package private) String	restoreSection(String pId)	Restore section.
void	setDocument(Document pDocument)	Set Document.
void	setReport(MetisReportBase<?,F> pReport)	Set Report.

Methods inherited from class java.lang.Object

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

Constructor Details

MetisReportManager

public MetisReportManager(MetisReportHTMLBuilder pBuilder)
                   throws OceanusException

Constructor.

Parameters:

pBuilder - the HTML builder

Throws:

OceanusException - on error

Method Details

getEventRegistrar

public OceanusEventRegistrar<MetisReportEvent> getEventRegistrar()

Description copied from interface: OceanusEventRegistrar.OceanusEventProvider

Obtain registration object for listeners.

Specified by:

getEventRegistrar in interface OceanusEventRegistrar.OceanusEventProvider<F>

Returns:

the registrar

getBuilder

public MetisReportHTMLBuilder getBuilder()

Obtain the builder.

Returns:

the HTML builder

setReport

public void setReport(MetisReportBase<?,F> pReport)

Set Report.

Parameters:

pReport - the report

setDocument

public void setDocument(Document pDocument)

Set Document.

Parameters:

pDocument - the document

fireActionEvent

protected void fireActionEvent(F pFilter)

fire action event.

Parameters:

pFilter - the filter

isHiddenId

protected boolean isHiddenId(String pId)

check whether id is currently hidden.

Parameters:

pId - the id to check

Returns:

true/false

hideSection

protected String hideSection(String pId)
                      throws OceanusException

Hide section.

Parameters:

pId - the id of the section to hide.

Returns:

the modified text

Throws:

OceanusException - on error

restoreSection

String restoreSection(String pId)
               throws OceanusException

Restore section.

Parameters:

pId - the id of the section to restore.

Returns:

the modified text

Throws:

OceanusException - on error

formatXML

public String formatXML()
                 throws OceanusException

Format XML.

Returns:

the formatted XML

Throws:

OceanusException - on error

processReference

public void processReference(String pId,
 TethysUIHTMLManager pHTMLPane)

Process link reference.

Parameters:

pId - the id of the reference.

pHTMLPane - the HTML pane