Fri, 18 Oct 2013 16:34:42 -0700
8026567: Use meaningful style names for strong and italic styles.
Reviewed-by: jjg
duke@1 | 1 | /* |
jjg@1735 | 2 | * Copyright (c) 1997, 2013, 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 | |
bpatel@233 | 28 | import java.io.*; |
bpatel@233 | 29 | |
bpatel@233 | 30 | import com.sun.javadoc.*; |
bpatel@766 | 31 | import com.sun.tools.doclets.formats.html.markup.*; |
duke@1 | 32 | import com.sun.tools.doclets.internal.toolkit.*; |
duke@1 | 33 | import com.sun.tools.doclets.internal.toolkit.util.*; |
duke@1 | 34 | |
duke@1 | 35 | /** |
duke@1 | 36 | * Writes field documentation in HTML format. |
duke@1 | 37 | * |
jjg@1359 | 38 | * <p><b>This is NOT part of any supported API. |
jjg@1359 | 39 | * If you write code that depends on this, you do so at your own risk. |
jjg@1359 | 40 | * This code and its internal interfaces are subject to change or |
jjg@1359 | 41 | * deletion without notice.</b> |
jjg@1359 | 42 | * |
duke@1 | 43 | * @author Robert Field |
duke@1 | 44 | * @author Atul M Dambalkar |
duke@1 | 45 | * @author Jamie Ho (rewrite) |
bpatel@243 | 46 | * @author Bhavesh Patel (Modified) |
duke@1 | 47 | */ |
duke@1 | 48 | public class FieldWriterImpl extends AbstractMemberWriter |
duke@1 | 49 | implements FieldWriter, MemberSummaryWriter { |
duke@1 | 50 | |
duke@1 | 51 | public FieldWriterImpl(SubWriterHolderWriter writer, ClassDoc classdoc) { |
duke@1 | 52 | super(writer, classdoc); |
duke@1 | 53 | } |
duke@1 | 54 | |
duke@1 | 55 | public FieldWriterImpl(SubWriterHolderWriter writer) { |
duke@1 | 56 | super(writer); |
duke@1 | 57 | } |
duke@1 | 58 | |
duke@1 | 59 | /** |
bpatel@766 | 60 | * {@inheritDoc} |
duke@1 | 61 | */ |
bpatel@766 | 62 | public Content getMemberSummaryHeader(ClassDoc classDoc, |
bpatel@766 | 63 | Content memberSummaryTree) { |
bpatel@766 | 64 | memberSummaryTree.addContent(HtmlConstants.START_OF_FIELD_SUMMARY); |
bpatel@766 | 65 | Content memberTree = writer.getMemberTreeHeader(); |
bpatel@766 | 66 | writer.addSummaryHeader(this, classDoc, memberTree); |
bpatel@766 | 67 | return memberTree; |
duke@1 | 68 | } |
duke@1 | 69 | |
duke@1 | 70 | /** |
duke@1 | 71 | * {@inheritDoc} |
duke@1 | 72 | */ |
bpatel@766 | 73 | public Content getFieldDetailsTreeHeader(ClassDoc classDoc, |
bpatel@766 | 74 | Content memberDetailsTree) { |
bpatel@766 | 75 | memberDetailsTree.addContent(HtmlConstants.START_OF_FIELD_DETAILS); |
bpatel@766 | 76 | Content fieldDetailsTree = writer.getMemberTreeHeader(); |
bpatel@2101 | 77 | fieldDetailsTree.addContent(writer.getMarkerAnchor( |
bpatel@2101 | 78 | SectionName.FIELD_DETAIL)); |
bpatel@766 | 79 | Content heading = HtmlTree.HEADING(HtmlConstants.DETAILS_HEADING, |
bpatel@766 | 80 | writer.fieldDetailsLabel); |
bpatel@766 | 81 | fieldDetailsTree.addContent(heading); |
bpatel@766 | 82 | return fieldDetailsTree; |
duke@1 | 83 | } |
duke@1 | 84 | |
duke@1 | 85 | /** |
bpatel@766 | 86 | * {@inheritDoc} |
duke@1 | 87 | */ |
bpatel@766 | 88 | public Content getFieldDocTreeHeader(FieldDoc field, |
bpatel@766 | 89 | Content fieldDetailsTree) { |
bpatel@766 | 90 | fieldDetailsTree.addContent( |
bpatel@766 | 91 | writer.getMarkerAnchor(field.name())); |
bpatel@766 | 92 | Content fieldDocTree = writer.getMemberTreeHeader(); |
bpatel@766 | 93 | Content heading = new HtmlTree(HtmlConstants.MEMBER_HEADING); |
bpatel@766 | 94 | heading.addContent(field.name()); |
bpatel@766 | 95 | fieldDocTree.addContent(heading); |
bpatel@766 | 96 | return fieldDocTree; |
duke@1 | 97 | } |
duke@1 | 98 | |
duke@1 | 99 | /** |
bpatel@766 | 100 | * {@inheritDoc} |
duke@1 | 101 | */ |
bpatel@766 | 102 | public Content getSignature(FieldDoc field) { |
bpatel@766 | 103 | Content pre = new HtmlTree(HtmlTag.PRE); |
bpatel@766 | 104 | writer.addAnnotationInfo(field, pre); |
bpatel@766 | 105 | addModifiers(field, pre); |
jjg@1736 | 106 | Content fieldlink = writer.getLink(new LinkInfoImpl( |
jjg@1736 | 107 | configuration, LinkInfoImpl.Kind.MEMBER, field.type())); |
bpatel@766 | 108 | pre.addContent(fieldlink); |
bpatel@766 | 109 | pre.addContent(" "); |
jjg@1410 | 110 | if (configuration.linksource) { |
bpatel@766 | 111 | Content fieldName = new StringContent(field.name()); |
bpatel@766 | 112 | writer.addSrcLink(field, fieldName, pre); |
bpatel@766 | 113 | } else { |
bpatel@766 | 114 | addName(field.name(), pre); |
bpatel@766 | 115 | } |
bpatel@766 | 116 | return pre; |
duke@1 | 117 | } |
duke@1 | 118 | |
duke@1 | 119 | /** |
bpatel@766 | 120 | * {@inheritDoc} |
duke@1 | 121 | */ |
bpatel@766 | 122 | public void addDeprecated(FieldDoc field, Content fieldDocTree) { |
bpatel@766 | 123 | addDeprecatedInfo(field, fieldDocTree); |
duke@1 | 124 | } |
duke@1 | 125 | |
duke@1 | 126 | /** |
bpatel@766 | 127 | * {@inheritDoc} |
duke@1 | 128 | */ |
bpatel@766 | 129 | public void addComments(FieldDoc field, Content fieldDocTree) { |
duke@1 | 130 | ClassDoc holder = field.containingClass(); |
duke@1 | 131 | if (field.inlineTags().length > 0) { |
duke@1 | 132 | if (holder.equals(classdoc) || |
jjg@1410 | 133 | (! (holder.isPublic() || Util.isLinkable(holder, configuration)))) { |
bpatel@766 | 134 | writer.addInlineComment(field, fieldDocTree); |
duke@1 | 135 | } else { |
jjg@1736 | 136 | Content link = |
jjg@1735 | 137 | writer.getDocLink(LinkInfoImpl.Kind.FIELD_DOC_COPY, |
duke@1 | 138 | holder, field, |
duke@1 | 139 | holder.isIncluded() ? |
duke@1 | 140 | holder.typeName() : holder.qualifiedTypeName(), |
jjg@1736 | 141 | false); |
bpatel@766 | 142 | Content codeLink = HtmlTree.CODE(link); |
bpatel@2147 | 143 | Content descfrmLabel = HtmlTree.SPAN(HtmlStyle.descfrmTypeLabel, holder.isClass()? |
bpatel@766 | 144 | writer.descfrmClassLabel : writer.descfrmInterfaceLabel); |
bpatel@2147 | 145 | descfrmLabel.addContent(writer.getSpace()); |
bpatel@2147 | 146 | descfrmLabel.addContent(codeLink); |
bpatel@2147 | 147 | fieldDocTree.addContent(HtmlTree.DIV(HtmlStyle.block, descfrmLabel)); |
bpatel@766 | 148 | writer.addInlineComment(field, fieldDocTree); |
duke@1 | 149 | } |
duke@1 | 150 | } |
duke@1 | 151 | } |
duke@1 | 152 | |
duke@1 | 153 | /** |
bpatel@766 | 154 | * {@inheritDoc} |
duke@1 | 155 | */ |
bpatel@766 | 156 | public void addTags(FieldDoc field, Content fieldDocTree) { |
bpatel@766 | 157 | writer.addTagsInfo(field, fieldDocTree); |
duke@1 | 158 | } |
duke@1 | 159 | |
duke@1 | 160 | /** |
bpatel@766 | 161 | * {@inheritDoc} |
duke@1 | 162 | */ |
bpatel@766 | 163 | public Content getFieldDetails(Content fieldDetailsTree) { |
bpatel@766 | 164 | return getMemberTree(fieldDetailsTree); |
duke@1 | 165 | } |
duke@1 | 166 | |
duke@1 | 167 | /** |
bpatel@766 | 168 | * {@inheritDoc} |
duke@1 | 169 | */ |
bpatel@766 | 170 | public Content getFieldDoc(Content fieldDocTree, |
bpatel@766 | 171 | boolean isLastContent) { |
bpatel@766 | 172 | return getMemberTree(fieldDocTree, isLastContent); |
duke@1 | 173 | } |
duke@1 | 174 | |
duke@1 | 175 | /** |
duke@1 | 176 | * Close the writer. |
duke@1 | 177 | */ |
duke@1 | 178 | public void close() throws IOException { |
duke@1 | 179 | writer.close(); |
duke@1 | 180 | } |
duke@1 | 181 | |
duke@1 | 182 | public int getMemberKind() { |
duke@1 | 183 | return VisibleMemberMap.FIELDS; |
duke@1 | 184 | } |
duke@1 | 185 | |
bpatel@766 | 186 | /** |
bpatel@766 | 187 | * {@inheritDoc} |
bpatel@766 | 188 | */ |
bpatel@766 | 189 | public void addSummaryLabel(Content memberTree) { |
bpatel@766 | 190 | Content label = HtmlTree.HEADING(HtmlConstants.SUMMARY_HEADING, |
bpatel@766 | 191 | writer.getResource("doclet.Field_Summary")); |
bpatel@766 | 192 | memberTree.addContent(label); |
bpatel@243 | 193 | } |
bpatel@243 | 194 | |
bpatel@766 | 195 | /** |
bpatel@766 | 196 | * {@inheritDoc} |
bpatel@766 | 197 | */ |
bpatel@766 | 198 | public String getTableSummary() { |
jjg@1410 | 199 | return configuration.getText("doclet.Member_Table_Summary", |
jjg@1410 | 200 | configuration.getText("doclet.Field_Summary"), |
jjg@1410 | 201 | configuration.getText("doclet.fields")); |
bpatel@243 | 202 | } |
bpatel@243 | 203 | |
bpatel@766 | 204 | /** |
bpatel@766 | 205 | * {@inheritDoc} |
bpatel@766 | 206 | */ |
jjg@1747 | 207 | public Content getCaption() { |
jjg@1747 | 208 | return configuration.getResource("doclet.Fields"); |
bpatel@766 | 209 | } |
bpatel@766 | 210 | |
bpatel@766 | 211 | /** |
bpatel@766 | 212 | * {@inheritDoc} |
bpatel@766 | 213 | */ |
bpatel@766 | 214 | public String[] getSummaryTableHeader(ProgramElementDoc member) { |
bpatel@243 | 215 | String[] header = new String[] { |
bpatel@243 | 216 | writer.getModifierTypeHeader(), |
jjg@1410 | 217 | configuration.getText("doclet.0_and_1", |
jjg@1410 | 218 | configuration.getText("doclet.Field"), |
jjg@1410 | 219 | configuration.getText("doclet.Description")) |
bpatel@243 | 220 | }; |
bpatel@766 | 221 | return header; |
duke@1 | 222 | } |
duke@1 | 223 | |
bpatel@766 | 224 | /** |
bpatel@766 | 225 | * {@inheritDoc} |
bpatel@766 | 226 | */ |
bpatel@766 | 227 | public void addSummaryAnchor(ClassDoc cd, Content memberTree) { |
bpatel@2101 | 228 | memberTree.addContent(writer.getMarkerAnchor( |
bpatel@2101 | 229 | SectionName.FIELD_SUMMARY)); |
duke@1 | 230 | } |
duke@1 | 231 | |
bpatel@766 | 232 | /** |
bpatel@766 | 233 | * {@inheritDoc} |
bpatel@766 | 234 | */ |
bpatel@766 | 235 | public void addInheritedSummaryAnchor(ClassDoc cd, Content inheritedTree) { |
bpatel@766 | 236 | inheritedTree.addContent(writer.getMarkerAnchor( |
bpatel@2101 | 237 | SectionName.FIELDS_INHERITANCE, configuration.getClassName(cd))); |
duke@1 | 238 | } |
duke@1 | 239 | |
bpatel@766 | 240 | /** |
bpatel@766 | 241 | * {@inheritDoc} |
bpatel@766 | 242 | */ |
bpatel@766 | 243 | public void addInheritedSummaryLabel(ClassDoc cd, Content inheritedTree) { |
jjg@1737 | 244 | Content classLink = writer.getPreQualifiedClassLink( |
jjg@1737 | 245 | LinkInfoImpl.Kind.MEMBER, cd, false); |
bpatel@766 | 246 | Content label = new StringContent(cd.isClass() ? |
jjg@1410 | 247 | configuration.getText("doclet.Fields_Inherited_From_Class") : |
jjg@1410 | 248 | configuration.getText("doclet.Fields_Inherited_From_Interface")); |
bpatel@766 | 249 | Content labelHeading = HtmlTree.HEADING(HtmlConstants.INHERITED_SUMMARY_HEADING, |
bpatel@766 | 250 | label); |
bpatel@766 | 251 | labelHeading.addContent(writer.getSpace()); |
bpatel@766 | 252 | labelHeading.addContent(classLink); |
bpatel@766 | 253 | inheritedTree.addContent(labelHeading); |
duke@1 | 254 | } |
duke@1 | 255 | |
bpatel@766 | 256 | /** |
bpatel@766 | 257 | * {@inheritDoc} |
bpatel@766 | 258 | */ |
jjg@1735 | 259 | protected void addSummaryLink(LinkInfoImpl.Kind context, ClassDoc cd, ProgramElementDoc member, |
bpatel@766 | 260 | Content tdSummary) { |
bpatel@2147 | 261 | Content memberLink = HtmlTree.SPAN(HtmlStyle.memberNameLink, |
jjg@1736 | 262 | writer.getDocLink(context, cd , (MemberDoc) member, member.name(), false)); |
bpatel@2147 | 263 | Content code = HtmlTree.CODE(memberLink); |
bpatel@766 | 264 | tdSummary.addContent(code); |
duke@1 | 265 | } |
duke@1 | 266 | |
bpatel@766 | 267 | /** |
bpatel@766 | 268 | * {@inheritDoc} |
bpatel@766 | 269 | */ |
bpatel@766 | 270 | protected void addInheritedSummaryLink(ClassDoc cd, |
bpatel@766 | 271 | ProgramElementDoc member, Content linksTree) { |
jjg@1736 | 272 | linksTree.addContent( |
jjg@1735 | 273 | writer.getDocLink(LinkInfoImpl.Kind.MEMBER, cd, (MemberDoc)member, |
jjg@1736 | 274 | member.name(), false)); |
duke@1 | 275 | } |
duke@1 | 276 | |
bpatel@766 | 277 | /** |
bpatel@766 | 278 | * {@inheritDoc} |
bpatel@766 | 279 | */ |
bpatel@766 | 280 | protected void addSummaryType(ProgramElementDoc member, Content tdSummaryType) { |
duke@1 | 281 | FieldDoc field = (FieldDoc)member; |
bpatel@766 | 282 | addModifierAndType(field, field.type(), tdSummaryType); |
duke@1 | 283 | } |
duke@1 | 284 | |
bpatel@766 | 285 | /** |
bpatel@766 | 286 | * {@inheritDoc} |
bpatel@766 | 287 | */ |
bpatel@766 | 288 | protected Content getDeprecatedLink(ProgramElementDoc member) { |
jjg@1735 | 289 | return writer.getDocLink(LinkInfoImpl.Kind.MEMBER, |
bpatel@766 | 290 | (MemberDoc) member, ((FieldDoc)member).qualifiedName()); |
duke@1 | 291 | } |
duke@1 | 292 | |
bpatel@766 | 293 | /** |
bpatel@766 | 294 | * {@inheritDoc} |
bpatel@766 | 295 | */ |
bpatel@766 | 296 | protected Content getNavSummaryLink(ClassDoc cd, boolean link) { |
duke@1 | 297 | if (link) { |
bpatel@2101 | 298 | if (cd == null) { |
bpatel@2101 | 299 | return writer.getHyperLink( |
bpatel@2101 | 300 | SectionName.FIELD_SUMMARY, |
bpatel@2101 | 301 | writer.getResource("doclet.navField")); |
bpatel@2101 | 302 | } else { |
bpatel@2101 | 303 | return writer.getHyperLink( |
bpatel@2101 | 304 | SectionName.FIELDS_INHERITANCE, |
bpatel@2101 | 305 | configuration.getClassName(cd), writer.getResource("doclet.navField")); |
bpatel@2101 | 306 | } |
duke@1 | 307 | } else { |
bpatel@766 | 308 | return writer.getResource("doclet.navField"); |
duke@1 | 309 | } |
duke@1 | 310 | } |
duke@1 | 311 | |
bpatel@766 | 312 | /** |
bpatel@766 | 313 | * {@inheritDoc} |
bpatel@766 | 314 | */ |
bpatel@766 | 315 | protected void addNavDetailLink(boolean link, Content liNav) { |
duke@1 | 316 | if (link) { |
bpatel@2101 | 317 | liNav.addContent(writer.getHyperLink( |
bpatel@2101 | 318 | SectionName.FIELD_DETAIL, |
bpatel@766 | 319 | writer.getResource("doclet.navField"))); |
duke@1 | 320 | } else { |
bpatel@766 | 321 | liNav.addContent(writer.getResource("doclet.navField")); |
duke@1 | 322 | } |
duke@1 | 323 | } |
duke@1 | 324 | } |