|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jacoco.report.html.ReportPage
public abstract class ReportPage
Base class for HTML page generators. It renders the page skeleton with the breadcrumb, the title and the footer.
Field Summary | |
---|---|
protected IHTMLReportContext |
context
context for this report |
protected ReportOutputFolder |
outputFolder
output folder for this node |
Fields inherited from interface org.jacoco.report.IReportVisitor |
---|
NOP |
Constructor Summary | |
---|---|
protected |
ReportPage(ICoverageNode node,
ReportPage parent,
ReportOutputFolder baseFolder,
IHTMLReportContext context)
Creates a new report page. |
Method Summary | |
---|---|
protected void |
body(HTMLElement body,
ISourceFileLocator sourceFileLocator)
Renders the content of the body element. |
protected abstract void |
content(HTMLElement body,
ISourceFileLocator sourceFileLocator)
Creates the actual content of the page. |
protected void |
footer(HTMLElement body)
Renders the page footer. |
protected abstract String |
getFileName()
Specifies the local file name of this page. |
protected abstract ReportOutputFolder |
getFolder(ReportOutputFolder base)
Creates the output folder relative to the given base for this report page. |
String |
getLabel()
Returns the display name of the item. |
String |
getLink(ReportOutputFolder base)
Returns an optional link that the item will be linked to. |
ICoverageNode |
getNode()
Returns the corresponding node data. |
protected void |
head(HTMLElement head)
Fills the content of the 'head' element. |
void |
visitEnd(ISourceFileLocator sourceFileLocator)
Called at the very end, when all child node have been processed and the counters for this node are properly populated. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.jacoco.report.IReportVisitor |
---|
visitChild |
Field Detail |
---|
protected final ReportOutputFolder outputFolder
protected final IHTMLReportContext context
Constructor Detail |
---|
protected ReportPage(ICoverageNode node, ReportPage parent, ReportOutputFolder baseFolder, IHTMLReportContext context)
node
- corresponding nodeparent
- optional hierarchical parentbaseFolder
- base folder to create this report page relative tocontext
- settings contextMethod Detail |
---|
public void visitEnd(ISourceFileLocator sourceFileLocator) throws IOException
IReportVisitor
visitEnd
in interface IReportVisitor
sourceFileLocator
- source file locator valid for this node
IOException
- in case of IO problems with the report writerprotected void head(HTMLElement head) throws IOException
head
- enclosing head element
IOException
- in case of IO problems with the report writerprotected void body(HTMLElement body, ISourceFileLocator sourceFileLocator) throws IOException
body
- enclosing body elementsourceFileLocator
- locator for source file content in this context
IOException
- in case of IO problems with the report writerprotected abstract void content(HTMLElement body, ISourceFileLocator sourceFileLocator) throws IOException
body
- body tag of the pagesourceFileLocator
- locator for source file content in this context
IOException
- in case of IO problems with the report writerprotected void footer(HTMLElement body) throws IOException
body
- enclosing body element
IOException
- in case of IO problems with the report writerprotected abstract String getFileName()
protected abstract ReportOutputFolder getFolder(ReportOutputFolder base)
base
- base folder
public String getLabel()
ICoverageTableItem
getLabel
in interface ICoverageTableItem
public ICoverageNode getNode()
ICoverageTableItem
getNode
in interface ICoverageTableItem
public final String getLink(ReportOutputFolder base)
ICoverageTableItem
getLink
in interface ICoverageTableItem
base
- base folder from where the link is created
null
if the item has no link
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |