jdk-sandbox: langtools/src/share/classes/com/sun/tools/doclets/formats/html/FieldWriterImpl.java@cfadc977ca75 (annotated)

10 06bc494ca11e Initial load duke parents: diff changeset	1	/*
5520 86e4b9a9da40 6943119: Rebrand source copyright notices ohair parents: 2320 diff changeset	2	* Copyright (c) 1997, 2004, Oracle and/or its affiliates. All rights reserved.
10 06bc494ca11e Initial load duke parents: diff changeset	3	* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
06bc494ca11e Initial load duke parents: diff changeset	4	*
06bc494ca11e Initial load duke parents: diff changeset	5	* This code is free software; you can redistribute it and/or modify it
06bc494ca11e Initial load duke parents: diff changeset	6	* under the terms of the GNU General Public License version 2 only, as
5520 86e4b9a9da40 6943119: Rebrand source copyright notices ohair parents: 2320 diff changeset	7	* published by the Free Software Foundation. Oracle designates this
10 06bc494ca11e Initial load duke parents: diff changeset	8	* particular file as subject to the "Classpath" exception as provided
5520 86e4b9a9da40 6943119: Rebrand source copyright notices ohair parents: 2320 diff changeset	9	* by Oracle in the LICENSE file that accompanied this code.
10 06bc494ca11e Initial load duke parents: diff changeset	10	*
06bc494ca11e Initial load duke parents: diff changeset	11	* This code is distributed in the hope that it will be useful, but WITHOUT
06bc494ca11e Initial load duke parents: diff changeset	12	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
06bc494ca11e Initial load duke parents: diff changeset	13	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
06bc494ca11e Initial load duke parents: diff changeset	14	* version 2 for more details (a copy is included in the LICENSE file that
06bc494ca11e Initial load duke parents: diff changeset	15	* accompanied this code).
06bc494ca11e Initial load duke parents: diff changeset	16	*
06bc494ca11e Initial load duke parents: diff changeset	17	* You should have received a copy of the GNU General Public License version
06bc494ca11e Initial load duke parents: diff changeset	18	* 2 along with this work; if not, write to the Free Software Foundation,
06bc494ca11e Initial load duke parents: diff changeset	19	* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
06bc494ca11e Initial load duke parents: diff changeset	20	*
5520 86e4b9a9da40 6943119: Rebrand source copyright notices ohair parents: 2320 diff changeset	21	* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
86e4b9a9da40 6943119: Rebrand source copyright notices ohair parents: 2320 diff changeset	22	* or visit www.oracle.com if you need additional information or have any
86e4b9a9da40 6943119: Rebrand source copyright notices ohair parents: 2320 diff changeset	23	* questions.
10 06bc494ca11e Initial load duke parents: diff changeset	24	*/
06bc494ca11e Initial load duke parents: diff changeset	25
06bc494ca11e Initial load duke parents: diff changeset	26	package com.sun.tools.doclets.formats.html;
06bc494ca11e Initial load duke parents: diff changeset	27
2216 b124d5c924eb 6786690: Javadoc HTML WCAG 2.0 accessibility issues in standard doclet - DL tag and nesting issue bpatel parents: 1787 diff changeset	28	import java.io.*;
b124d5c924eb 6786690: Javadoc HTML WCAG 2.0 accessibility issues in standard doclet - DL tag and nesting issue bpatel parents: 1787 diff changeset	29
b124d5c924eb 6786690: Javadoc HTML WCAG 2.0 accessibility issues in standard doclet - DL tag and nesting issue bpatel parents: 1787 diff changeset	30	import com.sun.javadoc.*;
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	31	import com.sun.tools.doclets.formats.html.markup.*;
10 06bc494ca11e Initial load duke parents: diff changeset	32	import com.sun.tools.doclets.internal.toolkit.*;
06bc494ca11e Initial load duke parents: diff changeset	33	import com.sun.tools.doclets.internal.toolkit.util.*;
06bc494ca11e Initial load duke parents: diff changeset	34
06bc494ca11e Initial load duke parents: diff changeset	35	/**
06bc494ca11e Initial load duke parents: diff changeset	36	* Writes field documentation in HTML format.
06bc494ca11e Initial load duke parents: diff changeset	37	*
06bc494ca11e Initial load duke parents: diff changeset	38	* @author Robert Field
06bc494ca11e Initial load duke parents: diff changeset	39	* @author Atul M Dambalkar
06bc494ca11e Initial load duke parents: diff changeset	40	* @author Jamie Ho (rewrite)
2320 5b8c377175f4 6786688: Javadoc HTML WCAG 2.0 accessibility issues in standard doclet - Table must have captions and headers bpatel parents: 2216 diff changeset	41	* @author Bhavesh Patel (Modified)
10 06bc494ca11e Initial load duke parents: diff changeset	42	*/
06bc494ca11e Initial load duke parents: diff changeset	43	public class FieldWriterImpl extends AbstractMemberWriter
06bc494ca11e Initial load duke parents: diff changeset	44	implements FieldWriter, MemberSummaryWriter {
06bc494ca11e Initial load duke parents: diff changeset	45
06bc494ca11e Initial load duke parents: diff changeset	46	public FieldWriterImpl(SubWriterHolderWriter writer, ClassDoc classdoc) {
06bc494ca11e Initial load duke parents: diff changeset	47	super(writer, classdoc);
06bc494ca11e Initial load duke parents: diff changeset	48	}
06bc494ca11e Initial load duke parents: diff changeset	49
06bc494ca11e Initial load duke parents: diff changeset	50	public FieldWriterImpl(SubWriterHolderWriter writer) {
06bc494ca11e Initial load duke parents: diff changeset	51	super(writer);
06bc494ca11e Initial load duke parents: diff changeset	52	}
06bc494ca11e Initial load duke parents: diff changeset	53
06bc494ca11e Initial load duke parents: diff changeset	54	/**
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	55	* {@inheritDoc}
10 06bc494ca11e Initial load duke parents: diff changeset	56	*/
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	57	public Content getMemberSummaryHeader(ClassDoc classDoc,
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	58	Content memberSummaryTree) {
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	59	memberSummaryTree.addContent(HtmlConstants.START_OF_FIELD_SUMMARY);
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	60	Content memberTree = writer.getMemberTreeHeader();
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	61	writer.addSummaryHeader(this, classDoc, memberTree);
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	62	return memberTree;
10 06bc494ca11e Initial load duke parents: diff changeset	63	}
06bc494ca11e Initial load duke parents: diff changeset	64
06bc494ca11e Initial load duke parents: diff changeset	65	/**
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	66	* {@inheritDoc}
10 06bc494ca11e Initial load duke parents: diff changeset	67	*/
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	68	public Content getFieldDetailsTreeHeader(ClassDoc classDoc,
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	69	Content memberDetailsTree) {
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	70	memberDetailsTree.addContent(HtmlConstants.START_OF_FIELD_DETAILS);
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	71	Content fieldDetailsTree = writer.getMemberTreeHeader();
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	72	fieldDetailsTree.addContent(writer.getMarkerAnchor("field_detail"));
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	73	Content heading = HtmlTree.HEADING(HtmlConstants.DETAILS_HEADING,
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	74	writer.fieldDetailsLabel);
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	75	fieldDetailsTree.addContent(heading);
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	76	return fieldDetailsTree;
10 06bc494ca11e Initial load duke parents: diff changeset	77	}
06bc494ca11e Initial load duke parents: diff changeset	78
06bc494ca11e Initial load duke parents: diff changeset	79	/**
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	80	* {@inheritDoc}
10 06bc494ca11e Initial load duke parents: diff changeset	81	*/
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	82	public Content getFieldDocTreeHeader(FieldDoc field,
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	83	Content fieldDetailsTree) {
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	84	fieldDetailsTree.addContent(
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	85	writer.getMarkerAnchor(field.name()));
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	86	Content fieldDocTree = writer.getMemberTreeHeader();
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	87	Content heading = new HtmlTree(HtmlConstants.MEMBER_HEADING);
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	88	heading.addContent(field.name());
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	89	fieldDocTree.addContent(heading);
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	90	return fieldDocTree;
10 06bc494ca11e Initial load duke parents: diff changeset	91	}
06bc494ca11e Initial load duke parents: diff changeset	92
06bc494ca11e Initial load duke parents: diff changeset	93	/**
06bc494ca11e Initial load duke parents: diff changeset	94	* {@inheritDoc}
06bc494ca11e Initial load duke parents: diff changeset	95	*/
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	96	public Content getSignature(FieldDoc field) {
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	97	Content pre = new HtmlTree(HtmlTag.PRE);
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	98	writer.addAnnotationInfo(field, pre);
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	99	addModifiers(field, pre);
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	100	Content fieldlink = new RawHtml(writer.getLink(new LinkInfoImpl(LinkInfoImpl.CONTEXT_MEMBER,
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	101	field.type())));
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	102	pre.addContent(fieldlink);
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	103	pre.addContent(" ");
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	104	if (configuration().linksource) {
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	105	Content fieldName = new StringContent(field.name());
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	106	writer.addSrcLink(field, fieldName, pre);
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	107	} else {
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	108	addName(field.name(), pre);
10 06bc494ca11e Initial load duke parents: diff changeset	109	}
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	110	return pre;
10 06bc494ca11e Initial load duke parents: diff changeset	111	}
06bc494ca11e Initial load duke parents: diff changeset	112
06bc494ca11e Initial load duke parents: diff changeset	113	/**
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	114	* {@inheritDoc}
10 06bc494ca11e Initial load duke parents: diff changeset	115	*/
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	116	public void addDeprecated(FieldDoc field, Content fieldDocTree) {
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	117	addDeprecatedInfo(field, fieldDocTree);
10 06bc494ca11e Initial load duke parents: diff changeset	118	}
06bc494ca11e Initial load duke parents: diff changeset	119
06bc494ca11e Initial load duke parents: diff changeset	120	/**
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	121	* {@inheritDoc}
10 06bc494ca11e Initial load duke parents: diff changeset	122	*/
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	123	public void addComments(FieldDoc field, Content fieldDocTree) {
10 06bc494ca11e Initial load duke parents: diff changeset	124	ClassDoc holder = field.containingClass();
06bc494ca11e Initial load duke parents: diff changeset	125	if (field.inlineTags().length > 0) {
06bc494ca11e Initial load duke parents: diff changeset	126	if (holder.equals(classdoc) \|\|
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	127	(! (holder.isPublic() \|\| Util.isLinkable(holder, configuration())))) {
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	128	writer.addInlineComment(field, fieldDocTree);
10 06bc494ca11e Initial load duke parents: diff changeset	129	} else {
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	130	Content link = new RawHtml(
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	131	writer.getDocLink(LinkInfoImpl.CONTEXT_FIELD_DOC_COPY,
10 06bc494ca11e Initial load duke parents: diff changeset	132	holder, field,
06bc494ca11e Initial load duke parents: diff changeset	133	holder.isIncluded() ?
06bc494ca11e Initial load duke parents: diff changeset	134	holder.typeName() : holder.qualifiedTypeName(),
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	135	false));
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	136	Content codeLink = HtmlTree.CODE(link);
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	137	Content strong = HtmlTree.STRONG(holder.isClass()?
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	138	writer.descfrmClassLabel : writer.descfrmInterfaceLabel);
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	139	strong.addContent(writer.getSpace());
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	140	strong.addContent(codeLink);
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	141	fieldDocTree.addContent(HtmlTree.DIV(HtmlStyle.block, strong));
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	142	writer.addInlineComment(field, fieldDocTree);
10 06bc494ca11e Initial load duke parents: diff changeset	143	}
06bc494ca11e Initial load duke parents: diff changeset	144	}
06bc494ca11e Initial load duke parents: diff changeset	145	}
06bc494ca11e Initial load duke parents: diff changeset	146
06bc494ca11e Initial load duke parents: diff changeset	147	/**
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	148	* {@inheritDoc}
10 06bc494ca11e Initial load duke parents: diff changeset	149	*/
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	150	public void addTags(FieldDoc field, Content fieldDocTree) {
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	151	writer.addTagsInfo(field, fieldDocTree);
10 06bc494ca11e Initial load duke parents: diff changeset	152	}
06bc494ca11e Initial load duke parents: diff changeset	153
06bc494ca11e Initial load duke parents: diff changeset	154	/**
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	155	* {@inheritDoc}
10 06bc494ca11e Initial load duke parents: diff changeset	156	*/
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	157	public Content getFieldDetails(Content fieldDetailsTree) {
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	158	return getMemberTree(fieldDetailsTree);
10 06bc494ca11e Initial load duke parents: diff changeset	159	}
06bc494ca11e Initial load duke parents: diff changeset	160
06bc494ca11e Initial load duke parents: diff changeset	161	/**
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	162	* {@inheritDoc}
10 06bc494ca11e Initial load duke parents: diff changeset	163	*/
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	164	public Content getFieldDoc(Content fieldDocTree,
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	165	boolean isLastContent) {
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	166	return getMemberTree(fieldDocTree, isLastContent);
10 06bc494ca11e Initial load duke parents: diff changeset	167	}
06bc494ca11e Initial load duke parents: diff changeset	168
06bc494ca11e Initial load duke parents: diff changeset	169	/**
06bc494ca11e Initial load duke parents: diff changeset	170	* Close the writer.
06bc494ca11e Initial load duke parents: diff changeset	171	*/
06bc494ca11e Initial load duke parents: diff changeset	172	public void close() throws IOException {
06bc494ca11e Initial load duke parents: diff changeset	173	writer.close();
06bc494ca11e Initial load duke parents: diff changeset	174	}
06bc494ca11e Initial load duke parents: diff changeset	175
06bc494ca11e Initial load duke parents: diff changeset	176	public int getMemberKind() {
06bc494ca11e Initial load duke parents: diff changeset	177	return VisibleMemberMap.FIELDS;
06bc494ca11e Initial load duke parents: diff changeset	178	}
06bc494ca11e Initial load duke parents: diff changeset	179
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	180	/**
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	181	* {@inheritDoc}
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	182	*/
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	183	public void addSummaryLabel(Content memberTree) {
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	184	Content label = HtmlTree.HEADING(HtmlConstants.SUMMARY_HEADING,
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	185	writer.getResource("doclet.Field_Summary"));
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	186	memberTree.addContent(label);
2320 5b8c377175f4 6786688: Javadoc HTML WCAG 2.0 accessibility issues in standard doclet - Table must have captions and headers bpatel parents: 2216 diff changeset	187	}
5b8c377175f4 6786688: Javadoc HTML WCAG 2.0 accessibility issues in standard doclet - Table must have captions and headers bpatel parents: 2216 diff changeset	188
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	189	/**
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	190	* {@inheritDoc}
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	191	*/
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	192	public String getTableSummary() {
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	193	return configuration().getText("doclet.Member_Table_Summary",
2320 5b8c377175f4 6786688: Javadoc HTML WCAG 2.0 accessibility issues in standard doclet - Table must have captions and headers bpatel parents: 2216 diff changeset	194	configuration().getText("doclet.Field_Summary"),
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	195	configuration().getText("doclet.fields"));
2320 5b8c377175f4 6786688: Javadoc HTML WCAG 2.0 accessibility issues in standard doclet - Table must have captions and headers bpatel parents: 2216 diff changeset	196	}
5b8c377175f4 6786688: Javadoc HTML WCAG 2.0 accessibility issues in standard doclet - Table must have captions and headers bpatel parents: 2216 diff changeset	197
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	198	/**
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	199	* {@inheritDoc}
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	200	*/
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	201	public String getCaption() {
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	202	return configuration().getText("doclet.Fields");
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	203	}
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	204
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	205	/**
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	206	* {@inheritDoc}
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	207	*/
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	208	public String[] getSummaryTableHeader(ProgramElementDoc member) {
2320 5b8c377175f4 6786688: Javadoc HTML WCAG 2.0 accessibility issues in standard doclet - Table must have captions and headers bpatel parents: 2216 diff changeset	209	String[] header = new String[] {
5b8c377175f4 6786688: Javadoc HTML WCAG 2.0 accessibility issues in standard doclet - Table must have captions and headers bpatel parents: 2216 diff changeset	210	writer.getModifierTypeHeader(),
5b8c377175f4 6786688: Javadoc HTML WCAG 2.0 accessibility issues in standard doclet - Table must have captions and headers bpatel parents: 2216 diff changeset	211	configuration().getText("doclet.0_and_1",
5b8c377175f4 6786688: Javadoc HTML WCAG 2.0 accessibility issues in standard doclet - Table must have captions and headers bpatel parents: 2216 diff changeset	212	configuration().getText("doclet.Field"),
5b8c377175f4 6786688: Javadoc HTML WCAG 2.0 accessibility issues in standard doclet - Table must have captions and headers bpatel parents: 2216 diff changeset	213	configuration().getText("doclet.Description"))
5b8c377175f4 6786688: Javadoc HTML WCAG 2.0 accessibility issues in standard doclet - Table must have captions and headers bpatel parents: 2216 diff changeset	214	};
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	215	return header;
10 06bc494ca11e Initial load duke parents: diff changeset	216	}
06bc494ca11e Initial load duke parents: diff changeset	217
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	218	/**
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	219	* {@inheritDoc}
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	220	*/
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	221	public void addSummaryAnchor(ClassDoc cd, Content memberTree) {
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	222	memberTree.addContent(writer.getMarkerAnchor("field_summary"));
10 06bc494ca11e Initial load duke parents: diff changeset	223	}
06bc494ca11e Initial load duke parents: diff changeset	224
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	225	/**
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	226	* {@inheritDoc}
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	227	*/
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	228	public void addInheritedSummaryAnchor(ClassDoc cd, Content inheritedTree) {
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	229	inheritedTree.addContent(writer.getMarkerAnchor(
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	230	"fields_inherited_from_class_" + configuration().getClassName(cd)));
10 06bc494ca11e Initial load duke parents: diff changeset	231	}
06bc494ca11e Initial load duke parents: diff changeset	232
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	233	/**
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	234	* {@inheritDoc}
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	235	*/
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	236	public void addInheritedSummaryLabel(ClassDoc cd, Content inheritedTree) {
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	237	Content classLink = new RawHtml(writer.getPreQualifiedClassLink(
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	238	LinkInfoImpl.CONTEXT_MEMBER, cd, false));
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	239	Content label = new StringContent(cd.isClass() ?
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	240	configuration().getText("doclet.Fields_Inherited_From_Class") :
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	241	configuration().getText("doclet.Fields_Inherited_From_Interface"));
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	242	Content labelHeading = HtmlTree.HEADING(HtmlConstants.INHERITED_SUMMARY_HEADING,
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	243	label);
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	244	labelHeading.addContent(writer.getSpace());
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	245	labelHeading.addContent(classLink);
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	246	inheritedTree.addContent(labelHeading);
10 06bc494ca11e Initial load duke parents: diff changeset	247	}
06bc494ca11e Initial load duke parents: diff changeset	248
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	249	/**
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	250	* {@inheritDoc}
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	251	*/
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	252	protected void addSummaryLink(int context, ClassDoc cd, ProgramElementDoc member,
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	253	Content tdSummary) {
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	254	Content strong = HtmlTree.STRONG(new RawHtml(
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	255	writer.getDocLink(context, cd , (MemberDoc) member, member.name(), false)));
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	256	Content code = HtmlTree.CODE(strong);
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	257	tdSummary.addContent(code);
10 06bc494ca11e Initial load duke parents: diff changeset	258	}
06bc494ca11e Initial load duke parents: diff changeset	259
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	260	/**
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	261	* {@inheritDoc}
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	262	*/
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	263	protected void addInheritedSummaryLink(ClassDoc cd,
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	264	ProgramElementDoc member, Content linksTree) {
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	265	linksTree.addContent(new RawHtml(
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	266	writer.getDocLink(LinkInfoImpl.CONTEXT_MEMBER, cd, (MemberDoc)member,
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	267	member.name(), false)));
10 06bc494ca11e Initial load duke parents: diff changeset	268	}
06bc494ca11e Initial load duke parents: diff changeset	269
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	270	/**
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	271	* {@inheritDoc}
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	272	*/
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	273	protected void addSummaryType(ProgramElementDoc member, Content tdSummaryType) {
10 06bc494ca11e Initial load duke parents: diff changeset	274	FieldDoc field = (FieldDoc)member;
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	275	addModifierAndType(field, field.type(), tdSummaryType);
10 06bc494ca11e Initial load duke parents: diff changeset	276	}
06bc494ca11e Initial load duke parents: diff changeset	277
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	278	/**
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	279	* {@inheritDoc}
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	280	*/
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	281	protected Content getDeprecatedLink(ProgramElementDoc member) {
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	282	return writer.getDocLink(LinkInfoImpl.CONTEXT_MEMBER,
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	283	(MemberDoc) member, ((FieldDoc)member).qualifiedName());
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	284	}
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	285
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	286	/**
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	287	* {@inheritDoc}
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	288	*/
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	289	protected Content getNavSummaryLink(ClassDoc cd, boolean link) {
10 06bc494ca11e Initial load duke parents: diff changeset	290	if (link) {
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	291	return writer.getHyperLink("", (cd == null)?
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	292	"field_summary":
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	293	"fields_inherited_from_class_" +
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	294	configuration().getClassName(cd),
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	295	writer.getResource("doclet.navField"));
10 06bc494ca11e Initial load duke parents: diff changeset	296	} else {
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	297	return writer.getResource("doclet.navField");
10 06bc494ca11e Initial load duke parents: diff changeset	298	}
06bc494ca11e Initial load duke parents: diff changeset	299	}
06bc494ca11e Initial load duke parents: diff changeset	300
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	301	/**
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	302	* {@inheritDoc}
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	303	*/
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	304	protected void addNavDetailLink(boolean link, Content liNav) {
10 06bc494ca11e Initial load duke parents: diff changeset	305	if (link) {
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	306	liNav.addContent(writer.getHyperLink("", "field_detail",
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	307	writer.getResource("doclet.navField")));
10 06bc494ca11e Initial load duke parents: diff changeset	308	} else {
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	309	liNav.addContent(writer.getResource("doclet.navField"));
10 06bc494ca11e Initial load duke parents: diff changeset	310	}
06bc494ca11e Initial load duke parents: diff changeset	311	}
06bc494ca11e Initial load duke parents: diff changeset	312	}

author	bpatel
	Wed, 01 Dec 2010 11:02:38 -0800
changeset 7614	cfadc977ca75
parent 5520	86e4b9a9da40
child 7681	1f0819a3341f
permissions	-rw-r--r--