jdk-sandbox: langtools/src/share/classes/com/sun/tools/doclets/formats/html/AnnotationTypeRequiredMemberWriterImpl.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) 2003, 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
10 06bc494ca11e Initial load duke parents: 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.*;
2216 b124d5c924eb 6786690: Javadoc HTML WCAG 2.0 accessibility issues in standard doclet - DL tag and nesting issue bpatel parents: 1787 diff changeset	32	import com.sun.tools.doclets.internal.toolkit.*;
10 06bc494ca11e Initial load duke parents: diff changeset	33
06bc494ca11e Initial load duke parents: diff changeset	34	/**
06bc494ca11e Initial load duke parents: diff changeset	35	* Writes annotation type required member documentation in HTML format.
06bc494ca11e Initial load duke parents: diff changeset	36	*
06bc494ca11e Initial load duke parents: diff changeset	37	* @author Jamie Ho
2320 5b8c377175f4 6786688: Javadoc HTML WCAG 2.0 accessibility issues in standard doclet - Table must have captions and headers bpatel parents: 2216 diff changeset	38	* @author Bhavesh Patel (Modified)
10 06bc494ca11e Initial load duke parents: diff changeset	39	*/
06bc494ca11e Initial load duke parents: diff changeset	40	public class AnnotationTypeRequiredMemberWriterImpl extends AbstractMemberWriter
06bc494ca11e Initial load duke parents: diff changeset	41	implements AnnotationTypeRequiredMemberWriter, MemberSummaryWriter {
06bc494ca11e Initial load duke parents: diff changeset	42
06bc494ca11e Initial load duke parents: diff changeset	43	/**
06bc494ca11e Initial load duke parents: diff changeset	44	* Construct a new AnnotationTypeRequiredMemberWriterImpl.
06bc494ca11e Initial load duke parents: diff changeset	45	*
06bc494ca11e Initial load duke parents: diff changeset	46	* @param writer the writer that will write the output.
06bc494ca11e Initial load duke parents: diff changeset	47	* @param annotationType the AnnotationType that holds this member.
06bc494ca11e Initial load duke parents: diff changeset	48	*/
06bc494ca11e Initial load duke parents: diff changeset	49	public AnnotationTypeRequiredMemberWriterImpl(SubWriterHolderWriter writer,
06bc494ca11e Initial load duke parents: diff changeset	50	AnnotationTypeDoc annotationType) {
06bc494ca11e Initial load duke parents: diff changeset	51	super(writer, annotationType);
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(
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	60	HtmlConstants.START_OF_ANNOTATION_TYPE_REQUIRED_MEMBER_SUMMARY);
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	61	Content memberTree = writer.getMemberTreeHeader();
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	62	writer.addSummaryHeader(this, classDoc, memberTree);
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	63	return memberTree;
10 06bc494ca11e Initial load duke parents: diff changeset	64	}
06bc494ca11e Initial load duke parents: diff changeset	65
06bc494ca11e Initial load duke parents: diff changeset	66	/**
06bc494ca11e Initial load duke parents: diff changeset	67	* {@inheritDoc}
06bc494ca11e Initial load duke parents: diff changeset	68	*/
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	69	public void addAnnotationDetailsTreeHeader(ClassDoc classDoc,
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	70	Content memberDetailsTree) {
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	71	if (!writer.printedAnnotationHeading) {
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	72	memberDetailsTree.addContent(writer.getMarkerAnchor(
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	73	"annotation_type_element_detail"));
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	74	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	75	writer.annotationTypeDetailsLabel);
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	76	memberDetailsTree.addContent(heading);
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	77	writer.printedAnnotationHeading = true;
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	78	}
10 06bc494ca11e Initial load duke parents: diff changeset	79	}
06bc494ca11e Initial load duke parents: diff changeset	80
06bc494ca11e Initial load duke parents: diff changeset	81	/**
06bc494ca11e Initial load duke parents: diff changeset	82	* {@inheritDoc}
06bc494ca11e Initial load duke parents: diff changeset	83	*/
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	84	public Content getAnnotationDocTreeHeader(MemberDoc member,
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	85	Content annotationDetailsTree) {
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	86	annotationDetailsTree.addContent(
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	87	writer.getMarkerAnchor(member.name() +
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	88	((ExecutableMemberDoc) member).signature()));
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	89	Content annotationDocTree = writer.getMemberTreeHeader();
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	90	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	91	heading.addContent(member.name());
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	92	annotationDocTree.addContent(heading);
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	93	return annotationDocTree;
10 06bc494ca11e Initial load duke parents: diff changeset	94	}
06bc494ca11e Initial load duke parents: diff changeset	95
06bc494ca11e Initial load duke parents: diff changeset	96	/**
06bc494ca11e Initial load duke parents: diff changeset	97	* {@inheritDoc}
06bc494ca11e Initial load duke parents: diff changeset	98	*/
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	99	public Content getSignature(MemberDoc member) {
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	100	Content pre = new HtmlTree(HtmlTag.PRE);
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	101	writer.addAnnotationInfo(member, pre);
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	102	addModifiers(member, pre);
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	103	Content link = new RawHtml(
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	104	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	105	getType(member))));
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	106	pre.addContent(link);
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	107	pre.addContent(writer.getSpace());
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	108	if (configuration().linksource) {
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	109	Content memberName = new StringContent(member.name());
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	110	writer.addSrcLink(member, memberName, pre);
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	111	} else {
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	112	addName(member.name(), pre);
10 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	return pre;
10 06bc494ca11e Initial load duke parents: diff changeset	115	}
06bc494ca11e Initial load duke parents: diff changeset	116
06bc494ca11e Initial load duke parents: diff changeset	117	/**
06bc494ca11e Initial load duke parents: diff changeset	118	* {@inheritDoc}
06bc494ca11e Initial load duke parents: diff changeset	119	*/
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	120	public void addDeprecated(MemberDoc member, Content annotationDocTree) {
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	121	addDeprecatedInfo(member, annotationDocTree);
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	122	}
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	123
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	124	/**
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	125	* {@inheritDoc}
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	126	*/
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	127	public void addComments(MemberDoc member, Content annotationDocTree) {
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	128	addComment(member, annotationDocTree);
10 06bc494ca11e Initial load duke parents: diff changeset	129	}
06bc494ca11e Initial load duke parents: diff changeset	130
06bc494ca11e Initial load duke parents: diff changeset	131	/**
06bc494ca11e Initial load duke parents: diff changeset	132	* {@inheritDoc}
06bc494ca11e Initial load duke parents: diff changeset	133	*/
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	134	public void addTags(MemberDoc member, Content annotationDocTree) {
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	135	writer.addTagsInfo(member, annotationDocTree);
10 06bc494ca11e Initial load duke parents: diff changeset	136	}
06bc494ca11e Initial load duke parents: diff changeset	137
06bc494ca11e Initial load duke parents: diff changeset	138	/**
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	139	* {@inheritDoc}
10 06bc494ca11e Initial load duke parents: diff changeset	140	*/
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	141	public Content getAnnotationDetails(Content annotationDetailsTree) {
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	142	return getMemberTree(annotationDetailsTree);
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	/**
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	146	* {@inheritDoc}
10 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	public Content getAnnotationDoc(Content annotationDocTree,
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	149	boolean isLastContent) {
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	150	return getMemberTree(annotationDocTree, isLastContent);
10 06bc494ca11e Initial load duke parents: diff changeset	151	}
06bc494ca11e Initial load duke parents: diff changeset	152
06bc494ca11e Initial load duke parents: diff changeset	153	/**
06bc494ca11e Initial load duke parents: diff changeset	154	* Close the writer.
06bc494ca11e Initial load duke parents: diff changeset	155	*/
06bc494ca11e Initial load duke parents: diff changeset	156	public void close() throws IOException {
06bc494ca11e Initial load duke parents: diff changeset	157	writer.close();
06bc494ca11e Initial load duke parents: diff changeset	158	}
06bc494ca11e Initial load duke parents: diff changeset	159
06bc494ca11e Initial load duke parents: diff changeset	160	/**
06bc494ca11e Initial load duke parents: diff changeset	161	* {@inheritDoc}
06bc494ca11e Initial load duke parents: diff changeset	162	*/
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	163	public void addSummaryLabel(Content memberTree) {
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	164	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	165	writer.getResource("doclet.Annotation_Type_Required_Member_Summary"));
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	166	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	167	}
5b8c377175f4 6786688: Javadoc HTML WCAG 2.0 accessibility issues in standard doclet - Table must have captions and headers bpatel parents: 2216 diff changeset	168
5b8c377175f4 6786688: Javadoc HTML WCAG 2.0 accessibility issues in standard doclet - Table must have captions and headers bpatel parents: 2216 diff changeset	169	/**
5b8c377175f4 6786688: Javadoc HTML WCAG 2.0 accessibility issues in standard doclet - Table must have captions and headers bpatel parents: 2216 diff changeset	170	* {@inheritDoc}
5b8c377175f4 6786688: Javadoc HTML WCAG 2.0 accessibility issues in standard doclet - Table must have captions and headers bpatel parents: 2216 diff changeset	171	*/
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	172	public String getTableSummary() {
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	173	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	174	configuration().getText("doclet.Annotation_Type_Required_Member_Summary"),
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	175	configuration().getText("doclet.annotation_type_required_members"));
2320 5b8c377175f4 6786688: Javadoc HTML WCAG 2.0 accessibility issues in standard doclet - Table must have captions and headers bpatel parents: 2216 diff changeset	176	}
5b8c377175f4 6786688: Javadoc HTML WCAG 2.0 accessibility issues in standard doclet - Table must have captions and headers bpatel parents: 2216 diff changeset	177
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	178	/**
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	179	* {@inheritDoc}
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	public String getCaption() {
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	182	return configuration().getText("doclet.Annotation_Type_Required_Members");
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	183	}
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	184
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	185	/**
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	186	* {@inheritDoc}
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	187	*/
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	188	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	189	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	190	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	191	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	192	configuration().getText("doclet.Annotation_Type_Required_Member"),
5b8c377175f4 6786688: Javadoc HTML WCAG 2.0 accessibility issues in standard doclet - Table must have captions and headers bpatel parents: 2216 diff changeset	193	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	194	};
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	195	return header;
10 06bc494ca11e Initial load duke parents: diff changeset	196	}
06bc494ca11e Initial load duke parents: diff changeset	197
06bc494ca11e Initial load duke parents: diff changeset	198	/**
06bc494ca11e Initial load duke parents: diff changeset	199	* {@inheritDoc}
06bc494ca11e Initial load duke parents: diff changeset	200	*/
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	201	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	202	memberTree.addContent(writer.getMarkerAnchor(
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	203	"annotation_type_required_element_summary"));
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	/**
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	207	* {@inheritDoc}
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	208	*/
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	209	public void addInheritedSummaryAnchor(ClassDoc cd, Content inheritedTree) {
10 06bc494ca11e Initial load duke parents: diff changeset	210	}
06bc494ca11e Initial load duke parents: diff changeset	211
06bc494ca11e Initial load duke parents: diff changeset	212	/**
06bc494ca11e Initial load duke parents: diff changeset	213	* {@inheritDoc}
06bc494ca11e Initial load duke parents: diff changeset	214	*/
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	215	public void addInheritedSummaryLabel(ClassDoc cd, Content inheritedTree) {
10 06bc494ca11e Initial load duke parents: diff changeset	216	}
06bc494ca11e Initial load duke parents: diff changeset	217
06bc494ca11e Initial load duke parents: diff changeset	218	/**
06bc494ca11e Initial load duke parents: diff changeset	219	* {@inheritDoc}
06bc494ca11e Initial load duke parents: diff changeset	220	*/
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	221	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	222	Content tdSummary) {
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	223	Content strong = HtmlTree.STRONG(new RawHtml(
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	224	writer.getDocLink(context, (MemberDoc) member, member.name(), false)));
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	225	Content code = HtmlTree.CODE(strong);
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	226	tdSummary.addContent(code);
10 06bc494ca11e Initial load duke parents: diff changeset	227	}
06bc494ca11e Initial load duke parents: diff changeset	228
06bc494ca11e Initial load duke parents: diff changeset	229	/**
06bc494ca11e Initial load duke parents: diff changeset	230	* {@inheritDoc}
06bc494ca11e Initial load duke parents: diff changeset	231	*/
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	232	protected void addInheritedSummaryLink(ClassDoc cd,
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	233	ProgramElementDoc member, Content linksTree) {
10 06bc494ca11e Initial load duke parents: diff changeset	234	//Not applicable.
06bc494ca11e Initial load duke parents: diff changeset	235	}
06bc494ca11e Initial load duke parents: diff changeset	236
06bc494ca11e Initial load duke parents: diff changeset	237	/**
06bc494ca11e Initial load duke parents: diff changeset	238	* {@inheritDoc}
06bc494ca11e Initial load duke parents: diff changeset	239	*/
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	240	protected void addSummaryType(ProgramElementDoc member, Content tdSummaryType) {
10 06bc494ca11e Initial load duke parents: diff changeset	241	MemberDoc m = (MemberDoc)member;
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	242	addModifierAndType(m, getType(m), tdSummaryType);
10 06bc494ca11e Initial load duke parents: diff changeset	243	}
06bc494ca11e Initial load duke parents: diff changeset	244
06bc494ca11e Initial load duke parents: diff changeset	245	/**
06bc494ca11e Initial load duke parents: diff changeset	246	* {@inheritDoc}
06bc494ca11e Initial load duke parents: diff changeset	247	*/
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	248	protected Content getDeprecatedLink(ProgramElementDoc member) {
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	249	return writer.getDocLink(LinkInfoImpl.CONTEXT_MEMBER,
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	250	(MemberDoc) member, ((MemberDoc)member).qualifiedName());
10 06bc494ca11e Initial load duke parents: diff changeset	251	}
06bc494ca11e Initial load duke parents: diff changeset	252
06bc494ca11e Initial load duke parents: diff changeset	253	/**
06bc494ca11e Initial load duke parents: diff changeset	254	* {@inheritDoc}
06bc494ca11e Initial load duke parents: diff changeset	255	*/
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	256	protected Content getNavSummaryLink(ClassDoc cd, boolean link) {
10 06bc494ca11e Initial load duke parents: diff changeset	257	if (link) {
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	258	return writer.getHyperLink("", "annotation_type_required_element_summary",
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	259	writer.getResource("doclet.navAnnotationTypeRequiredMember"));
10 06bc494ca11e Initial load duke parents: diff changeset	260	} else {
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	261	return writer.getResource("doclet.navAnnotationTypeRequiredMember");
10 06bc494ca11e Initial load duke parents: diff changeset	262	}
06bc494ca11e Initial load duke parents: diff changeset	263	}
06bc494ca11e Initial load duke parents: diff changeset	264
06bc494ca11e Initial load duke parents: diff changeset	265	/**
06bc494ca11e Initial load duke parents: diff changeset	266	* {@inheritDoc}
06bc494ca11e Initial load duke parents: diff changeset	267	*/
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	268	protected void addNavDetailLink(boolean link, Content liNav) {
10 06bc494ca11e Initial load duke parents: diff changeset	269	if (link) {
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	270	liNav.addContent(writer.getHyperLink("", "annotation_type_element_detail",
cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	271	writer.getResource("doclet.navAnnotationTypeMember")));
10 06bc494ca11e Initial load duke parents: diff changeset	272	} else {
7614 cfadc977ca75 6851834: Javadoc doclet needs a structured approach to generate the output HTML. bpatel parents: 5520 diff changeset	273	liNav.addContent(writer.getResource("doclet.navAnnotationTypeMember"));
10 06bc494ca11e Initial load duke parents: diff changeset	274	}
06bc494ca11e Initial load duke parents: diff changeset	275	}
06bc494ca11e Initial load duke parents: diff changeset	276
06bc494ca11e Initial load duke parents: diff changeset	277	private Type getType(MemberDoc member) {
06bc494ca11e Initial load duke parents: diff changeset	278	if (member instanceof FieldDoc) {
06bc494ca11e Initial load duke parents: diff changeset	279	return ((FieldDoc) member).type();
06bc494ca11e Initial load duke parents: diff changeset	280	} else {
06bc494ca11e Initial load duke parents: diff changeset	281	return ((MethodDoc) member).returnType();
06bc494ca11e Initial load duke parents: diff changeset	282	}
06bc494ca11e Initial load duke parents: diff changeset	283	}
06bc494ca11e Initial load duke parents: diff changeset	284	}

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