1 /* 2 * Copyright (c) 1997, 2019, 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; 27 28 import javax.lang.model.element.Element; 29 import javax.lang.model.element.ExecutableElement; 30 import javax.lang.model.element.TypeElement; 31 32 import jdk.javadoc.internal.doclets.formats.html.markup.ContentBuilder; 33 import jdk.javadoc.internal.doclets.formats.html.markup.Entity; 34 import jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyle; 35 import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree; 36 import jdk.javadoc.internal.doclets.formats.html.markup.StringContent; 37 import jdk.javadoc.internal.doclets.formats.html.markup.Table; 38 import jdk.javadoc.internal.doclets.formats.html.markup.TableHeader; 39 import jdk.javadoc.internal.doclets.toolkit.Content; 40 import jdk.javadoc.internal.doclets.toolkit.MemberSummaryWriter; 41 import jdk.javadoc.internal.doclets.toolkit.PropertyWriter; 42 43 /** 44 * Writes property documentation in HTML format. 45 * 46 * <p><b>This is NOT part of any supported API. 47 * If you write code that depends on this, you do so at your own risk. 48 * This code and its internal interfaces are subject to change or 49 * deletion without notice.</b> 50 */ 51 public class PropertyWriterImpl extends AbstractMemberWriter 52 implements PropertyWriter, MemberSummaryWriter { 53 54 public PropertyWriterImpl(SubWriterHolderWriter writer, TypeElement typeElement) { 55 super(writer, typeElement); 56 } 57 58 /** 59 * {@inheritDoc} 60 */ 61 @Override 62 public Content getMemberSummaryHeader(TypeElement typeElement, Content memberSummaryTree) { 63 memberSummaryTree.add(MarkerComments.START_OF_PROPERTY_SUMMARY); 64 Content memberTree = new ContentBuilder(); 65 writer.addSummaryHeader(this, memberTree); 66 return memberTree; 67 } 68 69 /** 70 * {@inheritDoc} 71 */ 72 @Override 73 public void addMemberTree(Content memberSummaryTree, Content memberTree) { 74 writer.addMemberTree(HtmlStyle.propertySummary, 75 SectionName.PROPERTY_SUMMARY, memberSummaryTree, memberTree); 76 } 77 78 /** 79 * {@inheritDoc} 80 */ 81 @Override 82 public Content getPropertyDetailsTreeHeader(Content memberDetailsTree) { 83 memberDetailsTree.add(MarkerComments.START_OF_PROPERTY_DETAILS); 84 Content propertyDetailsTree = new ContentBuilder(); 85 Content heading = HtmlTree.HEADING(Headings.TypeDeclaration.DETAILS_HEADING, 86 contents.propertyDetailsLabel); 87 propertyDetailsTree.add(heading); 88 return propertyDetailsTree; 89 } 90 91 /** 92 * {@inheritDoc} 93 */ 94 @Override 95 public Content getPropertyDocTreeHeader(ExecutableElement property) { 96 Content propertyDocTree = new ContentBuilder(); 97 Content heading = new HtmlTree(Headings.TypeDeclaration.MEMBER_HEADING, 98 new StringContent(utils.getPropertyLabel(name(property)))); 99 propertyDocTree.add(heading); 100 return HtmlTree.SECTION(HtmlStyle.detail, propertyDocTree) 101 .setId(name(property)); 102 } 103 104 /** 105 * {@inheritDoc} 106 */ 107 @Override 108 public Content getSignature(ExecutableElement property) { 109 return new MemberSignature(property) 110 .addType(utils.getReturnType(property)) 111 .toContent(); 112 } 113 114 /** 115 * {@inheritDoc} 116 */ 117 @Override 118 public void addDeprecated(ExecutableElement property, Content propertyDocTree) { 119 } 120 121 /** 122 * {@inheritDoc} 123 */ 124 @Override 125 public void addComments(ExecutableElement property, Content propertyDocTree) { 126 TypeElement holder = (TypeElement)property.getEnclosingElement(); 127 if (!utils.getFullBody(property).isEmpty()) { 128 if (holder.equals(typeElement) || 129 (!utils.isPublic(holder) || utils.isLinkable(holder))) { 130 writer.addInlineComment(property, propertyDocTree); 131 } else { 132 Content link = 133 writer.getDocLink(LinkInfoImpl.Kind.PROPERTY_COPY, 134 holder, property, 135 utils.isIncluded(holder) 136 ? holder.getSimpleName() : holder.getQualifiedName(), 137 false); 138 Content codeLink = HtmlTree.CODE(link); 139 Content descfrmLabel = HtmlTree.SPAN(HtmlStyle.descfrmTypeLabel, 140 utils.isClass(holder) 141 ? contents.descfrmClassLabel 142 : contents.descfrmInterfaceLabel); 143 descfrmLabel.add(Entity.NO_BREAK_SPACE); 144 descfrmLabel.add(codeLink); 145 propertyDocTree.add(HtmlTree.DIV(HtmlStyle.block, descfrmLabel)); 146 writer.addInlineComment(property, propertyDocTree); 147 } 148 } 149 } 150 151 /** 152 * {@inheritDoc} 153 */ 154 @Override 155 public void addTags(ExecutableElement property, Content propertyDocTree) { 156 writer.addTagsInfo(property, propertyDocTree); 157 } 158 159 /** 160 * {@inheritDoc} 161 */ 162 @Override 163 public Content getPropertyDetails(Content propertyDetailsTreeHeader, Content propertyDetailsTree) { 164 Content propertyDetails = new ContentBuilder(propertyDetailsTreeHeader, propertyDetailsTree); 165 return getMemberTree(HtmlTree.SECTION(HtmlStyle.propertyDetails, propertyDetails) 166 .setId(SectionName.PROPERTY_DETAIL.getName())); 167 } 168 169 /** 170 * {@inheritDoc} 171 */ 172 @Override 173 public Content getPropertyDoc(Content propertyDocTree) { 174 return getMemberTree(propertyDocTree); 175 } 176 177 /** 178 * {@inheritDoc} 179 */ 180 @Override 181 public void addSummaryLabel(Content memberTree) { 182 Content label = HtmlTree.HEADING(Headings.TypeDeclaration.SUMMARY_HEADING, 183 contents.propertySummaryLabel); 184 memberTree.add(label); 185 } 186 187 /** 188 * {@inheritDoc} 189 */ 190 @Override 191 public TableHeader getSummaryTableHeader(Element member) { 192 return new TableHeader(contents.typeLabel, contents.propertyLabel, 193 contents.descriptionLabel); 194 } 195 196 /** 197 * {@inheritDoc} 198 */ 199 @Override 200 protected Table createSummaryTable() { 201 return new Table(HtmlStyle.memberSummary) 202 .setCaption(contents.properties) 203 .setHeader(getSummaryTableHeader(typeElement)) 204 .setColumnStyles(HtmlStyle.colFirst, HtmlStyle.colSecond, HtmlStyle.colLast) 205 .setRowScopeColumn(1); 206 } 207 208 /** 209 * {@inheritDoc} 210 */ 211 @Override 212 public void addInheritedSummaryLabel(TypeElement typeElement, Content inheritedTree) { 213 Content classLink = writer.getPreQualifiedClassLink( 214 LinkInfoImpl.Kind.MEMBER, typeElement, false); 215 Content label; 216 if (configuration.summarizeOverriddenMethods) { 217 label = new StringContent(utils.isClass(typeElement) 218 ? resources.getText("doclet.Properties_Declared_In_Class") 219 : resources.getText("doclet.Properties_Declared_In_Interface")); 220 } else { 221 label = new StringContent(utils.isClass(typeElement) 222 ? resources.getText("doclet.Properties_Inherited_From_Class") 223 : resources.getText("doclet.Properties_Inherited_From_Interface")); 224 } 225 HtmlTree labelHeading = HtmlTree.HEADING(Headings.TypeDeclaration.INHERITED_SUMMARY_HEADING, 226 label); 227 labelHeading.setId(SectionName.PROPERTIES_INHERITANCE.getName() 228 + links.getName(configuration.getClassName(typeElement))); 229 labelHeading.add(Entity.NO_BREAK_SPACE); 230 labelHeading.add(classLink); 231 inheritedTree.add(labelHeading); 232 } 233 234 /** 235 * {@inheritDoc} 236 */ 237 @Override 238 protected void addSummaryLink(LinkInfoImpl.Kind context, TypeElement typeElement, Element member, 239 Content tdSummary) { 240 Content memberLink = HtmlTree.SPAN(HtmlStyle.memberNameLink, 241 writer.getDocLink(context, typeElement, 242 member, 243 utils.getPropertyLabel(name(member)), 244 false, 245 true)); 246 247 Content code = HtmlTree.CODE(memberLink); 248 tdSummary.add(code); 249 } 250 251 /** 252 * {@inheritDoc} 253 */ 254 @Override 255 protected void addInheritedSummaryLink(TypeElement typeElement, Element member, Content linksTree) { 256 String mname = name(member); 257 Content content = writer.getDocLink(LinkInfoImpl.Kind.MEMBER, typeElement, member, 258 utils.isProperty(mname) ? utils.getPropertyName(mname) : mname, 259 false, true); 260 linksTree.add(content); 261 } 262 263 /** 264 * {@inheritDoc} 265 */ 266 @Override 267 protected void addSummaryType(Element member, Content tdSummaryType) { 268 addModifierAndType(member, utils.getReturnType((ExecutableElement)member), tdSummaryType); 269 } 270 271 /** 272 * {@inheritDoc} 273 */ 274 @Override 275 protected Content getDeprecatedLink(Element member) { 276 return writer.getDocLink(LinkInfoImpl.Kind.MEMBER, member, 277 utils.getFullyQualifiedName(member)); 278 } 279 280 @Override 281 public Content getMemberTreeHeader(){ 282 return writer.getMemberTreeHeader(); 283 } 284 }