author | jjg |
Mon, 11 Mar 2019 12:59:45 -0700 | |
changeset 54060 | 53a95878619f |
parent 53991 | 786825220790 |
permissions | -rw-r--r-- |
36526 | 1 |
/* |
53863
d001808c57e8
8218998: Add metadata to generated API documentation files
jjg
parents:
53562
diff
changeset
|
2 |
* Copyright (c) 2013, 2019, Oracle and/or its affiliates. All rights reserved. |
36526 | 3 |
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
4 |
* |
|
5 |
* This code is free software; you can redistribute it and/or modify it |
|
6 |
* under the terms of the GNU General Public License version 2 only, as |
|
7 |
* published by the Free Software Foundation. Oracle designates this |
|
8 |
* particular file as subject to the "Classpath" exception as provided |
|
9 |
* by Oracle in the LICENSE file that accompanied this code. |
|
10 |
* |
|
11 |
* This code is distributed in the hope that it will be useful, but WITHOUT |
|
12 |
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
|
13 |
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
|
14 |
* version 2 for more details (a copy is included in the LICENSE file that |
|
15 |
* accompanied this code). |
|
16 |
* |
|
17 |
* You should have received a copy of the GNU General Public License version |
|
18 |
* 2 along with this work; if not, write to the Free Software Foundation, |
|
19 |
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
|
20 |
* |
|
21 |
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
|
22 |
* or visit www.oracle.com if you need additional information or have any |
|
23 |
* questions. |
|
24 |
*/ |
|
25 |
||
26 |
package jdk.javadoc.internal.doclets.formats.html; |
|
27 |
||
28 |
import java.util.ArrayList; |
|
29 |
import java.util.List; |
|
30 |
import java.util.Map; |
|
31 |
import java.util.Set; |
|
32 |
||
33 |
import javax.lang.model.element.ModuleElement; |
|
34 |
import javax.lang.model.element.PackageElement; |
|
35 |
||
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.RawHtml; |
|
40 |
import jdk.javadoc.internal.doclets.formats.html.markup.StringContent; |
|
41 |
import jdk.javadoc.internal.doclets.toolkit.Content; |
|
40587 | 42 |
import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException; |
36526 | 43 |
import jdk.javadoc.internal.doclets.toolkit.util.DocPath; |
44 |
import jdk.javadoc.internal.doclets.toolkit.util.DocPaths; |
|
45 |
||
46 |
/** |
|
47 |
* Generate the module package index for the left-hand frame in the generated output. |
|
48 |
* A click on the package name in this frame will update the page in the bottom |
|
49 |
* left hand frame with the listing of contents of the clicked module package. |
|
50 |
* |
|
51 |
* <p><b>This is NOT part of any supported API. |
|
52 |
* If you write code that depends on this, you do so at your own risk. |
|
53 |
* This code and its internal interfaces are subject to change or |
|
54 |
* deletion without notice.</b> |
|
55 |
* |
|
56 |
* @author Bhavesh Patel |
|
57 |
*/ |
|
58 |
public class ModulePackageIndexFrameWriter extends AbstractModuleIndexWriter { |
|
53991 | 59 |
/** |
60 |
* The heading (h1 or h2) to use for the module packages list, |
|
61 |
* set by addNavigationBarHeader depending on whether or not there |
|
62 |
* is an additional initial heading. |
|
63 |
*/ |
|
64 |
private HtmlTag modulePackagesListHeading; |
|
36526 | 65 |
|
66 |
/** |
|
67 |
* Construct the ModulePackageIndexFrameWriter object. |
|
68 |
* |
|
69 |
* @param configuration the configuration object |
|
70 |
* @param filename Name of the package index file to be generated. |
|
71 |
*/ |
|
45417 | 72 |
public ModulePackageIndexFrameWriter(HtmlConfiguration configuration, DocPath filename) { |
36526 | 73 |
super(configuration, filename); |
74 |
} |
|
75 |
||
76 |
/** |
|
77 |
* Generate the module package index file. |
|
40587 | 78 |
* @throws DocFileIOException |
36526 | 79 |
* @param configuration the configuration object |
80 |
* @param mdle the module being documented |
|
81 |
*/ |
|
45417 | 82 |
public static void generate(HtmlConfiguration configuration, ModuleElement mdle) throws DocFileIOException { |
48759
ffa68af7da87
8195795: Organize output files by module/package, not just package
jjg
parents:
48654
diff
changeset
|
83 |
DocPath filename = configuration.docPaths.moduleFrame(mdle); |
40587 | 84 |
ModulePackageIndexFrameWriter modpackgen = new ModulePackageIndexFrameWriter(configuration, filename); |
53863
d001808c57e8
8218998: Add metadata to generated API documentation files
jjg
parents:
53562
diff
changeset
|
85 |
modpackgen.buildModulePackagesIndexFile("doclet.Window_Overview", |
d001808c57e8
8218998: Add metadata to generated API documentation files
jjg
parents:
53562
diff
changeset
|
86 |
getDescription("module package index", mdle) + " (frame)", |
d001808c57e8
8218998: Add metadata to generated API documentation files
jjg
parents:
53562
diff
changeset
|
87 |
false, |
d001808c57e8
8218998: Add metadata to generated API documentation files
jjg
parents:
53562
diff
changeset
|
88 |
mdle); |
36526 | 89 |
} |
90 |
||
91 |
/** |
|
92 |
* {@inheritDoc} |
|
93 |
*/ |
|
94 |
protected void addModulePackagesList(Map<ModuleElement, Set<PackageElement>> modules, String text, |
|
51797
3efead10e303
8210047: some pages contain content outside of landmark region
pmuthuswamy
parents:
49569
diff
changeset
|
95 |
String tableSummary, Content main, ModuleElement mdle) { |
36526 | 96 |
Content profNameContent = new StringContent(mdle.getQualifiedName().toString()); |
53991 | 97 |
Content heading = HtmlTree.HEADING(modulePackagesListHeading, true, |
36526 | 98 |
getTargetModuleLink("classFrame", profNameContent, mdle)); |
54060
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
53991
diff
changeset
|
99 |
heading.add(Contents.SPACE); |
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
53991
diff
changeset
|
100 |
heading.add(contents.packagesLabel); |
51797
3efead10e303
8210047: some pages contain content outside of landmark region
pmuthuswamy
parents:
49569
diff
changeset
|
101 |
HtmlTree htmlTree = HtmlTree.DIV(HtmlStyle.indexContainer, heading); |
36526 | 102 |
HtmlTree ul = new HtmlTree(HtmlTag.UL); |
40303 | 103 |
ul.setTitle(contents.packagesLabel); |
36526 | 104 |
List<PackageElement> packages = new ArrayList<>(modules.get(mdle)); |
105 |
for (PackageElement pkg : packages) { |
|
106 |
if ((!(configuration.nodeprecated && utils.isDeprecated(pkg)))) { |
|
54060
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
53991
diff
changeset
|
107 |
ul.add(getPackage(pkg, mdle)); |
36526 | 108 |
} |
109 |
} |
|
54060
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
53991
diff
changeset
|
110 |
htmlTree.add(ul); |
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
53991
diff
changeset
|
111 |
main.add(htmlTree); |
36526 | 112 |
} |
113 |
||
114 |
/** |
|
115 |
* {@inheritDoc} |
|
116 |
*/ |
|
117 |
protected void addModulePackagesList(Set<ModuleElement> modules, String text, |
|
118 |
String tableSummary, Content body, ModuleElement mdle) { |
|
119 |
Content moduleNameContent = new StringContent(mdle.getQualifiedName().toString()); |
|
53991 | 120 |
Content heading = HtmlTree.HEADING(modulePackagesListHeading, true, |
36526 | 121 |
getTargetModuleLink("classFrame", moduleNameContent, mdle)); |
54060
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
53991
diff
changeset
|
122 |
heading.add(Contents.SPACE); |
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
53991
diff
changeset
|
123 |
heading.add(contents.packagesLabel); |
53562 | 124 |
HtmlTree htmlTree = HtmlTree.MAIN(HtmlStyle.indexContainer, heading); |
36526 | 125 |
HtmlTree ul = new HtmlTree(HtmlTag.UL); |
40303 | 126 |
ul.setTitle(contents.packagesLabel); |
36526 | 127 |
Set<PackageElement> modulePackages = configuration.modulePackages.get(mdle); |
128 |
for (PackageElement pkg: modulePackages) { |
|
129 |
if ((!(configuration.nodeprecated && utils.isDeprecated(pkg)))) { |
|
54060
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
53991
diff
changeset
|
130 |
ul.add(getPackage(pkg, mdle)); |
36526 | 131 |
} |
132 |
} |
|
54060
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
53991
diff
changeset
|
133 |
htmlTree.add(ul); |
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
53991
diff
changeset
|
134 |
body.add(htmlTree); |
36526 | 135 |
} |
136 |
||
137 |
/** |
|
138 |
* Returns each package name as a separate link. |
|
139 |
* |
|
140 |
* @param pkg PackageElement |
|
141 |
* @param mdle the module being documented |
|
142 |
* @return content for the package link |
|
143 |
*/ |
|
144 |
protected Content getPackage(PackageElement pkg, ModuleElement mdle) { |
|
145 |
Content packageLinkContent; |
|
146 |
Content pkgLabel; |
|
147 |
if (!pkg.isUnnamed()) { |
|
148 |
pkgLabel = getPackageLabel(utils.getPackageName(pkg)); |
|
48654
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
47850
diff
changeset
|
149 |
packageLinkContent = links.createLink(pathString(pkg, |
36526 | 150 |
DocPaths.PACKAGE_FRAME), pkgLabel, "", |
151 |
"packageFrame"); |
|
152 |
} else { |
|
153 |
pkgLabel = new StringContent("<unnamed package>"); |
|
48654
36f58bd6269f
8195796: Reduce the size of relative URLs in generated docs
jjg
parents:
47850
diff
changeset
|
154 |
packageLinkContent = links.createLink(DocPaths.PACKAGE_FRAME, |
36526 | 155 |
pkgLabel, "", "packageFrame"); |
156 |
} |
|
157 |
Content li = HtmlTree.LI(packageLinkContent); |
|
158 |
return li; |
|
159 |
} |
|
160 |
||
161 |
/** |
|
162 |
* {@inheritDoc} |
|
163 |
*/ |
|
51797
3efead10e303
8210047: some pages contain content outside of landmark region
pmuthuswamy
parents:
49569
diff
changeset
|
164 |
protected void addNavigationBarHeader(Content header) { |
53991 | 165 |
String headerContent = !configuration.packagesheader.isEmpty() ? configuration.packagesheader |
166 |
: configuration.header; |
|
167 |
if (!headerContent.isEmpty()) { |
|
168 |
Content heading = HtmlTree.HEADING(Headings.PAGE_TITLE_HEADING, true, |
|
169 |
HtmlStyle.bar, new RawHtml(replaceDocRootDir(headerContent))); |
|
54060
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
53991
diff
changeset
|
170 |
header.add(heading); |
53991 | 171 |
modulePackagesListHeading = Headings.IndexFrames.PACKAGE_HEADING; |
36526 | 172 |
} else { |
53991 | 173 |
modulePackagesListHeading = Headings.PAGE_TITLE_HEADING; |
36526 | 174 |
} |
175 |
} |
|
176 |
||
177 |
/** |
|
178 |
* Do nothing as there is no overview information in this page. |
|
179 |
*/ |
|
180 |
protected void addOverviewHeader(Content body) { |
|
181 |
} |
|
182 |
||
47447
9887d1bc3e9c
8183037: Overview summary page should have a table with tabs for groups
bpatel
parents:
47216
diff
changeset
|
183 |
/** |
9887d1bc3e9c
8183037: Overview summary page should have a table with tabs for groups
bpatel
parents:
47216
diff
changeset
|
184 |
* Do nothing as there is no modules list on this page. |
9887d1bc3e9c
8183037: Overview summary page should have a table with tabs for groups
bpatel
parents:
47216
diff
changeset
|
185 |
*/ |
53991 | 186 |
@Override |
47447
9887d1bc3e9c
8183037: Overview summary page should have a table with tabs for groups
bpatel
parents:
47216
diff
changeset
|
187 |
protected void addModulesList(Content body) { |
36526 | 188 |
} |
189 |
||
190 |
/** |
|
191 |
* Adds "All Classes" link for the top of the left-hand frame page to the |
|
192 |
* documentation tree. |
|
193 |
* |
|
194 |
* @param ul the Content object to which the all classes link should be added |
|
195 |
*/ |
|
196 |
protected void addAllClassesLink(Content ul) { |
|
49569
d4d2f634b72f
8201396: fix broken links generated by javadoc doclet
jjg
parents:
48759
diff
changeset
|
197 |
DocPath allClassesFrame = configuration.useModuleDirectories |
d4d2f634b72f
8201396: fix broken links generated by javadoc doclet
jjg
parents:
48759
diff
changeset
|
198 |
? DocPaths.DOT_DOT.resolve(DocPaths.ALLCLASSES_FRAME) |
d4d2f634b72f
8201396: fix broken links generated by javadoc doclet
jjg
parents:
48759
diff
changeset
|
199 |
: DocPaths.ALLCLASSES_FRAME; |
d4d2f634b72f
8201396: fix broken links generated by javadoc doclet
jjg
parents:
48759
diff
changeset
|
200 |
Content linkContent = links.createLink(allClassesFrame, |
40303 | 201 |
contents.allClassesLabel, "", "packageFrame"); |
36526 | 202 |
Content li = HtmlTree.LI(linkContent); |
54060
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
53991
diff
changeset
|
203 |
ul.add(li); |
36526 | 204 |
} |
205 |
||
206 |
/** |
|
207 |
* Adds "All Packages" link for the top of the left-hand frame page to the |
|
208 |
* documentation tree. |
|
209 |
* |
|
210 |
* @param ul the Content object to which the all packages link should be added |
|
211 |
*/ |
|
212 |
protected void addAllPackagesLink(Content ul) { |
|
49569
d4d2f634b72f
8201396: fix broken links generated by javadoc doclet
jjg
parents:
48759
diff
changeset
|
213 |
DocPath overviewFrame = configuration.useModuleDirectories |
d4d2f634b72f
8201396: fix broken links generated by javadoc doclet
jjg
parents:
48759
diff
changeset
|
214 |
? DocPaths.DOT_DOT.resolve(DocPaths.OVERVIEW_FRAME) |
d4d2f634b72f
8201396: fix broken links generated by javadoc doclet
jjg
parents:
48759
diff
changeset
|
215 |
: DocPaths.OVERVIEW_FRAME; |
d4d2f634b72f
8201396: fix broken links generated by javadoc doclet
jjg
parents:
48759
diff
changeset
|
216 |
Content linkContent = links.createLink(overviewFrame, |
40303 | 217 |
contents.allPackagesLabel, "", "packageListFrame"); |
36526 | 218 |
Content li = HtmlTree.LI(linkContent); |
54060
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
53991
diff
changeset
|
219 |
ul.add(li); |
36526 | 220 |
} |
221 |
||
222 |
/** |
|
223 |
* Adds "All Modules" link for the top of the left-hand frame page to the |
|
224 |
* documentation tree. |
|
225 |
* |
|
226 |
* @param ul the Content object to which the all modules link should be added |
|
227 |
*/ |
|
228 |
protected void addAllModulesLink(Content ul) { |
|
49569
d4d2f634b72f
8201396: fix broken links generated by javadoc doclet
jjg
parents:
48759
diff
changeset
|
229 |
DocPath moduleOverviewFrame = configuration.useModuleDirectories |
d4d2f634b72f
8201396: fix broken links generated by javadoc doclet
jjg
parents:
48759
diff
changeset
|
230 |
? DocPaths.DOT_DOT.resolve(DocPaths.MODULE_OVERVIEW_FRAME) |
d4d2f634b72f
8201396: fix broken links generated by javadoc doclet
jjg
parents:
48759
diff
changeset
|
231 |
: DocPaths.MODULE_OVERVIEW_FRAME; |
d4d2f634b72f
8201396: fix broken links generated by javadoc doclet
jjg
parents:
48759
diff
changeset
|
232 |
Content linkContent = links.createLink(moduleOverviewFrame, |
40303 | 233 |
contents.allModulesLabel, "", "packageListFrame"); |
36526 | 234 |
Content li = HtmlTree.LI(linkContent); |
54060
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
53991
diff
changeset
|
235 |
ul.add(li); |
36526 | 236 |
} |
237 |
||
238 |
/** |
|
239 |
* {@inheritDoc} |
|
240 |
*/ |
|
51797
3efead10e303
8210047: some pages contain content outside of landmark region
pmuthuswamy
parents:
49569
diff
changeset
|
241 |
protected void addNavigationBarFooter(Content footer) { |
40303 | 242 |
Content p = HtmlTree.P(Contents.SPACE); |
54060
53a95878619f
8220202: Simplify/standardize method naming for HtmlTree
jjg
parents:
53991
diff
changeset
|
243 |
footer.add(p); |
36526 | 244 |
} |
245 |
} |