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, typeElement, 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, memberSummaryTree, memberTree);
75 }
76
77 /**
78 * {@inheritDoc}
79 */
80 @Override
81 public Content getPropertyDetailsTreeHeader(TypeElement typeElement,
82 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(links.createAnchor(SectionName.PROPERTY_DETAIL));
88 propertyDetailsTree.add(heading);
89 return propertyDetailsTree;
90 }
91
92 /**
93 * {@inheritDoc}
94 */
95 @Override
96 public Content getPropertyDocTreeHeader(ExecutableElement property,
97 Content propertyDetailsTree) {
98 Content propertyDocTree = new ContentBuilder();
99 Content heading = new HtmlTree(Headings.TypeDeclaration.MEMBER_HEADING);
100 heading.add(links.createAnchor(name(property),
101 new StringContent(utils.getPropertyLabel(name(property)))));
102 propertyDocTree.add(heading);
103 return HtmlTree.SECTION(HtmlStyle.detail, propertyDocTree);
104 }
105
106 /**
107 * {@inheritDoc}
108 */
109 @Override
110 public Content getSignature(ExecutableElement property) {
111 return new MemberSignature(property)
112 .addType(utils.getReturnType(property))
113 .toContent();
114 }
115
116 /**
117 * {@inheritDoc}
118 */
119 @Override
120 public void addDeprecated(ExecutableElement property, Content propertyDocTree) {
121 }
122
123 /**
124 * {@inheritDoc}
125 */
126 @Override
127 public void addComments(ExecutableElement property, Content propertyDocTree) {
128 TypeElement holder = (TypeElement)property.getEnclosingElement();
129 if (!utils.getFullBody(property).isEmpty()) {
130 if (holder.equals(typeElement) ||
131 (!utils.isPublic(holder) || utils.isLinkable(holder))) {
132 writer.addInlineComment(property, propertyDocTree);
133 } else {
134 Content link =
135 writer.getDocLink(LinkInfoImpl.Kind.PROPERTY_COPY,
136 holder, property,
137 utils.isIncluded(holder)
138 ? holder.getSimpleName() : holder.getQualifiedName(),
139 false);
140 Content codeLink = HtmlTree.CODE(link);
141 Content descfrmLabel = HtmlTree.SPAN(HtmlStyle.descfrmTypeLabel,
142 utils.isClass(holder)
143 ? contents.descfrmClassLabel
144 : contents.descfrmInterfaceLabel);
145 descfrmLabel.add(Entity.NO_BREAK_SPACE);
146 descfrmLabel.add(codeLink);
147 propertyDocTree.add(HtmlTree.DIV(HtmlStyle.block, descfrmLabel));
148 writer.addInlineComment(property, propertyDocTree);
149 }
150 }
151 }
152
153 /**
154 * {@inheritDoc}
155 */
156 @Override
157 public void addTags(ExecutableElement property, Content propertyDocTree) {
158 writer.addTagsInfo(property, propertyDocTree);
159 }
160
161 /**
162 * {@inheritDoc}
163 */
164 @Override
165 public Content getPropertyDetails(Content propertyDetailsTreeHeader, Content propertyDetailsTree) {
166 Content propertyDetails = new ContentBuilder(propertyDetailsTreeHeader, propertyDetailsTree);
167 return getMemberTree(HtmlTree.SECTION(HtmlStyle.propertyDetails, propertyDetails));
168 }
169
170 /**
171 * {@inheritDoc}
172 */
173 @Override
174 public Content getPropertyDoc(Content propertyDocTree) {
175 return getMemberTree(propertyDocTree);
176 }
177
178 /**
179 * {@inheritDoc}
180 */
181 @Override
182 public void addSummaryLabel(Content memberTree) {
183 Content label = HtmlTree.HEADING(Headings.TypeDeclaration.SUMMARY_HEADING,
184 contents.propertySummaryLabel);
185 memberTree.add(label);
186 }
187
188 /**
189 * {@inheritDoc}
190 */
191 @Override
192 public TableHeader getSummaryTableHeader(Element member) {
193 return new TableHeader(contents.typeLabel, contents.propertyLabel,
194 contents.descriptionLabel);
195 }
196
197 /**
198 * {@inheritDoc}
199 */
200 @Override
201 protected Table createSummaryTable() {
202 return new Table(HtmlStyle.memberSummary)
203 .setCaption(contents.properties)
204 .setHeader(getSummaryTableHeader(typeElement))
205 .setColumnStyles(HtmlStyle.colFirst, HtmlStyle.colSecond, HtmlStyle.colLast)
206 .setRowScopeColumn(1);
207 }
208
209 /**
210 * {@inheritDoc}
211 */
212 @Override
213 public void addSummaryAnchor(TypeElement typeElement, Content memberTree) {
214 memberTree.add(links.createAnchor(SectionName.PROPERTY_SUMMARY));
215 }
216
217 /**
218 * {@inheritDoc}
219 */
220 @Override
221 public void addInheritedSummaryAnchor(TypeElement typeElement, Content inheritedTree) {
222 inheritedTree.add(links.createAnchor(
223 SectionName.PROPERTIES_INHERITANCE,
224 configuration.getClassName(typeElement)));
225 }
226
227 /**
228 * {@inheritDoc}
229 */
230 @Override
231 public void addInheritedSummaryLabel(TypeElement typeElement, Content inheritedTree) {
232 Content classLink = writer.getPreQualifiedClassLink(
233 LinkInfoImpl.Kind.MEMBER, typeElement, false);
234 Content label;
235 if (configuration.summarizeOverriddenMethods) {
236 label = new StringContent(utils.isClass(typeElement)
237 ? resources.getText("doclet.Properties_Declared_In_Class")
238 : resources.getText("doclet.Properties_Declared_In_Interface"));
239 } else {
240 label = new StringContent(utils.isClass(typeElement)
241 ? resources.getText("doclet.Properties_Inherited_From_Class")
242 : resources.getText("doclet.Properties_Inherited_From_Interface"));
243 }
244 Content labelHeading = HtmlTree.HEADING(Headings.TypeDeclaration.INHERITED_SUMMARY_HEADING,
245 label);
246 labelHeading.add(Entity.NO_BREAK_SPACE);
247 labelHeading.add(classLink);
248 inheritedTree.add(labelHeading);
249 }
250
251 /**
252 * {@inheritDoc}
253 */
254 @Override
255 protected void addSummaryLink(LinkInfoImpl.Kind context, TypeElement typeElement, Element member,
256 Content tdSummary) {
257 Content memberLink = HtmlTree.SPAN(HtmlStyle.memberNameLink,
258 writer.getDocLink(context, typeElement,
259 member,
260 utils.getPropertyLabel(name(member)),
261 false,
262 true));
263
264 Content code = HtmlTree.CODE(memberLink);
265 tdSummary.add(code);
266 }
267
268 /**
269 * {@inheritDoc}
270 */
271 @Override
272 protected void addInheritedSummaryLink(TypeElement typeElement, Element member, Content linksTree) {
273 String mname = name(member);
274 Content content = writer.getDocLink(LinkInfoImpl.Kind.MEMBER, typeElement, member,
275 utils.isProperty(mname) ? utils.getPropertyName(mname) : mname,
276 false, true);
277 linksTree.add(content);
278 }
279
280 /**
281 * {@inheritDoc}
282 */
283 @Override
284 protected void addSummaryType(Element member, Content tdSummaryType) {
285 addModifierAndType(member, utils.getReturnType((ExecutableElement)member), tdSummaryType);
286 }
287
288 /**
289 * {@inheritDoc}
290 */
291 @Override
292 protected Content getDeprecatedLink(Element member) {
293 return writer.getDocLink(LinkInfoImpl.Kind.MEMBER, member,
294 utils.getFullyQualifiedName(member));
295 }
296
297 @Override
298 public Content getMemberTreeHeader(){
299 return writer.getMemberTreeHeader();
300 }
301 }