Fri, 03 Dec 2010 20:31:57 -0800
6522789: [zh_CN] translation of "enclosing class" in doclet is incorrect
Reviewed-by: yhuang
duke@1 | 1 | /* |
ohair@554 | 2 | * Copyright (c) 2001, 2008, Oracle and/or its affiliates. All rights reserved. |
duke@1 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
duke@1 | 4 | * |
duke@1 | 5 | * This code is free software; you can redistribute it and/or modify it |
duke@1 | 6 | * under the terms of the GNU General Public License version 2 only, as |
ohair@554 | 7 | * published by the Free Software Foundation. Oracle designates this |
duke@1 | 8 | * particular file as subject to the "Classpath" exception as provided |
ohair@554 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
duke@1 | 10 | * |
duke@1 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
duke@1 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
duke@1 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
duke@1 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
duke@1 | 15 | * accompanied this code). |
duke@1 | 16 | * |
duke@1 | 17 | * You should have received a copy of the GNU General Public License version |
duke@1 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
duke@1 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
duke@1 | 20 | * |
ohair@554 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
ohair@554 | 22 | * or visit www.oracle.com if you need additional information or have any |
ohair@554 | 23 | * questions. |
duke@1 | 24 | */ |
duke@1 | 25 | |
duke@1 | 26 | package com.sun.tools.doclets.formats.html; |
duke@1 | 27 | |
duke@1 | 28 | import com.sun.tools.doclets.internal.toolkit.*; |
duke@1 | 29 | import com.sun.tools.doclets.internal.toolkit.util.*; |
duke@1 | 30 | import com.sun.javadoc.*; |
duke@1 | 31 | import java.io.*; |
duke@1 | 32 | import java.util.*; |
duke@1 | 33 | |
duke@1 | 34 | /** |
duke@1 | 35 | * Write the Constants Summary Page in HTML format. |
duke@1 | 36 | * |
duke@1 | 37 | * @author Jamie Ho |
bpatel@243 | 38 | * @author Bhavesh Patel (Modified) |
duke@1 | 39 | * @since 1.4 |
duke@1 | 40 | */ |
duke@1 | 41 | public class ConstantsSummaryWriterImpl extends HtmlDocletWriter |
duke@1 | 42 | implements ConstantsSummaryWriter { |
duke@1 | 43 | |
duke@1 | 44 | /** |
duke@1 | 45 | * The configuration used in this run of the standard doclet. |
duke@1 | 46 | */ |
duke@1 | 47 | ConfigurationImpl configuration; |
duke@1 | 48 | |
duke@1 | 49 | /** |
duke@1 | 50 | * The current class being documented. |
duke@1 | 51 | */ |
duke@1 | 52 | private ClassDoc currentClassDoc; |
duke@1 | 53 | |
bpatel@243 | 54 | private final String constantsTableSummary; |
bpatel@243 | 55 | |
bpatel@243 | 56 | private final String[] constantsTableHeader; |
bpatel@243 | 57 | |
duke@1 | 58 | /** |
duke@1 | 59 | * Construct a ConstantsSummaryWriter. |
duke@1 | 60 | * @param configuration the configuration used in this run |
duke@1 | 61 | * of the standard doclet. |
duke@1 | 62 | */ |
duke@1 | 63 | public ConstantsSummaryWriterImpl(ConfigurationImpl configuration) |
duke@1 | 64 | throws IOException { |
duke@1 | 65 | super(configuration, ConfigurationImpl.CONSTANTS_FILE_NAME); |
duke@1 | 66 | this.configuration = configuration; |
bpatel@243 | 67 | constantsTableSummary = configuration.getText("doclet.Constants_Table_Summary", |
bpatel@243 | 68 | configuration.getText("doclet.Constants_Summary")); |
bpatel@243 | 69 | constantsTableHeader = new String[] { |
bpatel@243 | 70 | getModifierTypeHeader(), |
bpatel@243 | 71 | configuration.getText("doclet.ConstantField"), |
bpatel@243 | 72 | configuration.getText("doclet.Value") |
bpatel@243 | 73 | }; |
duke@1 | 74 | } |
duke@1 | 75 | |
duke@1 | 76 | /** |
duke@1 | 77 | * {@inheritDoc} |
duke@1 | 78 | */ |
duke@1 | 79 | public void writeHeader() { |
duke@1 | 80 | printHtmlHeader(configuration.getText("doclet.Constants_Summary"), |
duke@1 | 81 | null, true); |
duke@1 | 82 | printTop(); |
duke@1 | 83 | navLinks(true); |
duke@1 | 84 | hr(); |
duke@1 | 85 | |
duke@1 | 86 | center(); |
duke@1 | 87 | h1(); printText("doclet.Constants_Summary"); h1End(); |
duke@1 | 88 | centerEnd(); |
duke@1 | 89 | |
duke@1 | 90 | hr(4, "noshade"); |
duke@1 | 91 | } |
duke@1 | 92 | |
duke@1 | 93 | /** |
duke@1 | 94 | * {@inheritDoc} |
duke@1 | 95 | */ |
duke@1 | 96 | public void writeFooter() { |
duke@1 | 97 | hr(); |
duke@1 | 98 | navLinks(false); |
duke@1 | 99 | printBottom(); |
duke@1 | 100 | printBodyHtmlEnd(); |
duke@1 | 101 | } |
duke@1 | 102 | |
duke@1 | 103 | /** |
duke@1 | 104 | * {@inheritDoc} |
duke@1 | 105 | */ |
duke@1 | 106 | public void writeContentsHeader() { |
bpatel@182 | 107 | strong(configuration.getText("doclet.Contents")); |
duke@1 | 108 | ul(); |
duke@1 | 109 | } |
duke@1 | 110 | |
duke@1 | 111 | /** |
duke@1 | 112 | * {@inheritDoc} |
duke@1 | 113 | */ |
duke@1 | 114 | public void writeContentsFooter() { |
duke@1 | 115 | ulEnd(); |
duke@1 | 116 | println(); |
duke@1 | 117 | } |
duke@1 | 118 | |
duke@1 | 119 | /** |
duke@1 | 120 | * {@inheritDoc} |
duke@1 | 121 | */ |
jjg@74 | 122 | public void writeLinkToPackageContent(PackageDoc pkg, String parsedPackageName, Set<String> printedPackageHeaders) { |
duke@1 | 123 | String packageName = pkg.name(); |
duke@1 | 124 | //add link to summary |
duke@1 | 125 | li(); |
duke@1 | 126 | if (packageName.length() == 0) { |
duke@1 | 127 | printHyperLink("#" + DocletConstants.UNNAMED_PACKAGE_ANCHOR, |
duke@1 | 128 | DocletConstants.DEFAULT_PACKAGE_NAME); |
duke@1 | 129 | } else { |
duke@1 | 130 | printHyperLink("#" + parsedPackageName, parsedPackageName + ".*"); |
duke@1 | 131 | printedPackageHeaders.add(parsedPackageName); |
duke@1 | 132 | } |
duke@1 | 133 | println(); |
duke@1 | 134 | } |
duke@1 | 135 | |
duke@1 | 136 | /** |
duke@1 | 137 | * {@inheritDoc} |
duke@1 | 138 | */ |
duke@1 | 139 | public void writeConstantMembersHeader(ClassDoc cd) { |
duke@1 | 140 | //generate links backward only to public classes. |
duke@1 | 141 | String classlink = (cd.isPublic() || cd.isProtected())? |
duke@1 | 142 | getLink(new LinkInfoImpl(LinkInfoImpl.CONTEXT_CONSTANT_SUMMARY, cd, |
duke@1 | 143 | false)) : |
duke@1 | 144 | cd.qualifiedName(); |
duke@1 | 145 | String name = cd.containingPackage().name(); |
duke@1 | 146 | if (name.length() > 0) { |
duke@1 | 147 | writeClassName(name + "." + classlink); |
duke@1 | 148 | } else { |
duke@1 | 149 | writeClassName(classlink); |
duke@1 | 150 | } |
duke@1 | 151 | } |
duke@1 | 152 | |
duke@1 | 153 | /** |
duke@1 | 154 | * {@inheritDoc} |
duke@1 | 155 | */ |
duke@1 | 156 | public void writeConstantMembersFooter(ClassDoc cd) { |
duke@1 | 157 | tableFooter(false); |
duke@1 | 158 | p(); |
duke@1 | 159 | } |
duke@1 | 160 | |
duke@1 | 161 | /** |
duke@1 | 162 | * Print the class name in the table heading. |
duke@1 | 163 | * @param classStr the heading to print. |
duke@1 | 164 | */ |
duke@1 | 165 | protected void writeClassName(String classStr) { |
bpatel@243 | 166 | table(1, 3, 0, constantsTableSummary); |
bpatel@243 | 167 | tableSubCaptionStart(); |
duke@1 | 168 | write(classStr); |
bpatel@243 | 169 | tableCaptionEnd(); |
bpatel@243 | 170 | summaryTableHeader(constantsTableHeader, "col"); |
duke@1 | 171 | } |
duke@1 | 172 | |
duke@1 | 173 | private void tableFooter(boolean isHeader) { |
duke@1 | 174 | fontEnd(); |
duke@1 | 175 | if (isHeader) { |
duke@1 | 176 | thEnd(); |
duke@1 | 177 | } else { |
duke@1 | 178 | tdEnd(); |
duke@1 | 179 | } |
duke@1 | 180 | trEnd(); |
duke@1 | 181 | tableEnd(); |
duke@1 | 182 | p(); |
duke@1 | 183 | } |
duke@1 | 184 | |
duke@1 | 185 | /** |
duke@1 | 186 | * {@inheritDoc} |
duke@1 | 187 | */ |
duke@1 | 188 | public void writePackageName(PackageDoc pkg, String parsedPackageName) { |
duke@1 | 189 | String pkgname; |
duke@1 | 190 | if (parsedPackageName.length() == 0) { |
duke@1 | 191 | anchor(DocletConstants.UNNAMED_PACKAGE_ANCHOR); |
duke@1 | 192 | pkgname = DocletConstants.DEFAULT_PACKAGE_NAME; |
duke@1 | 193 | } else { |
duke@1 | 194 | anchor(parsedPackageName); |
duke@1 | 195 | pkgname = parsedPackageName; |
duke@1 | 196 | } |
duke@1 | 197 | table(1, "100%", 3, 0); |
duke@1 | 198 | trBgcolorStyle("#CCCCFF", "TableHeadingColor"); |
duke@1 | 199 | thAlign("left"); |
duke@1 | 200 | font("+2"); |
duke@1 | 201 | write(pkgname + ".*"); |
duke@1 | 202 | tableFooter(true); |
duke@1 | 203 | } |
duke@1 | 204 | |
duke@1 | 205 | /** |
duke@1 | 206 | * {@inheritDoc} |
duke@1 | 207 | */ |
mcimadamore@184 | 208 | public void writeConstantMembers(ClassDoc cd, List<FieldDoc> fields) { |
duke@1 | 209 | currentClassDoc = cd; |
duke@1 | 210 | for (int i = 0; i < fields.size(); ++i) { |
mcimadamore@184 | 211 | writeConstantMember(fields.get(i)); |
duke@1 | 212 | } |
duke@1 | 213 | } |
duke@1 | 214 | |
duke@1 | 215 | private void writeConstantMember(FieldDoc member) { |
duke@1 | 216 | trBgcolorStyle("white", "TableRowColor"); |
duke@1 | 217 | anchor(currentClassDoc.qualifiedName() + "." + member.name()); |
duke@1 | 218 | writeTypeColumn(member); |
duke@1 | 219 | writeNameColumn(member); |
duke@1 | 220 | writeValue(member); |
duke@1 | 221 | trEnd(); |
duke@1 | 222 | } |
duke@1 | 223 | |
duke@1 | 224 | private void writeTypeColumn(FieldDoc member) { |
duke@1 | 225 | tdAlign("right"); |
duke@1 | 226 | font("-1"); |
duke@1 | 227 | code(); |
duke@1 | 228 | StringTokenizer mods = new StringTokenizer(member.modifiers()); |
duke@1 | 229 | while(mods.hasMoreTokens()) { |
duke@1 | 230 | print(mods.nextToken() + " "); |
duke@1 | 231 | } |
duke@1 | 232 | printLink(new LinkInfoImpl(LinkInfoImpl.CONTEXT_CONSTANT_SUMMARY, |
duke@1 | 233 | member.type())); |
duke@1 | 234 | codeEnd(); |
duke@1 | 235 | fontEnd(); |
duke@1 | 236 | tdEnd(); |
duke@1 | 237 | } |
duke@1 | 238 | |
duke@1 | 239 | private void writeNameColumn(FieldDoc member) { |
duke@1 | 240 | tdAlign("left"); |
duke@1 | 241 | code(); |
duke@1 | 242 | printDocLink(LinkInfoImpl.CONTEXT_CONSTANT_SUMMARY, member, |
duke@1 | 243 | member.name(), false); |
duke@1 | 244 | codeEnd(); |
duke@1 | 245 | tdEnd(); |
duke@1 | 246 | } |
duke@1 | 247 | |
duke@1 | 248 | private void writeValue(FieldDoc member) { |
duke@1 | 249 | tdAlign("right"); |
duke@1 | 250 | code(); |
duke@1 | 251 | print(Util.escapeHtmlChars(member.constantValueExpression())); |
duke@1 | 252 | codeEnd(); |
duke@1 | 253 | tdEnd(); |
duke@1 | 254 | } |
duke@1 | 255 | } |