• file
• revisions
• annotate
• diff
• comparison
• raw

src/share/classes/com/sun/tools/doclets/formats/html/NestedClassWriterImpl.java@2eb010b6cb22 (annotated)

src/share/classes/com/sun/tools/doclets/formats/html/NestedClassWriterImpl.java

Thu, 31 Aug 2017 15:17:03 +0800

author

aoqi

date

Thu, 31 Aug 2017 15:17:03 +0800

changeset 2525

2eb010b6cb22

parent 2147

130b8c0e570e

parent 0

959103a6100f

permissions

-rw-r--r--

merge

aoqi@0	1	/*
aoqi@0	2	* Copyright (c) 1997, 2013, Oracle and/or its affiliates. All rights reserved.
aoqi@0	3	* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0	4	*
aoqi@0	5	* This code is free software; you can redistribute it and/or modify it
aoqi@0	6	* under the terms of the GNU General Public License version 2 only, as
aoqi@0	7	* published by the Free Software Foundation. Oracle designates this
aoqi@0	8	* particular file as subject to the "Classpath" exception as provided
aoqi@0	9	* by Oracle in the LICENSE file that accompanied this code.
aoqi@0	10	*
aoqi@0	11	* This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0	12	* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0	13	* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
aoqi@0	14	* version 2 for more details (a copy is included in the LICENSE file that
aoqi@0	15	* accompanied this code).
aoqi@0	16	*
aoqi@0	17	* You should have received a copy of the GNU General Public License version
aoqi@0	18	* 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0	19	* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0	20	*
aoqi@0	21	* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0	22	* or visit www.oracle.com if you need additional information or have any
aoqi@0	23	* questions.
aoqi@0	24	*/
aoqi@0	25
aoqi@0	26	package com.sun.tools.doclets.formats.html;
aoqi@0	27
aoqi@0	28	import java.io.*;
aoqi@0	29
aoqi@0	30	import com.sun.javadoc.*;
aoqi@0	31	import com.sun.tools.doclets.formats.html.markup.*;
aoqi@0	32	import com.sun.tools.doclets.internal.toolkit.*;
aoqi@0	33	import com.sun.tools.doclets.internal.toolkit.util.*;
aoqi@0	34
aoqi@0	35	/**
aoqi@0	36	* Writes nested class documentation in HTML format.
aoqi@0	37	*
aoqi@0	38	* <p><b>This is NOT part of any supported API.
aoqi@0	39	* If you write code that depends on this, you do so at your own risk.
aoqi@0	40	* This code and its internal interfaces are subject to change or
aoqi@0	41	* deletion without notice.</b>
aoqi@0	42	*
aoqi@0	43	* @author Robert Field
aoqi@0	44	* @author Atul M Dambalkar
aoqi@0	45	* @author Jamie Ho (rewrite)
aoqi@0	46	* @author Bhavesh Patel (Modified)
aoqi@0	47	*/
aoqi@0	48	public class NestedClassWriterImpl extends AbstractMemberWriter
aoqi@0	49	implements MemberSummaryWriter {
aoqi@0	50
aoqi@0	51	public NestedClassWriterImpl(SubWriterHolderWriter writer,
aoqi@0	52	ClassDoc classdoc) {
aoqi@0	53	super(writer, classdoc);
aoqi@0	54	}
aoqi@0	55
aoqi@0	56	public NestedClassWriterImpl(SubWriterHolderWriter writer) {
aoqi@0	57	super(writer);
aoqi@0	58	}
aoqi@0	59
aoqi@0	60	/**
aoqi@0	61	* {@inheritDoc}
aoqi@0	62	*/
aoqi@0	63	public Content getMemberSummaryHeader(ClassDoc classDoc,
aoqi@0	64	Content memberSummaryTree) {
aoqi@0	65	memberSummaryTree.addContent(HtmlConstants.START_OF_NESTED_CLASS_SUMMARY);
aoqi@0	66	Content memberTree = writer.getMemberTreeHeader();
aoqi@0	67	writer.addSummaryHeader(this, classDoc, memberTree);
aoqi@0	68	return memberTree;
aoqi@0	69	}
aoqi@0	70
aoqi@0	71	/**
aoqi@0	72	* Close the writer.
aoqi@0	73	*/
aoqi@0	74	public void close() throws IOException {
aoqi@0	75	writer.close();
aoqi@0	76	}
aoqi@0	77
aoqi@0	78	public int getMemberKind() {
aoqi@0	79	return VisibleMemberMap.INNERCLASSES;
aoqi@0	80	}
aoqi@0	81
aoqi@0	82	/**
aoqi@0	83	* {@inheritDoc}
aoqi@0	84	*/
aoqi@0	85	public void addSummaryLabel(Content memberTree) {
aoqi@0	86	Content label = HtmlTree.HEADING(HtmlConstants.SUMMARY_HEADING,
aoqi@0	87	writer.getResource("doclet.Nested_Class_Summary"));
aoqi@0	88	memberTree.addContent(label);
aoqi@0	89	}
aoqi@0	90
aoqi@0	91	/**
aoqi@0	92	* {@inheritDoc}
aoqi@0	93	*/
aoqi@0	94	public String getTableSummary() {
aoqi@0	95	return configuration.getText("doclet.Member_Table_Summary",
aoqi@0	96	configuration.getText("doclet.Nested_Class_Summary"),
aoqi@0	97	configuration.getText("doclet.nested_classes"));
aoqi@0	98	}
aoqi@0	99
aoqi@0	100	/**
aoqi@0	101	* {@inheritDoc}
aoqi@0	102	*/
aoqi@0	103	public Content getCaption() {
aoqi@0	104	return configuration.getResource("doclet.Nested_Classes");
aoqi@0	105	}
aoqi@0	106
aoqi@0	107	/**
aoqi@0	108	* {@inheritDoc}
aoqi@0	109	*/
aoqi@0	110	public String[] getSummaryTableHeader(ProgramElementDoc member) {
aoqi@0	111	String[] header;
aoqi@0	112	if (member.isInterface()) {
aoqi@0	113	header = new String[] {
aoqi@0	114	writer.getModifierTypeHeader(),
aoqi@0	115	configuration.getText("doclet.0_and_1",
aoqi@0	116	configuration.getText("doclet.Interface"),
aoqi@0	117	configuration.getText("doclet.Description"))
aoqi@0	118	};
aoqi@0	119	}
aoqi@0	120	else {
aoqi@0	121	header = new String[] {
aoqi@0	122	writer.getModifierTypeHeader(),
aoqi@0	123	configuration.getText("doclet.0_and_1",
aoqi@0	124	configuration.getText("doclet.Class"),
aoqi@0	125	configuration.getText("doclet.Description"))
aoqi@0	126	};
aoqi@0	127	}
aoqi@0	128	return header;
aoqi@0	129	}
aoqi@0	130
aoqi@0	131	/**
aoqi@0	132	* {@inheritDoc}
aoqi@0	133	*/
aoqi@0	134	public void addSummaryAnchor(ClassDoc cd, Content memberTree) {
aoqi@0	135	memberTree.addContent(writer.getMarkerAnchor(
aoqi@0	136	SectionName.NESTED_CLASS_SUMMARY));
aoqi@0	137	}
aoqi@0	138
aoqi@0	139	/**
aoqi@0	140	* {@inheritDoc}
aoqi@0	141	*/
aoqi@0	142	public void addInheritedSummaryAnchor(ClassDoc cd, Content inheritedTree) {
aoqi@0	143	inheritedTree.addContent(writer.getMarkerAnchor(
aoqi@0	144	SectionName.NESTED_CLASSES_INHERITANCE,
aoqi@0	145	cd.qualifiedName()));
aoqi@0	146	}
aoqi@0	147
aoqi@0	148	/**
aoqi@0	149	* {@inheritDoc}
aoqi@0	150	*/
aoqi@0	151	public void addInheritedSummaryLabel(ClassDoc cd, Content inheritedTree) {
aoqi@0	152	Content classLink = writer.getPreQualifiedClassLink(
aoqi@0	153	LinkInfoImpl.Kind.MEMBER, cd, false);
aoqi@0	154	Content label = new StringContent(cd.isInterface() ?
aoqi@0	155	configuration.getText("doclet.Nested_Classes_Interface_Inherited_From_Interface") :
aoqi@0	156	configuration.getText("doclet.Nested_Classes_Interfaces_Inherited_From_Class"));
aoqi@0	157	Content labelHeading = HtmlTree.HEADING(HtmlConstants.INHERITED_SUMMARY_HEADING,
aoqi@0	158	label);
aoqi@0	159	labelHeading.addContent(writer.getSpace());
aoqi@0	160	labelHeading.addContent(classLink);
aoqi@0	161	inheritedTree.addContent(labelHeading);
aoqi@0	162	}
aoqi@0	163
aoqi@0	164	/**
aoqi@0	165	* {@inheritDoc}
aoqi@0	166	*/
aoqi@0	167	protected void addSummaryLink(LinkInfoImpl.Kind context, ClassDoc cd, ProgramElementDoc member,
aoqi@0	168	Content tdSummary) {
aoqi@0	169	Content memberLink = HtmlTree.SPAN(HtmlStyle.memberNameLink,
aoqi@0	170	writer.getLink(new LinkInfoImpl(configuration, context, (ClassDoc)member)));
aoqi@0	171	Content code = HtmlTree.CODE(memberLink);
aoqi@0	172	tdSummary.addContent(code);
aoqi@0	173	}
aoqi@0	174
aoqi@0	175	/**
aoqi@0	176	* {@inheritDoc}
aoqi@0	177	*/
aoqi@0	178	protected void addInheritedSummaryLink(ClassDoc cd,
aoqi@0	179	ProgramElementDoc member, Content linksTree) {
aoqi@0	180	linksTree.addContent(
aoqi@0	181	writer.getLink(new LinkInfoImpl(configuration, LinkInfoImpl.Kind.MEMBER,
aoqi@0	182	(ClassDoc)member)));
aoqi@0	183	}
aoqi@0	184
aoqi@0	185	/**
aoqi@0	186	* {@inheritDoc}
aoqi@0	187	*/
aoqi@0	188	protected void addSummaryType(ProgramElementDoc member,
aoqi@0	189	Content tdSummaryType) {
aoqi@0	190	ClassDoc cd = (ClassDoc)member;
aoqi@0	191	addModifierAndType(cd, null, tdSummaryType);
aoqi@0	192	}
aoqi@0	193
aoqi@0	194	/**
aoqi@0	195	* {@inheritDoc}
aoqi@0	196	*/
aoqi@0	197	protected Content getDeprecatedLink(ProgramElementDoc member) {
aoqi@0	198	return writer.getQualifiedClassLink(LinkInfoImpl.Kind.MEMBER,
aoqi@0	199	(ClassDoc)member);
aoqi@0	200	}
aoqi@0	201
aoqi@0	202	/**
aoqi@0	203	* {@inheritDoc}
aoqi@0	204	*/
aoqi@0	205	protected Content getNavSummaryLink(ClassDoc cd, boolean link) {
aoqi@0	206	if (link) {
aoqi@0	207	if (cd == null) {
aoqi@0	208	return writer.getHyperLink(
aoqi@0	209	SectionName.NESTED_CLASS_SUMMARY,
aoqi@0	210	writer.getResource("doclet.navNested"));
aoqi@0	211	} else {
aoqi@0	212	return writer.getHyperLink(
aoqi@0	213	SectionName.NESTED_CLASSES_INHERITANCE,
aoqi@0	214	cd.qualifiedName(), writer.getResource("doclet.navNested"));
aoqi@0	215	}
aoqi@0	216	} else {
aoqi@0	217	return writer.getResource("doclet.navNested");
aoqi@0	218	}
aoqi@0	219	}
aoqi@0	220
aoqi@0	221	/**
aoqi@0	222	* {@inheritDoc}
aoqi@0	223	*/
aoqi@0	224	protected void addNavDetailLink(boolean link, Content liNav) {
aoqi@0	225	}
aoqi@0	226	}