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