1 /* 2 * Copyright (c) 2010, 2016, Oracle and/or its affiliates. All rights reserved. 3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 4 * 5 * This code is free software; you can redistribute it and/or modify it 6 * under the terms of the GNU General Public License version 2 only, as 7 * published by the Free Software Foundation. Oracle designates this 8 * particular file as subject to the "Classpath" exception as provided 9 * by Oracle in the LICENSE file that accompanied this code. 10 * 11 * This code is distributed in the hope that it will be useful, but WITHOUT 12 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 13 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 14 * version 2 for more details (a copy is included in the LICENSE file that 15 * accompanied this code). 16 * 17 * You should have received a copy of the GNU General Public License version 18 * 2 along with this work; if not, write to the Free Software Foundation, 19 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 20 * 21 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 22 * or visit www.oracle.com if you need additional information or have any 23 * questions. 24 */ 25 26 package jdk.javadoc.internal.doclets.formats.html.markup; 27 28 import jdk.javadoc.internal.doclets.toolkit.Content; 29 30 /** 31 * Stores constants for Html Doclet. 32 * 33 * <p><b>This is NOT part of any supported API. 34 * If you write code that depends on this, you do so at your own risk. 35 * This code and its internal interfaces are subject to change or 36 * deletion without notice.</b> 37 * 38 * @author Bhavesh Patel 39 */ 40 public class HtmlConstants { 41 42 /** 43 * Marker to identify start of top navigation bar. 44 */ 45 public static final Content START_OF_TOP_NAVBAR = 46 new Comment("========= START OF TOP NAVBAR ======="); 47 48 /** 49 * Marker to identify start of bottom navigation bar. 50 */ 51 public static final Content START_OF_BOTTOM_NAVBAR = 52 new Comment("======= START OF BOTTOM NAVBAR ======"); 53 54 /** 55 * Marker to identify end of top navigation bar. 56 */ 57 public static final Content END_OF_TOP_NAVBAR = 58 new Comment("========= END OF TOP NAVBAR ========="); 59 60 /** 61 * Marker to identify end of bottom navigation bar. 62 */ 63 public static final Content END_OF_BOTTOM_NAVBAR = 64 new Comment("======== END OF BOTTOM NAVBAR ======="); 65 66 /** 67 * Marker to identify start of module description. 68 */ 69 public static final Content START_OF_MODULE_DESCRIPTION = 70 new Comment("============ MODULE DESCRIPTION ==========="); 71 72 /** 73 * Marker to identify start of modules summary. 74 */ 75 public static final Content START_OF_MODULES_SUMMARY = 76 new Comment("============ MODULES SUMMARY ==========="); 77 78 /** 79 * Marker to identify start of packages summary. 80 */ 81 public static final Content START_OF_PACKAGES_SUMMARY = 82 new Comment("============ PACKAGES SUMMARY ==========="); 83 84 /** 85 * Marker to identify start of services summary. 86 */ 87 public static final Content START_OF_SERVICES_SUMMARY = 88 new Comment("============ SERVICES SUMMARY ==========="); 89 90 /** 91 * Marker to identify start of class data. 92 */ 93 public static final Content START_OF_CLASS_DATA = 94 new Comment("======== START OF CLASS DATA ========"); 95 96 /** 97 * Marker to identify end of class data. 98 */ 99 public static final Content END_OF_CLASS_DATA = 100 new Comment("========= END OF CLASS DATA ========="); 101 102 /** 103 * Marker to identify start of nested class summary. 104 */ 105 public static final Content START_OF_NESTED_CLASS_SUMMARY = 106 new Comment("======== NESTED CLASS SUMMARY ========"); 107 108 /** 109 * Marker to identify start of annotation type optional member summary. 110 */ 111 public static final Content START_OF_ANNOTATION_TYPE_OPTIONAL_MEMBER_SUMMARY = 112 new Comment("=========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY ==========="); 113 114 /** 115 * Marker to identify start of annotation type required member summary. 116 */ 117 public static final Content START_OF_ANNOTATION_TYPE_REQUIRED_MEMBER_SUMMARY = 118 new Comment("=========== ANNOTATION TYPE REQUIRED MEMBER SUMMARY ==========="); 119 120 /** 121 * Marker to identify start of annotation type required member summary. 122 */ 123 public static final Content START_OF_ANNOTATION_TYPE_FIELD_SUMMARY = 124 new Comment("=========== ANNOTATION TYPE FIELD SUMMARY ==========="); 125 126 /** 127 * Marker to identify start of constructor summary. 128 */ 129 public static final Content START_OF_CONSTRUCTOR_SUMMARY = 130 new Comment("======== CONSTRUCTOR SUMMARY ========"); 131 132 /** 133 * Marker to identify start of enum constants summary. 134 */ 135 public static final Content START_OF_ENUM_CONSTANT_SUMMARY = 136 new Comment("=========== ENUM CONSTANT SUMMARY ==========="); 137 138 /** 139 * Marker to identify start of field summary. 140 */ 141 public static final Content START_OF_FIELD_SUMMARY = 142 new Comment("=========== FIELD SUMMARY ==========="); 143 144 /** 145 * Marker to identify start of properties summary. 146 */ 147 public static final Content START_OF_PROPERTY_SUMMARY = 148 new Comment("=========== PROPERTY SUMMARY ==========="); 149 150 /** 151 * Marker to identify start of method summary. 152 */ 153 public static final Content START_OF_METHOD_SUMMARY = 154 new Comment("========== METHOD SUMMARY ==========="); 155 156 /** 157 * Marker to identify start of annotation type details. 158 */ 159 public static final Content START_OF_ANNOTATION_TYPE_DETAILS = 160 new Comment("============ ANNOTATION TYPE MEMBER DETAIL ==========="); 161 162 /** 163 * Marker to identify start of annotation type field details. 164 */ 165 public static final Content START_OF_ANNOTATION_TYPE_FIELD_DETAILS = 166 new Comment("============ ANNOTATION TYPE FIELD DETAIL ==========="); 167 168 /** 169 * Marker to identify start of method details. 170 */ 171 public static final Content START_OF_METHOD_DETAILS = 172 new Comment("============ METHOD DETAIL =========="); 173 174 /** 175 * Marker to identify start of field details. 176 */ 177 public static final Content START_OF_FIELD_DETAILS = 178 new Comment("============ FIELD DETAIL ==========="); 179 180 /** 181 * Marker to identify start of property details. 182 */ 183 public static final Content START_OF_PROPERTY_DETAILS = 184 new Comment("============ PROPERTY DETAIL ==========="); 185 186 /** 187 * Marker to identify start of constructor details. 188 */ 189 public static final Content START_OF_CONSTRUCTOR_DETAILS = 190 new Comment("========= CONSTRUCTOR DETAIL ========"); 191 192 /** 193 * Marker to identify start of enum constants details. 194 */ 195 public static final Content START_OF_ENUM_CONSTANT_DETAILS = 196 new Comment("============ ENUM CONSTANT DETAIL ==========="); 197 198 /** 199 * Html tag for the page title heading. 200 */ 201 public static final HtmlTag TITLE_HEADING = HtmlTag.H1; 202 203 /** 204 * Html tag for the class page title heading. 205 */ 206 public static final HtmlTag CLASS_PAGE_HEADING = HtmlTag.H2; 207 208 /** 209 * Html tag for the content heading. 210 */ 211 public static final HtmlTag CONTENT_HEADING = HtmlTag.H2; 212 213 /** 214 * Html tag for the package name heading. 215 */ 216 public static final HtmlTag PACKAGE_HEADING = HtmlTag.H2; 217 218 /** 219 * Html tag for the module name heading. 220 */ 221 public static final HtmlTag MODULE_HEADING = HtmlTag.H2; 222 223 /** 224 * Html tag for the member summary heading. 225 */ 226 public static final HtmlTag SUMMARY_HEADING = HtmlTag.H3; 227 228 /** 229 * Html tag for the inherited member summary heading. 230 */ 231 public static final HtmlTag INHERITED_SUMMARY_HEADING = HtmlTag.H3; 232 233 /** 234 * Html tag for the member details heading. 235 */ 236 public static final HtmlTag DETAILS_HEADING = HtmlTag.H3; 237 238 /** 239 * Html tag for the serialized member heading. 240 */ 241 public static final HtmlTag SERIALIZED_MEMBER_HEADING = HtmlTag.H3; 242 243 /** 244 * Html tag for the member heading. 245 */ 246 public static final HtmlTag MEMBER_HEADING = HtmlTag.H4; 247 248 /** 249 * Default charset for HTML. 250 */ 251 public static final String HTML_DEFAULT_CHARSET = "utf-8"; 252 } 253