1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/src/share/classes/com/sun/tools/doclets/formats/html/markup/HtmlConstants.java Wed Dec 01 11:02:38 2010 -0800
1.3 @@ -0,0 +1,189 @@
1.4 +/*
1.5 + * Copyright (c) 2010, Oracle and/or its affiliates. All rights reserved.
1.6 + * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
1.7 + *
1.8 + * This code is free software; you can redistribute it and/or modify it
1.9 + * under the terms of the GNU General Public License version 2 only, as
1.10 + * published by the Free Software Foundation. Oracle designates this
1.11 + * particular file as subject to the "Classpath" exception as provided
1.12 + * by Oracle in the LICENSE file that accompanied this code.
1.13 + *
1.14 + * This code is distributed in the hope that it will be useful, but WITHOUT
1.15 + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
1.16 + * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
1.17 + * version 2 for more details (a copy is included in the LICENSE file that
1.18 + * accompanied this code).
1.19 + *
1.20 + * You should have received a copy of the GNU General Public License version
1.21 + * 2 along with this work; if not, write to the Free Software Foundation,
1.22 + * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
1.23 + *
1.24 + * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
1.25 + * or visit www.oracle.com if you need additional information or have any
1.26 + * questions.
1.27 + */
1.28 +
1.29 +package com.sun.tools.doclets.formats.html.markup;
1.30 +
1.31 +import com.sun.tools.doclets.internal.toolkit.Content;
1.32 +
1.33 +/**
1.34 + * Stores constants for Html Doclet.
1.35 + *
1.36 + * @author Bhavesh Patel
1.37 + */
1.38 +public class HtmlConstants {
1.39 +
1.40 + /**
1.41 + * Marker to identify start of top navigation bar.
1.42 + */
1.43 + public static final Content START_OF_TOP_NAVBAR =
1.44 + new Comment("========= START OF TOP NAVBAR =======");
1.45 +
1.46 + /**
1.47 + * Marker to identify start of bottom navigation bar.
1.48 + */
1.49 + public static final Content START_OF_BOTTOM_NAVBAR =
1.50 + new Comment("======= START OF BOTTOM NAVBAR ======");
1.51 +
1.52 + /**
1.53 + * Marker to identify end of top navigation bar.
1.54 + */
1.55 + public static final Content END_OF_TOP_NAVBAR =
1.56 + new Comment("========= END OF TOP NAVBAR =========");
1.57 +
1.58 + /**
1.59 + * Marker to identify end of bottom navigation bar.
1.60 + */
1.61 + public static final Content END_OF_BOTTOM_NAVBAR =
1.62 + new Comment("======== END OF BOTTOM NAVBAR =======");
1.63 +
1.64 + /**
1.65 + * Marker to identify start of class data.
1.66 + */
1.67 + public static final Content START_OF_CLASS_DATA =
1.68 + new Comment("======== START OF CLASS DATA ========");
1.69 +
1.70 + /**
1.71 + * Marker to identify end of class data.
1.72 + */
1.73 + public static final Content END_OF_CLASS_DATA =
1.74 + new Comment("========= END OF CLASS DATA =========");
1.75 +
1.76 + /**
1.77 + * Marker to identify start of nested class summary.
1.78 + */
1.79 + public static final Content START_OF_NESTED_CLASS_SUMMARY =
1.80 + new Comment("======== NESTED CLASS SUMMARY ========");
1.81 +
1.82 + /**
1.83 + * Marker to identify start of annotation type optional member summary.
1.84 + */
1.85 + public static final Content START_OF_ANNOTATION_TYPE_OPTIONAL_MEMBER_SUMMARY =
1.86 + new Comment("=========== ANNOTATION TYPE OPTIONAL MEMBER SUMMARY ===========");
1.87 +
1.88 + /**
1.89 + * Marker to identify start of annotation type required member summary.
1.90 + */
1.91 + public static final Content START_OF_ANNOTATION_TYPE_REQUIRED_MEMBER_SUMMARY =
1.92 + new Comment("=========== ANNOTATION TYPE REQUIRED MEMBER SUMMARY ===========");
1.93 +
1.94 + /**
1.95 + * Marker to identify start of constructor summary.
1.96 + */
1.97 + public static final Content START_OF_CONSTRUCTOR_SUMMARY =
1.98 + new Comment("======== CONSTRUCTOR SUMMARY ========");
1.99 +
1.100 + /**
1.101 + * Marker to identify start of enum constants summary.
1.102 + */
1.103 + public static final Content START_OF_ENUM_CONSTANT_SUMMARY =
1.104 + new Comment("=========== ENUM CONSTANT SUMMARY ===========");
1.105 +
1.106 + /**
1.107 + * Marker to identify start of field summary.
1.108 + */
1.109 + public static final Content START_OF_FIELD_SUMMARY =
1.110 + new Comment("=========== FIELD SUMMARY ===========");
1.111 +
1.112 + /**
1.113 + * Marker to identify start of method summary.
1.114 + */
1.115 + public static final Content START_OF_METHOD_SUMMARY =
1.116 + new Comment("========== METHOD SUMMARY ===========");
1.117 +
1.118 + /**
1.119 + * Marker to identify start of annotation type details.
1.120 + */
1.121 + public static final Content START_OF_ANNOTATION_TYPE_DETAILS =
1.122 + new Comment("============ ANNOTATION TYPE MEMBER DETAIL ===========");
1.123 +
1.124 + /**
1.125 + * Marker to identify start of method details.
1.126 + */
1.127 + public static final Content START_OF_METHOD_DETAILS =
1.128 + new Comment("============ METHOD DETAIL ==========");
1.129 +
1.130 + /**
1.131 + * Marker to identify start of field details.
1.132 + */
1.133 + public static final Content START_OF_FIELD_DETAILS =
1.134 + new Comment("============ FIELD DETAIL ===========");
1.135 +
1.136 + /**
1.137 + * Marker to identify start of constructor details.
1.138 + */
1.139 + public static final Content START_OF_CONSTRUCTOR_DETAILS =
1.140 + new Comment("========= CONSTRUCTOR DETAIL ========");
1.141 +
1.142 + /**
1.143 + * Marker to identify start of enum constants details.
1.144 + */
1.145 + public static final Content START_OF_ENUM_CONSTANT_DETAILS =
1.146 + new Comment("============ ENUM CONSTANT DETAIL ===========");
1.147 +
1.148 + /**
1.149 + * Html tag for the page title heading.
1.150 + */
1.151 + public static final HtmlTag TITLE_HEADING = HtmlTag.H1;
1.152 +
1.153 + /**
1.154 + * Html tag for the class page title heading.
1.155 + */
1.156 + public static final HtmlTag CLASS_PAGE_HEADING = HtmlTag.H2;
1.157 +
1.158 + /**
1.159 + * Html tag for the content heading.
1.160 + */
1.161 + public static final HtmlTag CONTENT_HEADING = HtmlTag.H2;
1.162 +
1.163 + /**
1.164 + * Html tag for the package name heading.
1.165 + */
1.166 + public static final HtmlTag PACKAGE_HEADING = HtmlTag.H2;
1.167 +
1.168 + /**
1.169 + * Html tag for the member summary heading.
1.170 + */
1.171 + public static final HtmlTag SUMMARY_HEADING = HtmlTag.H3;
1.172 +
1.173 + /**
1.174 + * Html tag for the inherited member summary heading.
1.175 + */
1.176 + public static final HtmlTag INHERITED_SUMMARY_HEADING = HtmlTag.H3;
1.177 +
1.178 + /**
1.179 + * Html tag for the member details heading.
1.180 + */
1.181 + public static final HtmlTag DETAILS_HEADING = HtmlTag.H3;
1.182 +
1.183 + /**
1.184 + * Html tag for the serialized member heading.
1.185 + */
1.186 + public static final HtmlTag SERIALIZED_MEMBER_HEADING = HtmlTag.H3;
1.187 +
1.188 + /**
1.189 + * Html tag for the member heading.
1.190 + */
1.191 + public static final HtmlTag MEMBER_HEADING = HtmlTag.H4;
1.192 +}
