HtmlConstants.java revision 3294:9adfb22ff08f
1139826Simp/* 253541Sshin * Copyright (c) 2010, 2015, Oracle and/or its affiliates. All rights reserved. 353541Sshin * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. 453541Sshin * 553541Sshin * This code is free software; you can redistribute it and/or modify it 653541Sshin * under the terms of the GNU General Public License version 2 only, as 753541Sshin * published by the Free Software Foundation. Oracle designates this 853541Sshin * particular file as subject to the "Classpath" exception as provided 953541Sshin * by Oracle in the LICENSE file that accompanied this code. 1053541Sshin * 1153541Sshin * This code is distributed in the hope that it will be useful, but WITHOUT 1253541Sshin * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 1353541Sshin * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License 1453541Sshin * version 2 for more details (a copy is included in the LICENSE file that 1553541Sshin * accompanied this code). 1653541Sshin * 1753541Sshin * You should have received a copy of the GNU General Public License version 1853541Sshin * 2 along with this work; if not, write to the Free Software Foundation, 1953541Sshin * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. 2053541Sshin * 2153541Sshin * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA 2253541Sshin * or visit www.oracle.com if you need additional information or have any 2353541Sshin * questions. 2453541Sshin */ 2553541Sshin 2653541Sshinpackage jdk.javadoc.internal.doclets.formats.html.markup; 2753541Sshin 2853541Sshinimport jdk.javadoc.internal.doclets.toolkit.Content; 29174510Sobrien 3053541Sshin/** 3153541Sshin * Stores constants for Html Doclet. 3253541Sshin * 3353541Sshin * <p><b>This is NOT part of any supported API. 3453541Sshin * If you write code that depends on this, you do so at your own risk. 3553541Sshin * This code and its internal interfaces are subject to change or 3653541Sshin * deletion without notice.</b> 3753541Sshin * 3853541Sshin * @author Bhavesh Patel 3953541Sshin */ 4053541Sshinpublic class HtmlConstants { 4153541Sshin 4253541Sshin /** 4353541Sshin * Marker to identify start of top navigation bar. 4453541Sshin */ 4553541Sshin public static final Content START_OF_TOP_NAVBAR = 4653541Sshin new Comment("========= START OF TOP NAVBAR ======="); 4753541Sshin 4853541Sshin /** 4953541Sshin * Marker to identify start of bottom navigation bar. 5053541Sshin */ 5153541Sshin public static final Content START_OF_BOTTOM_NAVBAR = 5253541Sshin new Comment("======= START OF BOTTOM NAVBAR ======"); 5353541Sshin 5453541Sshin /** 5553541Sshin * Marker to identify end of top navigation bar. 5653541Sshin */ 5753541Sshin public static final Content END_OF_TOP_NAVBAR = 5853541Sshin new Comment("========= END OF TOP NAVBAR ========="); 5953541Sshin 6053541Sshin /** 61174510Sobrien * Marker to identify end of bottom navigation bar. 62174510Sobrien */ 6353541Sshin public static final Content END_OF_BOTTOM_NAVBAR = 6453541Sshin new Comment("======== END OF BOTTOM NAVBAR ======="); 6553541Sshin 6653541Sshin /** 6753541Sshin * Marker to identify start of class data. 6853541Sshin */ 6953541Sshin public static final Content START_OF_CLASS_DATA = 7053541Sshin new Comment("======== START OF CLASS DATA ========"); 7153541Sshin 7253541Sshin /** 7362587Sitojun * Marker to identify end of class data. 7462587Sitojun */ 7562587Sitojun public static final Content END_OF_CLASS_DATA = 7662587Sitojun new Comment("========= END OF CLASS DATA ========="); 7783366Sjulian 7862587Sitojun /** 7978064Sume * Marker to identify start of nested class summary. 8078064Sume */ 8162587Sitojun public static final Content START_OF_NESTED_CLASS_SUMMARY = 8253541Sshin new Comment("======== NESTED CLASS SUMMARY ========"); 8353541Sshin 8453541Sshin /** 8553541Sshin * Marker to identify start of annotation type optional member summary. 8678064Sume */ 87120913Sume public static final Content START_OF_ANNOTATION_TYPE_OPTIONAL_MEMBER_SUMMARY = 8878064Sume new Comment("=========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY ==========="); 8978064Sume 9078064Sume /** 9178064Sume * Marker to identify start of annotation type required member summary. 9278064Sume */ 9378064Sume public static final Content START_OF_ANNOTATION_TYPE_REQUIRED_MEMBER_SUMMARY = 9478064Sume new Comment("=========== ANNOTATION TYPE REQUIRED MEMBER SUMMARY ==========="); 9578064Sume 9678064Sume /** 9778064Sume * Marker to identify start of annotation type required member summary. 9878064Sume */ 9978064Sume public static final Content START_OF_ANNOTATION_TYPE_FIELD_SUMMARY = 10053541Sshin new Comment("=========== ANNOTATION TYPE FIELD SUMMARY ==========="); 10153541Sshin 10262587Sitojun /** 10378064Sume * Marker to identify start of constructor summary. 10462587Sitojun */ 10562587Sitojun public static final Content START_OF_CONSTRUCTOR_SUMMARY = 10678064Sume new Comment("======== CONSTRUCTOR SUMMARY ========"); 10778064Sume 10878064Sume /** 10978064Sume * Marker to identify start of enum constants summary. 11078064Sume */ 11153541Sshin public static final Content START_OF_ENUM_CONSTANT_SUMMARY = 11253541Sshin new Comment("=========== ENUM CONSTANT SUMMARY ==========="); 11353541Sshin 11466586Sitojun /** 11553541Sshin * Marker to identify start of field summary. 11653541Sshin */ 11753541Sshin public static final Content START_OF_FIELD_SUMMARY = 11853541Sshin new Comment("=========== FIELD SUMMARY ==========="); 11953541Sshin 12053541Sshin /** 121244524Sdelphij * Marker to identify start of properties summary. 12253541Sshin */ 123244524Sdelphij public static final Content START_OF_PROPERTY_SUMMARY = 12453541Sshin new Comment("=========== PROPERTY SUMMARY ==========="); 125244524Sdelphij 12653541Sshin /** 127244524Sdelphij * Marker to identify start of method summary. 12853541Sshin */ 12953541Sshin public static final Content START_OF_METHOD_SUMMARY = 13053541Sshin new Comment("========== METHOD SUMMARY ==========="); 131244524Sdelphij 132193731Szec /** 133244524Sdelphij * Marker to identify start of annotation type details. 13453541Sshin */ 13553541Sshin public static final Content START_OF_ANNOTATION_TYPE_DETAILS = 136244524Sdelphij new Comment("============ ANNOTATION TYPE MEMBER DETAIL ==========="); 13753541Sshin 138244524Sdelphij /** 13953541Sshin * Marker to identify start of annotation type field details. 140244524Sdelphij */ 14153541Sshin public static final Content START_OF_ANNOTATION_TYPE_FIELD_DETAILS = 14253541Sshin new Comment("============ ANNOTATION TYPE FIELD DETAIL ==========="); 14353541Sshin 14492699Sdarrenr /** 14592699Sdarrenr * Marker to identify start of method details. 14692699Sdarrenr */ 14792699Sdarrenr public static final Content START_OF_METHOD_DETAILS = 14853541Sshin new Comment("============ METHOD DETAIL =========="); 149 150 /** 151 * Marker to identify start of field details. 152 */ 153 public static final Content START_OF_FIELD_DETAILS = 154 new Comment("============ FIELD DETAIL ==========="); 155 156 /** 157 * Marker to identify start of property details. 158 */ 159 public static final Content START_OF_PROPERTY_DETAILS = 160 new Comment("============ PROPERTY DETAIL ==========="); 161 162 /** 163 * Marker to identify start of constructor details. 164 */ 165 public static final Content START_OF_CONSTRUCTOR_DETAILS = 166 new Comment("========= CONSTRUCTOR DETAIL ========"); 167 168 /** 169 * Marker to identify start of enum constants details. 170 */ 171 public static final Content START_OF_ENUM_CONSTANT_DETAILS = 172 new Comment("============ ENUM CONSTANT DETAIL ==========="); 173 174 /** 175 * Html tag for the page title heading. 176 */ 177 public static final HtmlTag TITLE_HEADING = HtmlTag.H1; 178 179 /** 180 * Html tag for the class page title heading. 181 */ 182 public static final HtmlTag CLASS_PAGE_HEADING = HtmlTag.H2; 183 184 /** 185 * Html tag for the content heading. 186 */ 187 public static final HtmlTag CONTENT_HEADING = HtmlTag.H2; 188 189 /** 190 * Html tag for the package name heading. 191 */ 192 public static final HtmlTag PACKAGE_HEADING = HtmlTag.H2; 193 194 /** 195 * Html tag for the module name heading. 196 */ 197 public static final HtmlTag MODULE_HEADING = HtmlTag.H2; 198 199 /** 200 * Html tag for the member summary heading. 201 */ 202 public static final HtmlTag SUMMARY_HEADING = HtmlTag.H3; 203 204 /** 205 * Html tag for the inherited member summary heading. 206 */ 207 public static final HtmlTag INHERITED_SUMMARY_HEADING = HtmlTag.H3; 208 209 /** 210 * Html tag for the member details heading. 211 */ 212 public static final HtmlTag DETAILS_HEADING = HtmlTag.H3; 213 214 /** 215 * Html tag for the serialized member heading. 216 */ 217 public static final HtmlTag SERIALIZED_MEMBER_HEADING = HtmlTag.H3; 218 219 /** 220 * Html tag for the member heading. 221 */ 222 public static final HtmlTag MEMBER_HEADING = HtmlTag.H4; 223 224 /** 225 * Default charset for HTML. 226 */ 227 public static final String HTML_DEFAULT_CHARSET = "utf-8"; 228} 229