Class ReportPage
java.lang.Object
org.jacoco.report.internal.html.page.ReportPage
- All Implemented Interfaces:
ILinkable
- Direct Known Subclasses:
NodePage
,SessionsPage
Base class for HTML page generators. It renders the page skeleton with the
breadcrumb, the title and the footer. Every report page is part of a
hierarchy and has a parent page (except the root page).
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected final IHTMLReportContext
context for this reportprotected final ReportOutputFolder
output folder for this nodeprivate final ReportPage
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
ReportPage
(ReportPage parent, ReportOutputFolder folder, IHTMLReportContext context) Creates a new report page. -
Method Summary
Modifier and TypeMethodDescriptionprivate void
body
(HTMLElement body) private void
breadcrumb
(HTMLElement div, ReportOutputFolder base) private static void
breadcrumbParent
(ReportPage page, HTMLElement div, ReportOutputFolder base) protected abstract void
content
(HTMLElement body) Creates the actual content of the page.private void
footer
(HTMLElement body) protected abstract String
Specifies the local file name of this page.final String
getLink
(ReportOutputFolder base) Returns a relative link to the item that works from the given base folder.protected String
Returns the onload handler for this page.protected void
head
(HTMLElement head) Creates the elements within the head element.protected void
infoLinks
(HTMLElement span) Inserts additional links on the top right corner.protected final boolean
Checks whether this is the root page of the report.void
render()
Renders this page's content and optionally additional pages.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.internal.html.ILinkable
getLinkLabel, getLinkStyle
-
Field Details
-
parent
-
folder
output folder for this node -
context
context for this report
-
-
Constructor Details
-
ReportPage
Creates a new report page.- Parameters:
parent
- optional hierarchical parentfolder
- base folder to create this report incontext
- settings context
-
-
Method Details
-
isRootPage
protected final boolean isRootPage()Checks whether this is the root page of the report.- Returns:
true
if this is the root page
-
render
Renders this page's content and optionally additional pages. This method must be called at most once.- Throws:
IOException
- if the page can't be written
-
head
Creates the elements within the head element.- Parameters:
head
- head tag of the page- Throws:
IOException
- in case of IO problems with the report writer
-
body
- Throws:
IOException
-
getOnload
Returns the onload handler for this page.- Returns:
- handler or
null
-
infoLinks
Inserts additional links on the top right corner.- Parameters:
span
- parent element- Throws:
IOException
- in case of IO problems with the report writer
-
breadcrumb
- Throws:
IOException
-
breadcrumbParent
private static void breadcrumbParent(ReportPage page, HTMLElement div, ReportOutputFolder base) throws IOException - Throws:
IOException
-
getFileName
Specifies the local file name of this page.- Returns:
- local file name
-
content
Creates the actual content of the page.- Parameters:
body
- body tag of the page- Throws:
IOException
- in case of IO problems with the report writer
-
getLink
Description copied from interface:ILinkable
Returns a relative link to the item that works from the given base folder.
-