author | pmuthuswamy |
Wed, 30 Jan 2019 16:39:26 +0530 | |
changeset 53562 | 0d9dee001667 |
parent 52644 | 43efb4ca6d6c |
child 53863 | d001808c57e8 |
permissions | -rw-r--r-- |
50167
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
1 |
/* |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
2 |
* Copyright (c) 2018, Oracle and/or its affiliates. All rights reserved. |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
3 |
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
4 |
* |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
5 |
* This code is free software; you can redistribute it and/or modify it |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
6 |
* under the terms of the GNU General Public License version 2 only, as |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
7 |
* published by the Free Software Foundation. Oracle designates this |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
8 |
* particular file as subject to the "Classpath" exception as provided |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
9 |
* by Oracle in the LICENSE file that accompanied this code. |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
10 |
* |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
11 |
* This code is distributed in the hope that it will be useful, but WITHOUT |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
12 |
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
13 |
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
14 |
* version 2 for more details (a copy is included in the LICENSE file that |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
15 |
* accompanied this code). |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
16 |
* |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
17 |
* You should have received a copy of the GNU General Public License version |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
18 |
* 2 along with this work; if not, write to the Free Software Foundation, |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
19 |
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
20 |
* |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
21 |
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
22 |
* or visit www.oracle.com if you need additional information or have any |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
23 |
* questions. |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
24 |
*/ |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
25 |
package jdk.javadoc.internal.doclets.formats.html; |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
26 |
|
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
27 |
import javax.lang.model.element.PackageElement; |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
28 |
|
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
29 |
import jdk.javadoc.internal.doclets.formats.html.markup.ContentBuilder; |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
30 |
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlConstants; |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
31 |
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyle; |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
32 |
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTag; |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
33 |
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree; |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
34 |
import jdk.javadoc.internal.doclets.formats.html.markup.Navigation; |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
35 |
import jdk.javadoc.internal.doclets.formats.html.markup.Navigation.PageMode; |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
36 |
import jdk.javadoc.internal.doclets.formats.html.markup.StringContent; |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
37 |
import jdk.javadoc.internal.doclets.formats.html.markup.Table; |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
38 |
import jdk.javadoc.internal.doclets.formats.html.markup.TableHeader; |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
39 |
import jdk.javadoc.internal.doclets.toolkit.Content; |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
40 |
import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException; |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
41 |
import jdk.javadoc.internal.doclets.toolkit.util.DocPath; |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
42 |
import jdk.javadoc.internal.doclets.toolkit.util.DocPaths; |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
43 |
|
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
44 |
/** |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
45 |
* Generate the file with list of all the packages in this run. |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
46 |
*/ |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
47 |
public class AllPackagesIndexWriter extends HtmlDocletWriter { |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
48 |
|
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
49 |
/** |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
50 |
* The HTML tree for main tag. |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
51 |
*/ |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
52 |
protected HtmlTree mainTree = HtmlTree.MAIN(); |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
53 |
|
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
54 |
private final Navigation navBar; |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
55 |
|
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
56 |
/** |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
57 |
* Construct AllPackagesIndexWriter object. |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
58 |
* |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
59 |
* @param configuration The current configuration |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
60 |
* @param filename Path to the file which is getting generated. |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
61 |
*/ |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
62 |
public AllPackagesIndexWriter(HtmlConfiguration configuration, DocPath filename) { |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
63 |
super(configuration, filename); |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
64 |
this.navBar = new Navigation(null, configuration, fixedNavDiv, PageMode.ALLPACKAGES, path); |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
65 |
} |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
66 |
|
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
67 |
/** |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
68 |
* Create AllPackagesIndexWriter object. |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
69 |
* |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
70 |
* @param configuration The current configuration |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
71 |
* @throws DocFileIOException |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
72 |
*/ |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
73 |
public static void generate(HtmlConfiguration configuration) throws DocFileIOException { |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
74 |
generate(configuration, DocPaths.ALLPACKAGES_INDEX); |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
75 |
} |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
76 |
|
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
77 |
private static void generate(HtmlConfiguration configuration, DocPath fileName) throws DocFileIOException { |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
78 |
AllPackagesIndexWriter allPkgGen = new AllPackagesIndexWriter(configuration, fileName); |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
79 |
allPkgGen.buildAllPackagesFile(); |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
80 |
} |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
81 |
|
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
82 |
/** |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
83 |
* Print all the packages in the file. |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
84 |
*/ |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
85 |
protected void buildAllPackagesFile() throws DocFileIOException { |
52644
43efb4ca6d6c
8214139: Remove wrapper methods from {Base,Html}Configuration
jjg
parents:
50167
diff
changeset
|
86 |
String label = resources.getText("doclet.All_Packages"); |
50167
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
87 |
HtmlTree bodyTree = getBody(true, getWindowTitle(label)); |
53562 | 88 |
HtmlTree header = HtmlTree.HEADER(); |
89 |
addTop(header); |
|
50167
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
90 |
navBar.setUserHeader(getUserHeaderFooter(true)); |
53562 | 91 |
header.addContent(navBar.getContent(true)); |
92 |
bodyTree.addContent(header); |
|
50167
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
93 |
HtmlTree div = new HtmlTree(HtmlTag.DIV); |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
94 |
div.setStyle(HtmlStyle.allPackagesContainer); |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
95 |
addPackages(div); |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
96 |
Content titleContent = contents.allPackagesLabel; |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
97 |
Content pHeading = HtmlTree.HEADING(HtmlConstants.TITLE_HEADING, true, |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
98 |
HtmlStyle.title, titleContent); |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
99 |
Content headerDiv = HtmlTree.DIV(HtmlStyle.header, pHeading); |
53562 | 100 |
mainTree.addContent(headerDiv); |
101 |
mainTree.addContent(div); |
|
102 |
bodyTree.addContent(mainTree); |
|
103 |
Content footer = HtmlTree.FOOTER(); |
|
50167
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
104 |
navBar.setUserFooter(getUserHeaderFooter(false)); |
53562 | 105 |
footer.addContent(navBar.getContent(false)); |
106 |
addBottom(footer); |
|
107 |
bodyTree.addContent(footer); |
|
50167
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
108 |
printHtmlDocument(null, true, bodyTree); |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
109 |
} |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
110 |
|
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
111 |
/** |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
112 |
* Add all the packages to the content tree. |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
113 |
* |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
114 |
* @param content HtmlTree content to which the links will be added |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
115 |
*/ |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
116 |
protected void addPackages(Content content) { |
53562 | 117 |
Table table = new Table(HtmlStyle.packagesSummary) |
50167
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
118 |
.setCaption(getTableCaption(new StringContent(resources.packageSummary))) |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
119 |
.setHeader(new TableHeader(contents.packageLabel, contents.descriptionLabel)) |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
120 |
.setColumnStyles(HtmlStyle.colFirst, HtmlStyle.colLast); |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
121 |
for (PackageElement pkg : configuration.packages) { |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
122 |
if (!(configuration.nodeprecated && utils.isDeprecated(pkg))) { |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
123 |
Content packageLinkContent = getPackageLink(pkg, getPackageName(pkg)); |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
124 |
Content summaryContent = new ContentBuilder(); |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
125 |
addSummaryComment(pkg, summaryContent); |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
126 |
table.addRow(pkg, packageLinkContent, summaryContent); |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
127 |
} |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
128 |
} |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
129 |
HtmlTree li = HtmlTree.LI(HtmlStyle.blockList, table.toContent()); |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
130 |
content.addContent(HtmlTree.UL(HtmlStyle.blockList, li)); |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
131 |
} |
cc705c956798
8196201: Generate pages to list all classes and all packages in javadoc output
bpatel
parents:
diff
changeset
|
132 |
} |