1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
|
/*******************************************************************************
* Copyright (c) 2009, 2019 Mountainminds GmbH & Co. KG and Contributors
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
* http://www.eclipse.org/legal/epl-v10.html
*
* Contributors:
* Marc R. Hoffmann - initial API and implementation
*
*******************************************************************************/
package org.jacoco.report.internal.html.page;
import java.io.IOException;
import org.jacoco.core.JaCoCo;
import org.jacoco.report.internal.ReportOutputFolder;
import org.jacoco.report.internal.html.HTMLElement;
import org.jacoco.report.internal.html.IHTMLReportContext;
import org.jacoco.report.internal.html.ILinkable;
import org.jacoco.report.internal.html.resources.Resources;
import org.jacoco.report.internal.html.resources.Styles;
/**
* 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).
*/
public abstract class ReportPage implements ILinkable {
private final ReportPage parent;
/** output folder for this node */
protected final ReportOutputFolder folder;
/** context for this report */
protected final IHTMLReportContext context;
/**
* Creates a new report page.
*
* @param parent
* optional hierarchical parent
* @param folder
* base folder to create this report in
* @param context
* settings context
*/
protected ReportPage(final ReportPage parent,
final ReportOutputFolder folder, final IHTMLReportContext context) {
this.parent = parent;
this.context = context;
this.folder = folder;
}
/**
* Checks whether this is the root page of the report.
*
* @return <code>true</code> if this is the root page
*/
protected final boolean isRootPage() {
return parent == null;
}
/**
* 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
*/
public void render() throws IOException {
final HTMLElement html = new HTMLElement(
folder.createFile(getFileName()), context.getOutputEncoding());
html.attr("lang", context.getLocale().getLanguage());
head(html.head());
body(html.body());
html.close();
}
/**
* Creates the elements within the head element.
*
* @param head
* head tag of the page
* @throws IOException
* in case of IO problems with the report writer
*/
protected void head(final HTMLElement head) throws IOException {
head.meta("Content-Type", "text/html;charset=UTF-8");
head.link("stylesheet",
context.getResources().getLink(folder, Resources.STYLESHEET),
"text/css");
head.link("shortcut icon",
context.getResources().getLink(folder, "report.gif"),
"image/gif");
head.title().text(getLinkLabel());
}
private void body(final HTMLElement body) throws IOException {
body.attr("onload", getOnload());
final HTMLElement navigation = body.div(Styles.BREADCRUMB);
navigation.attr("id", "breadcrumb");
infoLinks(navigation.span(Styles.INFO));
breadcrumb(navigation, folder);
body.h1().text(getLinkLabel());
content(body);
footer(body);
}
/**
* Returns the onload handler for this page.
*
* @return handler or <code>null</code>
*/
protected String getOnload() {
return null;
}
/**
* Inserts additional links on the top right corner.
*
* @param span
* parent element
* @throws IOException
* in case of IO problems with the report writer
*/
protected void infoLinks(final HTMLElement span) throws IOException {
span.a(context.getSessionsPage(), folder);
}
private void breadcrumb(final HTMLElement div,
final ReportOutputFolder base) throws IOException {
breadcrumbParent(parent, div, base);
div.span(getLinkStyle()).text(getLinkLabel());
}
private static void breadcrumbParent(final ReportPage page,
final HTMLElement div, final ReportOutputFolder base)
throws IOException {
if (page != null) {
breadcrumbParent(page.parent, div, base);
div.a(page, base);
div.text(" > ");
}
}
private void footer(final HTMLElement body) throws IOException {
final HTMLElement footer = body.div(Styles.FOOTER);
final HTMLElement versioninfo = footer.span(Styles.RIGHT);
versioninfo.text("Created with ");
versioninfo.a(JaCoCo.HOMEURL).text("JaCoCo");
versioninfo.text(" ");
versioninfo.text(JaCoCo.VERSION);
footer.text(context.getFooterText());
}
/**
* Specifies the local file name of this page.
*
* @return local file name
*/
protected abstract String getFileName();
/**
* Creates the actual content of the page.
*
* @param body
* body tag of the page
* @throws IOException
* in case of IO problems with the report writer
*/
protected abstract void content(final HTMLElement body) throws IOException;
// === ILinkable ===
public final String getLink(final ReportOutputFolder base) {
return folder.getLink(base, getFileName());
}
}
|
