IHTMLReportContext.java revision 283abfa148b749678924b5e75eabd35a2d58f9f8 
1/*******************************************************************************
2 * Copyright (c) 2009, 2014 Mountainminds GmbH & Co. KG and Contributors
3 * All rights reserved. This program and the accompanying materials
4 * are made available under the terms of the Eclipse Public License v1.0
5 * which accompanies this distribution, and is available at
6 * http://www.eclipse.org/legal/epl-v10.html
7 *
8 * Contributors:
9 *    Marc R. Hoffmann - initial API and implementation
10 *
11 *******************************************************************************/
12package org.jacoco.report.internal.html;
13
14import java.util.Locale;
15
16import org.jacoco.report.ILanguageNames;
17import org.jacoco.report.internal.html.index.IIndexUpdate;
18import org.jacoco.report.internal.html.resources.Resources;
19import org.jacoco.report.internal.html.table.Table;
20
21/**
22 * Context and configuration information during creation of a HTML report.
23 */
24public interface IHTMLReportContext {
25
26	/**
27	 * Returns the static resources used in this report.
28	 *
29	 * @return static resources
30	 */
31	public Resources getResources();
32
33	/**
34	 * Returns the language names call-back used in this report.
35	 *
36	 * @return language names
37	 */
38	public ILanguageNames getLanguageNames();
39
40	/**
41	 * Returns a table for rendering coverage nodes.
42	 *
43	 * @return table for rendering
44	 */
45	public Table getTable();
46
47	/**
48	 * Returns a string of textual information to include in every page footer.
49	 *
50	 * @return footer text or empty string
51	 */
52	public String getFooterText();
53
54	/**
55	 * Returns the link to the sessions page.
56	 *
57	 * @return sessions page link
58	 */
59	public ILinkable getSessionsPage();
60
61	/**
62	 * Returns the encoding of the generated HTML documents.
63	 *
64	 * @return encoding for generated HTML documents
65	 */
66	public String getOutputEncoding();
67
68	/**
69	 * Returns the service for index updates.
70	 *
71	 * @return sevice for indes updates
72	 */
73	public IIndexUpdate getIndexUpdate();
74
75	/**
76	 * Returns the locale used to format numbers and dates.
77	 *
78	 * @return locale for numbers and dates
79	 */
80	public Locale getLocale();
81
82}