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 java.util.Arrays;
29 import java.util.List;
30
31 import javax.lang.model.element.Element;
32 import javax.lang.model.element.ExecutableElement;
33 import javax.lang.model.element.TypeElement;
34
35 import jdk.javadoc.internal.doclets.formats.html.markup.HtmlConstants;
36 import jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyle;
37 import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTag;
38 import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;
39 import jdk.javadoc.internal.doclets.formats.html.markup.StringContent;
40 import jdk.javadoc.internal.doclets.toolkit.Content;
41 import jdk.javadoc.internal.doclets.toolkit.MemberSummaryWriter;
42 import jdk.javadoc.internal.doclets.toolkit.PropertyWriter;
43
44
45 /**
46 * Writes property documentation in HTML format.
47 *
48 * <p><b>This is NOT part of any supported API.
49 * If you write code that depends on this, you do so at your own risk.
50 * This code and its internal interfaces are subject to change or
51 * deletion without notice.</b>
52 *
53 * @author Robert Field
54 * @author Atul M Dambalkar
55 * @author Jamie Ho (rewrite)
56 * @author Bhavesh Patel (Modified)
57 */
58 public class PropertyWriterImpl extends AbstractMemberWriter
59 implements PropertyWriter, MemberSummaryWriter {
60
61 public PropertyWriterImpl(SubWriterHolderWriter writer, TypeElement typeElement) {
62 super(writer, typeElement);
63 }
64
65 /**
66 * {@inheritDoc}
67 */
68 @Override
69 public Content getMemberSummaryHeader(TypeElement typeElement,
70 Content memberSummaryTree) {
71 memberSummaryTree.addContent(HtmlConstants.START_OF_PROPERTY_SUMMARY);
72 Content memberTree = writer.getMemberTreeHeader();
73 writer.addSummaryHeader(this, typeElement, memberTree);
74 return memberTree;
75 }
76
77 @Override
78 public boolean showTabs() {
79 return false;
80 }
81
82 /**
83 * {@inheritDoc}
84 */
85 public void addMemberTree(Content memberSummaryTree, Content memberTree) {
86 writer.addMemberTree(memberSummaryTree, memberTree);
87 }
88
89 /**
90 * {@inheritDoc}
91 */
92 @Override
93 public Content getPropertyDetailsTreeHeader(TypeElement typeElement,
94 Content memberDetailsTree) {
95 memberDetailsTree.addContent(HtmlConstants.START_OF_PROPERTY_DETAILS);
96 Content propertyDetailsTree = writer.getMemberTreeHeader();
97 propertyDetailsTree.addContent(writer.getMarkerAnchor(
98 SectionName.PROPERTY_DETAIL));
99 Content heading = HtmlTree.HEADING(HtmlConstants.DETAILS_HEADING,
100 contents.propertyDetailsLabel);
101 propertyDetailsTree.addContent(heading);
102 return propertyDetailsTree;
103 }
104
220 */
221 @Override
222 public String getTableSummary() {
223 return resources.getText("doclet.Member_Table_Summary",
224 resources.getText("doclet.Property_Summary"),
225 resources.getText("doclet.properties"));
226 }
227
228 /**
229 * {@inheritDoc}
230 */
231 @Override
232 public Content getCaption() {
233 return contents.properties;
234 }
235
236 /**
237 * {@inheritDoc}
238 */
239 @Override
240 public List<String> getSummaryTableHeader(Element member) {
241 List<String> header = Arrays.asList(resources.getText("doclet.Type"),
242 resources.getText("doclet.Property"), resources.getText("doclet.Description"));
243 return header;
244 }
245
246 /**
247 * {@inheritDoc}
248 */
249 @Override
250 public void addSummaryAnchor(TypeElement typeElement, Content memberTree) {
251 memberTree.addContent(writer.getMarkerAnchor(
252 SectionName.PROPERTY_SUMMARY));
253 }
254
255 /**
256 * {@inheritDoc}
257 */
258 @Override
259 public void addInheritedSummaryAnchor(TypeElement typeElement, Content inheritedTree) {
260 inheritedTree.addContent(writer.getMarkerAnchor(
261 SectionName.PROPERTIES_INHERITANCE,
262 configuration.getClassName(typeElement)));
263 }
|
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
29 import javax.lang.model.element.Element;
30 import javax.lang.model.element.ExecutableElement;
31 import javax.lang.model.element.TypeElement;
32
33 import jdk.javadoc.internal.doclets.formats.html.TableHeader;
34 import jdk.javadoc.internal.doclets.formats.html.markup.HtmlConstants;
35 import jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyle;
36 import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTag;
37 import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;
38 import jdk.javadoc.internal.doclets.formats.html.markup.StringContent;
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 /**
45 * Writes property documentation in HTML format.
46 *
47 * <p><b>This is NOT part of any supported API.
48 * If you write code that depends on this, you do so at your own risk.
49 * This code and its internal interfaces are subject to change or
50 * deletion without notice.</b>
51 *
52 * @author Robert Field
53 * @author Atul M Dambalkar
54 * @author Jamie Ho (rewrite)
55 * @author Bhavesh Patel (Modified)
56 */
57 public class PropertyWriterImpl extends AbstractMemberWriter
58 implements PropertyWriter, MemberSummaryWriter {
59
60 public PropertyWriterImpl(SubWriterHolderWriter writer, TypeElement typeElement) {
61 super(writer, typeElement);
62 }
63
64 /**
65 * {@inheritDoc}
66 */
67 @Override
68 public Content getMemberSummaryHeader(TypeElement typeElement, Content memberSummaryTree) {
69 memberSummaryTree.addContent(HtmlConstants.START_OF_PROPERTY_SUMMARY);
70 Content memberTree = writer.getMemberTreeHeader();
71 writer.addSummaryHeader(this, typeElement, memberTree);
72 return memberTree;
73 }
74
75 @Override
76 public boolean showTabs() {
77 return false;
78 }
79
80 /**
81 * {@inheritDoc}
82 */
83 @Override
84 public void addMemberTree(Content memberSummaryTree, Content memberTree) {
85 writer.addMemberTree(memberSummaryTree, memberTree);
86 }
87
88 /**
89 * {@inheritDoc}
90 */
91 @Override
92 public Content getPropertyDetailsTreeHeader(TypeElement typeElement,
93 Content memberDetailsTree) {
94 memberDetailsTree.addContent(HtmlConstants.START_OF_PROPERTY_DETAILS);
95 Content propertyDetailsTree = writer.getMemberTreeHeader();
96 propertyDetailsTree.addContent(writer.getMarkerAnchor(
97 SectionName.PROPERTY_DETAIL));
98 Content heading = HtmlTree.HEADING(HtmlConstants.DETAILS_HEADING,
99 contents.propertyDetailsLabel);
100 propertyDetailsTree.addContent(heading);
101 return propertyDetailsTree;
102 }
103
219 */
220 @Override
221 public String getTableSummary() {
222 return resources.getText("doclet.Member_Table_Summary",
223 resources.getText("doclet.Property_Summary"),
224 resources.getText("doclet.properties"));
225 }
226
227 /**
228 * {@inheritDoc}
229 */
230 @Override
231 public Content getCaption() {
232 return contents.properties;
233 }
234
235 /**
236 * {@inheritDoc}
237 */
238 @Override
239 public TableHeader getSummaryTableHeader(Element member) {
240 return new TableHeader(contents.typeLabel, contents.propertyLabel,
241 contents.descriptionLabel);
242 }
243
244 /**
245 * {@inheritDoc}
246 */
247 @Override
248 public void addSummaryAnchor(TypeElement typeElement, Content memberTree) {
249 memberTree.addContent(writer.getMarkerAnchor(
250 SectionName.PROPERTY_SUMMARY));
251 }
252
253 /**
254 * {@inheritDoc}
255 */
256 @Override
257 public void addInheritedSummaryAnchor(TypeElement typeElement, Content inheritedTree) {
258 inheritedTree.addContent(writer.getMarkerAnchor(
259 SectionName.PROPERTIES_INHERITANCE,
260 configuration.getClassName(typeElement)));
261 }
|