author | jjg |
Tue, 04 Apr 2017 14:02:03 -0700 | |
changeset 44564 | 4e1df2513486 |
parent 44293 | 2f47b2c16612 |
child 44684 | 6ce4d52084e8 |
permissions | -rw-r--r-- |
36526 | 1 |
/* |
44293
2f47b2c16612
8176778: javadoc does not produce summary pages for aggregated modules
ksrini
parents:
42831
diff
changeset
|
2 |
* Copyright (c) 2016, 2017, 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 |
||
44293
2f47b2c16612
8176778: javadoc does not produce summary pages for aggregated modules
ksrini
parents:
42831
diff
changeset
|
28 |
import java.util.Collections; |
42831
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
29 |
import java.util.EnumSet; |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
30 |
import java.util.LinkedHashMap; |
36526 | 31 |
import java.util.List; |
39670
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
32 |
import java.util.Map; |
42831
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
33 |
import java.util.Set; |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
34 |
import java.util.SortedSet; |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
35 |
import java.util.TreeMap; |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
36 |
import java.util.TreeSet; |
36526 | 37 |
|
42831
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
38 |
import javax.lang.model.element.Element; |
36526 | 39 |
import javax.lang.model.element.ModuleElement; |
40 |
import javax.lang.model.element.PackageElement; |
|
39670
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
41 |
import javax.lang.model.element.TypeElement; |
42831
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
42 |
import javax.lang.model.util.ElementFilter; |
36526 | 43 |
|
44 |
import com.sun.source.doctree.DocTree; |
|
42831
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
45 |
import jdk.javadoc.doclet.DocletEnvironment.ModuleMode; |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
46 |
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlAttr; |
36526 | 47 |
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlConstants; |
48 |
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyle; |
|
49 |
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTag; |
|
50 |
import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree; |
|
51 |
import jdk.javadoc.internal.doclets.formats.html.markup.RawHtml; |
|
39670
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
52 |
import jdk.javadoc.internal.doclets.formats.html.markup.StringContent; |
36526 | 53 |
import jdk.javadoc.internal.doclets.toolkit.Content; |
54 |
import jdk.javadoc.internal.doclets.toolkit.ModuleSummaryWriter; |
|
55 |
import jdk.javadoc.internal.doclets.toolkit.util.CommentHelper; |
|
40587 | 56 |
import jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException; |
36526 | 57 |
import jdk.javadoc.internal.doclets.toolkit.util.DocPaths; |
42831
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
58 |
import jdk.javadoc.internal.doclets.toolkit.util.ModulePackageTypes; |
36526 | 59 |
|
60 |
/** |
|
42831
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
61 |
* Class to generate file for each module contents in the right-hand frame. This will list all the |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
62 |
* required modules, packages and service types for the module. A click on any of the links will update |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
63 |
* the frame with the clicked element page. |
36526 | 64 |
* |
65 |
* <p><b>This is NOT part of any supported API. |
|
66 |
* If you write code that depends on this, you do so at your own risk. |
|
67 |
* This code and its internal interfaces are subject to change or |
|
68 |
* deletion without notice.</b> |
|
69 |
* |
|
70 |
* @author Bhavesh Patel |
|
71 |
*/ |
|
72 |
public class ModuleWriterImpl extends HtmlDocletWriter implements ModuleSummaryWriter { |
|
73 |
||
74 |
/** |
|
75 |
* The prev module name in the alpha-order list. |
|
76 |
*/ |
|
77 |
protected ModuleElement prevModule; |
|
78 |
||
79 |
/** |
|
80 |
* The next module name in the alpha-order list. |
|
81 |
*/ |
|
82 |
protected ModuleElement nextModule; |
|
83 |
||
84 |
/** |
|
85 |
* The module being documented. |
|
86 |
*/ |
|
87 |
protected ModuleElement mdle; |
|
88 |
||
42831
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
89 |
/** |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
90 |
* The module mode for this javadoc run. It can be set to "api" or "all". |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
91 |
*/ |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
92 |
private final ModuleMode moduleMode; |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
93 |
|
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
94 |
/** |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
95 |
* Map of module elements and modifiers required by this module. |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
96 |
*/ |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
97 |
private final Map<ModuleElement, Content> requires |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
98 |
= new TreeMap<>(utils.makeModuleComparator()); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
99 |
|
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
100 |
/** |
44564 | 101 |
* Map of indirect modules and modifiers, transitive closure, required by this module. |
42831
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
102 |
*/ |
44564 | 103 |
private final Map<ModuleElement, Content> indirectModules |
42831
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
104 |
= new TreeMap<>(utils.makeModuleComparator()); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
105 |
|
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
106 |
/** |
44564 | 107 |
* Map of packages exported by this module and the modules it has been exported to. |
42831
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
108 |
*/ |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
109 |
private final Map<PackageElement, SortedSet<ModuleElement>> exportedPackages |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
110 |
= new TreeMap<>(utils.makePackageComparator()); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
111 |
|
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
112 |
/** |
44564 | 113 |
* Map of opened packages by this module and the modules it has been opened to. |
42831
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
114 |
*/ |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
115 |
private final Map<PackageElement, SortedSet<ModuleElement>> openedPackages |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
116 |
= new TreeMap<>(utils.makePackageComparator()); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
117 |
|
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
118 |
/** |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
119 |
* Set of concealed packages of this module. |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
120 |
*/ |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
121 |
private final SortedSet<PackageElement> concealedPackages = new TreeSet<>(utils.makePackageComparator()); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
122 |
|
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
123 |
/** |
44564 | 124 |
* Map of indirect modules (transitive closure) and their exported packages. |
42831
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
125 |
*/ |
44564 | 126 |
private final Map<ModuleElement, SortedSet<PackageElement>> indirectPackages |
42831
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
127 |
= new TreeMap<>(utils.makeModuleComparator()); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
128 |
|
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
129 |
/** |
44564 | 130 |
* Map of indirect modules (transitive closure) and their open packages. |
42831
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
131 |
*/ |
44564 | 132 |
private final Map<ModuleElement, SortedSet<PackageElement>> indirectOpenPackages |
42831
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
133 |
= new TreeMap<>(utils.makeModuleComparator()); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
134 |
|
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
135 |
/** |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
136 |
* Set of services used by the module. |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
137 |
*/ |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
138 |
private final SortedSet<TypeElement> uses |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
139 |
= new TreeSet<>(utils.makeAllClassesComparator()); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
140 |
|
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
141 |
/** |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
142 |
* Map of services used by the module and specified using @uses javadoc tag, and description. |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
143 |
*/ |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
144 |
private final Map<TypeElement, Content> usesTrees |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
145 |
= new TreeMap<>(utils.makeAllClassesComparator()); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
146 |
|
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
147 |
/** |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
148 |
* Map of services provided by this module, and set of its implementations. |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
149 |
*/ |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
150 |
private final Map<TypeElement, SortedSet<TypeElement>> provides |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
151 |
= new TreeMap<>(utils.makeAllClassesComparator()); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
152 |
|
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
153 |
/** |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
154 |
* Map of services provided by the module and specified using @provides javadoc tag, and |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
155 |
* description. |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
156 |
*/ |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
157 |
private final Map<TypeElement, Content> providesTrees |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
158 |
= new TreeMap<>(utils.makeAllClassesComparator()); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
159 |
|
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
160 |
private int packageTypesOr = 0; |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
161 |
|
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
162 |
protected Set<ModulePackageTypes> modulePackageTypes = EnumSet.noneOf(ModulePackageTypes.class); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
163 |
|
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
164 |
protected Map<String, Integer> typeMap = new LinkedHashMap<>(); |
39670
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
165 |
|
36526 | 166 |
/** |
167 |
* The HTML tree for main tag. |
|
168 |
*/ |
|
169 |
protected HtmlTree mainTree = HtmlTree.MAIN(); |
|
170 |
||
171 |
/** |
|
39670
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
172 |
* The HTML tree for section tag. |
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
173 |
*/ |
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
174 |
protected HtmlTree sectionTree = HtmlTree.SECTION(); |
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
175 |
|
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
176 |
/** |
42831
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
177 |
* Constructor to construct ModuleWriter object and to generate "moduleName-summary.html" file. |
36526 | 178 |
* |
179 |
* @param configuration the configuration of the doclet. |
|
39670
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
180 |
* @param mdle Module under consideration. |
36526 | 181 |
* @param prevModule Previous module in the sorted array. |
182 |
* @param nextModule Next module in the sorted array. |
|
183 |
*/ |
|
184 |
public ModuleWriterImpl(ConfigurationImpl configuration, |
|
40303 | 185 |
ModuleElement mdle, ModuleElement prevModule, ModuleElement nextModule) { |
36526 | 186 |
super(configuration, DocPaths.moduleSummary(mdle)); |
187 |
this.prevModule = prevModule; |
|
188 |
this.nextModule = nextModule; |
|
189 |
this.mdle = mdle; |
|
42831
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
190 |
this.moduleMode = configuration.docEnv.getModuleMode(); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
191 |
computeModulesData(); |
36526 | 192 |
} |
193 |
||
194 |
/** |
|
39670
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
195 |
* Get the module header. |
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
196 |
* |
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
197 |
* @param heading the heading for the section |
36526 | 198 |
*/ |
42407
f3702cff2933
8169069: Module system implementation refresh (11/2016)
alanb
parents:
41452
diff
changeset
|
199 |
@Override |
36526 | 200 |
public Content getModuleHeader(String heading) { |
201 |
HtmlTree bodyTree = getBody(true, getWindowTitle(mdle.getQualifiedName().toString())); |
|
202 |
HtmlTree htmlTree = (configuration.allowTag(HtmlTag.HEADER)) |
|
203 |
? HtmlTree.HEADER() |
|
204 |
: bodyTree; |
|
205 |
addTop(htmlTree); |
|
206 |
addNavLinks(true, htmlTree); |
|
207 |
if (configuration.allowTag(HtmlTag.HEADER)) { |
|
208 |
bodyTree.addContent(htmlTree); |
|
209 |
} |
|
210 |
HtmlTree div = new HtmlTree(HtmlTag.DIV); |
|
211 |
div.addStyle(HtmlStyle.header); |
|
42407
f3702cff2933
8169069: Module system implementation refresh (11/2016)
alanb
parents:
41452
diff
changeset
|
212 |
Content annotationContent = new HtmlTree(HtmlTag.P); |
f3702cff2933
8169069: Module system implementation refresh (11/2016)
alanb
parents:
41452
diff
changeset
|
213 |
addAnnotationInfo(mdle, annotationContent); |
f3702cff2933
8169069: Module system implementation refresh (11/2016)
alanb
parents:
41452
diff
changeset
|
214 |
div.addContent(annotationContent); |
44564 | 215 |
Content label = mdle.isOpen() && (configuration.docEnv.getModuleMode() == ModuleMode.ALL) |
216 |
? contents.openModuleLabel : contents.moduleLabel; |
|
36526 | 217 |
Content tHeading = HtmlTree.HEADING(HtmlConstants.TITLE_HEADING, true, |
44564 | 218 |
HtmlStyle.title, label); |
40303 | 219 |
tHeading.addContent(Contents.SPACE); |
36526 | 220 |
Content moduleHead = new RawHtml(heading); |
221 |
tHeading.addContent(moduleHead); |
|
222 |
div.addContent(tHeading); |
|
223 |
if (configuration.allowTag(HtmlTag.MAIN)) { |
|
224 |
mainTree.addContent(div); |
|
225 |
} else { |
|
226 |
bodyTree.addContent(div); |
|
227 |
} |
|
228 |
return bodyTree; |
|
229 |
} |
|
230 |
||
231 |
/** |
|
39670
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
232 |
* Get the content header. |
36526 | 233 |
*/ |
42407
f3702cff2933
8169069: Module system implementation refresh (11/2016)
alanb
parents:
41452
diff
changeset
|
234 |
@Override |
36526 | 235 |
public Content getContentHeader() { |
236 |
HtmlTree div = new HtmlTree(HtmlTag.DIV); |
|
237 |
div.addStyle(HtmlStyle.contentContainer); |
|
238 |
return div; |
|
239 |
} |
|
240 |
||
241 |
/** |
|
39670
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
242 |
* Get the summary section header. |
36526 | 243 |
*/ |
42407
f3702cff2933
8169069: Module system implementation refresh (11/2016)
alanb
parents:
41452
diff
changeset
|
244 |
@Override |
36526 | 245 |
public Content getSummaryHeader() { |
246 |
HtmlTree li = new HtmlTree(HtmlTag.LI); |
|
247 |
li.addStyle(HtmlStyle.blockList); |
|
248 |
return li; |
|
249 |
} |
|
250 |
||
251 |
/** |
|
39670
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
252 |
* Get the summary tree. |
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
253 |
* |
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
254 |
* @param summaryContentTree the content tree to be added to the summary tree. |
36526 | 255 |
*/ |
42407
f3702cff2933
8169069: Module system implementation refresh (11/2016)
alanb
parents:
41452
diff
changeset
|
256 |
@Override |
36526 | 257 |
public Content getSummaryTree(Content summaryContentTree) { |
258 |
HtmlTree ul = HtmlTree.UL(HtmlStyle.blockList, summaryContentTree); |
|
259 |
return ul; |
|
260 |
} |
|
261 |
||
262 |
/** |
|
42831
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
263 |
* Compute the modules data that will be displayed in various tables on the module summary page. |
39670
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
264 |
*/ |
42831
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
265 |
public void computeModulesData() { |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
266 |
CommentHelper ch = utils.getCommentHelper(mdle); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
267 |
// Get module dependencies using the module's transitive closure. |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
268 |
Map<ModuleElement, String> dependentModules = utils.getDependentModules(mdle); |
44564 | 269 |
// Add all dependent modules to indirect modules set. We will remove the modules, |
270 |
// listed using the requires directive, from this set to come up with the table of indirect |
|
42831
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
271 |
// required modules. |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
272 |
dependentModules.forEach((module, mod) -> { |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
273 |
if (shouldDocument(module)) { |
44564 | 274 |
indirectModules.put(module, new StringContent(mod)); |
42831
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
275 |
} |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
276 |
}); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
277 |
(ElementFilter.requiresIn(mdle.getDirectives())).forEach((directive) -> { |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
278 |
ModuleElement m = directive.getDependency(); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
279 |
if (shouldDocument(m)) { |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
280 |
if (moduleMode == ModuleMode.ALL || directive.isTransitive()) { |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
281 |
requires.put(m, new StringContent(utils.getModifiers(directive))); |
39670
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
282 |
} else { |
44564 | 283 |
// For api mode, just keep the public requires in dependentModules for display of |
284 |
// indirect packages in the "Packages" section. |
|
42831
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
285 |
dependentModules.remove(m); |
44564 | 286 |
} |
287 |
indirectModules.remove(m); |
|
42831
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
288 |
} |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
289 |
}); |
44293
2f47b2c16612
8176778: javadoc does not produce summary pages for aggregated modules
ksrini
parents:
42831
diff
changeset
|
290 |
|
42831
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
291 |
// Get all packages for the module and put it in the concealed packages set. |
44293
2f47b2c16612
8176778: javadoc does not produce summary pages for aggregated modules
ksrini
parents:
42831
diff
changeset
|
292 |
utils.getModulePackageMap().getOrDefault(mdle, Collections.emptySet()).forEach((pkg) -> { |
42831
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
293 |
if (shouldDocument(pkg)) { |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
294 |
concealedPackages.add(pkg); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
295 |
} |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
296 |
}); |
44293
2f47b2c16612
8176778: javadoc does not produce summary pages for aggregated modules
ksrini
parents:
42831
diff
changeset
|
297 |
|
42831
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
298 |
// Get all exported packages for the module using the exports directive for the module. |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
299 |
(ElementFilter.exportsIn(mdle.getDirectives())).forEach((directive) -> { |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
300 |
PackageElement p = directive.getPackage(); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
301 |
if (shouldDocument(p)) { |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
302 |
SortedSet<ModuleElement> mdleList = new TreeSet<>(utils.makeModuleComparator()); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
303 |
List<? extends ModuleElement> targetMdles = directive.getTargetModules(); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
304 |
if (targetMdles != null) { |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
305 |
mdleList.addAll(targetMdles); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
306 |
} |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
307 |
// Qualified exports should not be displayed in the api mode. So if mdleList is empty, |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
308 |
// its exported to all modules and hence can be added. |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
309 |
if (moduleMode == ModuleMode.ALL || mdleList.isEmpty()) { |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
310 |
exportedPackages.put(p, mdleList); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
311 |
} |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
312 |
concealedPackages.remove(p); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
313 |
} |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
314 |
}); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
315 |
// Get all opened packages for the module using the opens directive for the module. |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
316 |
(ElementFilter.opensIn(mdle.getDirectives())).forEach((directive) -> { |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
317 |
PackageElement p = directive.getPackage(); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
318 |
if (shouldDocument(p)) { |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
319 |
SortedSet<ModuleElement> mdleList = new TreeSet<>(utils.makeModuleComparator()); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
320 |
List<? extends ModuleElement> targetMdles = directive.getTargetModules(); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
321 |
if (targetMdles != null) { |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
322 |
mdleList.addAll(targetMdles); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
323 |
} |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
324 |
// Qualified opens should not be displayed in the api mode. So if mdleList is empty, |
44564 | 325 |
// it is opened to all modules and hence can be added. |
42831
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
326 |
if (moduleMode == ModuleMode.ALL || mdleList.isEmpty()) { |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
327 |
openedPackages.put(p, mdleList); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
328 |
} |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
329 |
concealedPackages.remove(p); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
330 |
} |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
331 |
}); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
332 |
// Remove all the exported and opened packages so we have just the concealed packages now. |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
333 |
concealedPackages.removeAll(exportedPackages.keySet()); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
334 |
concealedPackages.removeAll(openedPackages.keySet()); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
335 |
// Get all the exported and opened packages, for the transitive closure of the module, to be displayed in |
44564 | 336 |
// the indirect packages tables. |
42831
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
337 |
dependentModules.forEach((module, mod) -> { |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
338 |
SortedSet<PackageElement> pkgList = new TreeSet<>(utils.makePackageComparator()); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
339 |
(ElementFilter.exportsIn(module.getDirectives())).forEach((directive) -> { |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
340 |
PackageElement pkg = directive.getPackage(); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
341 |
if (shouldDocument(pkg)) { |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
342 |
pkgList.add(pkg); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
343 |
} |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
344 |
}); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
345 |
// If none of the transitive modules have exported packages to be displayed, we should not be |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
346 |
// displaying the table and so it should not be added to the map. |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
347 |
if (!pkgList.isEmpty()) { |
44564 | 348 |
indirectPackages.put(module, pkgList); |
39670
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
349 |
} |
42831
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
350 |
SortedSet<PackageElement> openPkgList = new TreeSet<>(utils.makePackageComparator()); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
351 |
(ElementFilter.opensIn(module.getDirectives())).forEach((directive) -> { |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
352 |
PackageElement pkg = directive.getPackage(); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
353 |
if (shouldDocument(pkg)) { |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
354 |
openPkgList.add(pkg); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
355 |
} |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
356 |
}); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
357 |
// If none of the transitive modules have opened packages to be displayed, we should not be |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
358 |
// displaying the table and so it should not be added to the map. |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
359 |
if (!openPkgList.isEmpty()) { |
44564 | 360 |
indirectOpenPackages.put(module, openPkgList); |
42831
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
361 |
} |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
362 |
}); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
363 |
// Get all the services listed as uses directive. |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
364 |
(ElementFilter.usesIn(mdle.getDirectives())).forEach((directive) -> { |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
365 |
TypeElement u = directive.getService(); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
366 |
if (shouldDocument(u)) { |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
367 |
uses.add(u); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
368 |
} |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
369 |
}); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
370 |
// Get all the services and implementations listed as provides directive. |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
371 |
(ElementFilter.providesIn(mdle.getDirectives())).forEach((directive) -> { |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
372 |
TypeElement u = directive.getService(); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
373 |
if (shouldDocument(u)) { |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
374 |
List<? extends TypeElement> implList = directive.getImplementations(); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
375 |
SortedSet<TypeElement> implSet = new TreeSet<>(utils.makeAllClassesComparator()); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
376 |
implSet.addAll(implList); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
377 |
provides.put(u, implSet); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
378 |
} |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
379 |
}); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
380 |
// Generate the map of all services listed using @provides, and the description. |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
381 |
(utils.getBlockTags(mdle, DocTree.Kind.PROVIDES)).forEach((tree) -> { |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
382 |
TypeElement t = ch.getServiceType(configuration, tree); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
383 |
if (t != null) { |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
384 |
providesTrees.put(t, commentTagsToContent(tree, mdle, ch.getDescription(configuration, tree), false)); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
385 |
} |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
386 |
}); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
387 |
// Generate the map of all services listed using @uses, and the description. |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
388 |
(utils.getBlockTags(mdle, DocTree.Kind.USES)).forEach((tree) -> { |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
389 |
TypeElement t = ch.getServiceType(configuration, tree); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
390 |
if (t != null) { |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
391 |
usesTrees.put(t, commentTagsToContent(tree, mdle, ch.getDescription(configuration, tree), false)); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
392 |
} |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
393 |
}); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
394 |
} |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
395 |
|
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
396 |
/** |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
397 |
* Returns true if the element should be documented on the module summary page. |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
398 |
* |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
399 |
* @param element the element to be checked |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
400 |
* @return true if the element should be documented |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
401 |
*/ |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
402 |
public boolean shouldDocument(Element element) { |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
403 |
return (moduleMode == ModuleMode.ALL || utils.isIncluded(element)); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
404 |
} |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
405 |
|
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
406 |
/** |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
407 |
* Returns true if there are elements to be displayed. |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
408 |
* |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
409 |
* @param section set of elements |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
410 |
* @return true if there are elements to be displayed |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
411 |
*/ |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
412 |
public boolean display(SortedSet<? extends Element> section) { |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
413 |
return section != null && !section.isEmpty(); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
414 |
} |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
415 |
|
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
416 |
/** |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
417 |
* Returns true if there are elements to be displayed. |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
418 |
* |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
419 |
* @param section map of elements. |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
420 |
* @return true if there are elements to be displayed |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
421 |
*/ |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
422 |
public boolean display(Map<? extends Element, ?> section) { |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
423 |
return section != null && !section.isEmpty(); |
39670
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
424 |
} |
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
425 |
|
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
426 |
/** |
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
427 |
* Add the summary header. |
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
428 |
* |
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
429 |
* @param startMarker the marker comment |
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
430 |
* @param markerAnchor the marker anchor for the section |
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
431 |
* @param heading the heading for the section |
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
432 |
* @param htmltree the content tree to which the information is added |
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
433 |
*/ |
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
434 |
public void addSummaryHeader(Content startMarker, SectionName markerAnchor, Content heading, Content htmltree) { |
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
435 |
htmltree.addContent(startMarker); |
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
436 |
htmltree.addContent(getMarkerAnchor(markerAnchor)); |
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
437 |
htmltree.addContent(HtmlTree.HEADING(HtmlTag.H3, heading)); |
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
438 |
} |
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
439 |
|
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
440 |
/** |
42831
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
441 |
* Get table header. |
39670
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
442 |
* |
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
443 |
* @param text the table caption |
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
444 |
* @param tableSummary the summary for the table |
42831
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
445 |
* @param tableStyle the table style |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
446 |
* @param tableHeader the table header |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
447 |
* @return a content object |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
448 |
*/ |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
449 |
public Content getTableHeader(String text, String tableSummary, HtmlStyle tableStyle, |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
450 |
List<String> tableHeader) { |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
451 |
return getTableHeader(getTableCaption(new RawHtml(text)), tableSummary, tableStyle, tableHeader); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
452 |
} |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
453 |
|
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
454 |
/** |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
455 |
* Get table header. |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
456 |
* |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
457 |
* @param caption the table caption |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
458 |
* @param tableSummary the summary for the table |
39670
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
459 |
* @param tableStyle the table style |
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
460 |
* @param tableHeader the table header |
42831
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
461 |
* @return a content object |
39670
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
462 |
*/ |
42831
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
463 |
public Content getTableHeader(Content caption, String tableSummary, HtmlStyle tableStyle, |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
464 |
List<String> tableHeader) { |
39670
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
465 |
Content table = (configuration.isOutputHtml5()) |
42831
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
466 |
? HtmlTree.TABLE(tableStyle, caption) |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
467 |
: HtmlTree.TABLE(tableStyle, tableSummary, caption); |
39670
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
468 |
table.addContent(getSummaryTableHeader(tableHeader, "col")); |
42831
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
469 |
return table; |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
470 |
} |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
471 |
|
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
472 |
/** |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
473 |
* {@inheritDoc} |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
474 |
*/ |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
475 |
public void addModulesSummary(Content summaryContentTree) { |
44564 | 476 |
if (display(requires) || display(indirectModules)) { |
42831
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
477 |
HtmlTree li = new HtmlTree(HtmlTag.LI); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
478 |
li.addStyle(HtmlStyle.blockList); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
479 |
addSummaryHeader(HtmlConstants.START_OF_MODULES_SUMMARY, SectionName.MODULES, |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
480 |
contents.navModules, li); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
481 |
if (display(requires)) { |
44564 | 482 |
String text = configuration.getText("doclet.Requires_Summary"); |
483 |
String tableSummary = configuration.getText("doclet.Member_Table_Summary", |
|
484 |
configuration.getText("doclet.Requires_Summary"), |
|
485 |
configuration.getText("doclet.modules")); |
|
42831
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
486 |
Content table = getTableHeader(text, tableSummary, HtmlStyle.requiresSummary, requiresTableHeader); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
487 |
Content tbody = new HtmlTree(HtmlTag.TBODY); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
488 |
addModulesList(requires, tbody); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
489 |
table.addContent(tbody); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
490 |
li.addContent(table); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
491 |
} |
44564 | 492 |
// Display indirect modules table in both "api" and "all" mode. |
493 |
if (display(indirectModules)) { |
|
494 |
String amrText = configuration.getText("doclet.Indirect_Requires_Summary"); |
|
42831
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
495 |
String amrTableSummary = configuration.getText("doclet.Member_Table_Summary", |
44564 | 496 |
configuration.getText("doclet.Indirect_Requires_Summary"), |
42831
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
497 |
configuration.getText("doclet.modules")); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
498 |
Content amrTable = getTableHeader(amrText, amrTableSummary, HtmlStyle.requiresSummary, requiresTableHeader); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
499 |
Content amrTbody = new HtmlTree(HtmlTag.TBODY); |
44564 | 500 |
addModulesList(indirectModules, amrTbody); |
42831
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
501 |
amrTable.addContent(amrTbody); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
502 |
li.addContent(amrTable); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
503 |
} |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
504 |
HtmlTree ul = HtmlTree.UL(HtmlStyle.blockList, li); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
505 |
summaryContentTree.addContent(ul); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
506 |
} |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
507 |
} |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
508 |
|
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
509 |
/** |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
510 |
* Add the list of modules. |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
511 |
* |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
512 |
* @param mdleMap map of modules and modifiers |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
513 |
* @param tbody the content tree to which the list will be added |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
514 |
*/ |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
515 |
public void addModulesList(Map<ModuleElement, Content> mdleMap, Content tbody) { |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
516 |
boolean altColor = true; |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
517 |
for (ModuleElement m : mdleMap.keySet()) { |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
518 |
Content tdModifiers = HtmlTree.TD(HtmlStyle.colFirst, mdleMap.get(m)); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
519 |
Content moduleLinkContent = getModuleLink(m, new StringContent(m.getQualifiedName())); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
520 |
Content thModule = HtmlTree.TH_ROW_SCOPE(HtmlStyle.colSecond, moduleLinkContent); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
521 |
HtmlTree tdSummary = new HtmlTree(HtmlTag.TD); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
522 |
tdSummary.addStyle(HtmlStyle.colLast); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
523 |
addSummaryComment(m, tdSummary); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
524 |
HtmlTree tr = HtmlTree.TR(tdModifiers); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
525 |
tr.addContent(thModule); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
526 |
tr.addContent(tdSummary); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
527 |
tr.addStyle(altColor ? HtmlStyle.altColor : HtmlStyle.rowColor); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
528 |
tbody.addContent(tr); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
529 |
altColor = !altColor; |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
530 |
} |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
531 |
} |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
532 |
|
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
533 |
public void addPackagesSummary(Content summaryContentTree) { |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
534 |
if (display(exportedPackages) || display(openedPackages) || display(concealedPackages) |
44564 | 535 |
|| display(indirectPackages) || display(indirectOpenPackages)) { |
42831
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
536 |
HtmlTree li = new HtmlTree(HtmlTag.LI); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
537 |
li.addStyle(HtmlStyle.blockList); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
538 |
addSummaryHeader(HtmlConstants.START_OF_PACKAGES_SUMMARY, SectionName.PACKAGES, |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
539 |
contents.navPackages, li); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
540 |
String tableSummary = configuration.getText("doclet.Member_Table_Summary", |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
541 |
configuration.getText("doclet.Packages_Summary"), |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
542 |
configuration.getText("doclet.packages")); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
543 |
if (display(exportedPackages) || display(openedPackages) || display(concealedPackages)) { |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
544 |
addPackageSummary(tableSummary, li); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
545 |
} |
44564 | 546 |
if (display(indirectPackages)) { |
547 |
String aepText = configuration.getText("doclet.Indirect_Exports_Summary"); |
|
548 |
String aepTableSummary = configuration.getText("doclet.Indirect_Packages_Table_Summary", |
|
549 |
configuration.getText("doclet.Indirect_Exports_Summary"), |
|
42831
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
550 |
configuration.getText("doclet.modules"), |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
551 |
configuration.getText("doclet.packages")); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
552 |
Content aepTable = getTableHeader(aepText, aepTableSummary, HtmlStyle.packagesSummary, |
44564 | 553 |
indirectPackagesTableHeader); |
42831
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
554 |
Content aepTbody = new HtmlTree(HtmlTag.TBODY); |
44564 | 555 |
addIndirectPackages(aepTbody, indirectPackages); |
42831
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
556 |
aepTable.addContent(aepTbody); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
557 |
li.addContent(aepTable); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
558 |
} |
44564 | 559 |
if (display(indirectOpenPackages)) { |
560 |
String aopText = configuration.getText("doclet.Indirect_Opens_Summary"); |
|
561 |
String aopTableSummary = configuration.getText("doclet.Indirect_Packages_Table_Summary", |
|
562 |
configuration.getText("doclet.Indirect_Opens_Summary"), |
|
42831
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
563 |
configuration.getText("doclet.modules"), |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
564 |
configuration.getText("doclet.packages")); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
565 |
Content aopTable = getTableHeader(aopText, aopTableSummary, HtmlStyle.packagesSummary, |
44564 | 566 |
indirectPackagesTableHeader); |
42831
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
567 |
Content aopTbody = new HtmlTree(HtmlTag.TBODY); |
44564 | 568 |
addIndirectPackages(aopTbody, indirectOpenPackages); |
42831
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
569 |
aopTable.addContent(aopTbody); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
570 |
li.addContent(aopTable); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
571 |
} |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
572 |
HtmlTree ul = HtmlTree.UL(HtmlStyle.blockList, li); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
573 |
summaryContentTree.addContent(ul); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
574 |
} |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
575 |
} |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
576 |
|
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
577 |
/** |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
578 |
* Add the package summary for the module. |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
579 |
* |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
580 |
* @param tableSummary |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
581 |
* @param li |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
582 |
*/ |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
583 |
public void addPackageSummary(String tableSummary, HtmlTree li) { |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
584 |
Content caption; |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
585 |
Content tbody = getPackageTableRows(); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
586 |
if (showTabs()) { |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
587 |
caption = getTableCaption(); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
588 |
generateTableTabTypesScript(typeMap, modulePackageTypes, "packages"); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
589 |
} else { |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
590 |
ModulePackageTypes type = modulePackageTypes.iterator().next(); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
591 |
caption = getTableCaption(configuration.getContent(type.tableTabs().resourceKey())); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
592 |
} |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
593 |
Content table = getTableHeader(caption, tableSummary, HtmlStyle.packagesSummary, exportedPackagesTableHeader); |
39670
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
594 |
table.addContent(tbody); |
42831
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
595 |
li.addContent(table); |
39670
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
596 |
} |
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
597 |
|
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
598 |
/** |
42831
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
599 |
* Returns true if the table tabs needs to be displayed. |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
600 |
* |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
601 |
* @return true if the tabs should be displayed |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
602 |
*/ |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
603 |
public boolean showTabs() { |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
604 |
int value; |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
605 |
for (ModulePackageTypes type : EnumSet.allOf(ModulePackageTypes.class)) { |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
606 |
value = type.tableTabs().value(); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
607 |
if ((value & packageTypesOr) == value) { |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
608 |
modulePackageTypes.add(type); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
609 |
} |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
610 |
} |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
611 |
boolean showTabs = modulePackageTypes.size() > 1; |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
612 |
if (showTabs) { |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
613 |
modulePackageTypes.add(ModulePackageTypes.ALL); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
614 |
} |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
615 |
return showTabs; |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
616 |
} |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
617 |
|
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
618 |
/** |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
619 |
* Get the summary table caption. |
39670
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
620 |
* |
42831
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
621 |
* @return the caption for the summary table |
39670
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
622 |
*/ |
42831
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
623 |
public Content getTableCaption() { |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
624 |
Content tabbedCaption = new HtmlTree(HtmlTag.CAPTION); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
625 |
for (ModulePackageTypes type : modulePackageTypes) { |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
626 |
Content captionSpan; |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
627 |
Content span; |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
628 |
if (type.tableTabs().isDefaultTab()) { |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
629 |
captionSpan = HtmlTree.SPAN(configuration.getContent(type.tableTabs().resourceKey())); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
630 |
span = HtmlTree.SPAN(type.tableTabs().tabId(), |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
631 |
HtmlStyle.activeTableTab, captionSpan); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
632 |
} else { |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
633 |
captionSpan = HtmlTree.SPAN(getPackageTypeLinks(type)); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
634 |
span = HtmlTree.SPAN(type.tableTabs().tabId(), |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
635 |
HtmlStyle.tableTab, captionSpan); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
636 |
} |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
637 |
Content tabSpan = HtmlTree.SPAN(HtmlStyle.tabEnd, Contents.SPACE); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
638 |
span.addContent(tabSpan); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
639 |
tabbedCaption.addContent(span); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
640 |
} |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
641 |
return tabbedCaption; |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
642 |
} |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
643 |
|
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
644 |
/** |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
645 |
* Get the package type links for the table caption. |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
646 |
* |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
647 |
* @param packageType the package type to be displayed as link |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
648 |
* @return the content tree for the package type link |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
649 |
*/ |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
650 |
public Content getPackageTypeLinks(ModulePackageTypes packageType) { |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
651 |
String jsShow = "javascript:showPkgs(" + packageType.tableTabs().value() + ");"; |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
652 |
HtmlTree link = HtmlTree.A(jsShow, configuration.getContent(packageType.tableTabs().resourceKey())); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
653 |
return link; |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
654 |
} |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
655 |
|
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
656 |
/** |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
657 |
* Get the package table rows. |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
658 |
* |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
659 |
* @return a content object |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
660 |
*/ |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
661 |
public Content getPackageTableRows() { |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
662 |
Content tbody = new HtmlTree(HtmlTag.TBODY); |
39670
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
663 |
boolean altColor = true; |
42831
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
664 |
int counter = 0; |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
665 |
counter = addPackageTableRows(tbody, counter, ModulePackageTypes.EXPORTED, exportedPackages); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
666 |
counter = addPackageTableRows(tbody, counter, ModulePackageTypes.OPENED, openedPackages); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
667 |
// Show concealed packages only in "all" mode. |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
668 |
if (moduleMode == ModuleMode.ALL) { |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
669 |
for (PackageElement pkg : concealedPackages) { |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
670 |
Content pkgLinkContent = getPackageLink(pkg, new StringContent(utils.getPackageName(pkg))); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
671 |
Content thPackage = HtmlTree.TH_ROW_SCOPE(HtmlStyle.colFirst, pkgLinkContent); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
672 |
HtmlTree tdModules = new HtmlTree(HtmlTag.TD); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
673 |
tdModules.addStyle(HtmlStyle.colSecond); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
674 |
tdModules.addContent(configuration.getText("doclet.None")); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
675 |
HtmlTree tdSummary = new HtmlTree(HtmlTag.TD); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
676 |
tdSummary.addStyle(HtmlStyle.colLast); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
677 |
addSummaryComment(pkg, tdSummary); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
678 |
HtmlTree tr = HtmlTree.TR(thPackage); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
679 |
tr.addContent(tdModules); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
680 |
tr.addContent(tdSummary); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
681 |
tr.addStyle(altColor ? HtmlStyle.altColor : HtmlStyle.rowColor); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
682 |
int pkgType = ModulePackageTypes.CONCEALED.tableTabs().value(); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
683 |
packageTypesOr = packageTypesOr | pkgType; |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
684 |
String tableId = "i" + counter; |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
685 |
counter++; |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
686 |
typeMap.put(tableId, pkgType); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
687 |
tr.addAttr(HtmlAttr.ID, tableId); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
688 |
tbody.addContent(tr); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
689 |
altColor = !altColor; |
39670
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
690 |
} |
42831
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
691 |
} |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
692 |
return tbody; |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
693 |
} |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
694 |
|
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
695 |
public int addPackageTableRows(Content tbody, int counter, ModulePackageTypes pType, |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
696 |
Map<PackageElement,SortedSet<ModuleElement>> ap) { |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
697 |
boolean altColor = true; |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
698 |
for (Map.Entry<PackageElement, SortedSet<ModuleElement>> entry : ap.entrySet()) { |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
699 |
PackageElement pkg = entry.getKey(); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
700 |
SortedSet<ModuleElement> mdleList = entry.getValue(); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
701 |
Content pkgLinkContent = getPackageLink(pkg, new StringContent(utils.getPackageName(pkg))); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
702 |
Content thPackage = HtmlTree.TH_ROW_SCOPE(HtmlStyle.colFirst, pkgLinkContent); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
703 |
HtmlTree tr = HtmlTree.TR(thPackage); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
704 |
if (moduleMode == ModuleMode.ALL) { |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
705 |
HtmlTree tdModules = new HtmlTree(HtmlTag.TD); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
706 |
tdModules.addStyle(HtmlStyle.colSecond); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
707 |
if (!mdleList.isEmpty()) { |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
708 |
int sep = 0; |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
709 |
for (ModuleElement m : mdleList) { |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
710 |
if (sep > 0) { |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
711 |
tdModules.addContent(new HtmlTree(HtmlTag.BR)); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
712 |
} |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
713 |
tdModules.addContent(getModuleLink(m, new StringContent(m.getQualifiedName()))); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
714 |
sep++; |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
715 |
} |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
716 |
} else { |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
717 |
tdModules.addContent(configuration.getText("doclet.All_Modules")); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
718 |
} |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
719 |
tr.addContent(tdModules); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
720 |
} |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
721 |
HtmlTree tdSummary = new HtmlTree(HtmlTag.TD); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
722 |
tdSummary.addStyle(HtmlStyle.colLast); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
723 |
addSummaryComment(pkg, tdSummary); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
724 |
tr.addContent(tdSummary); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
725 |
tr.addStyle(altColor ? HtmlStyle.altColor : HtmlStyle.rowColor); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
726 |
int pkgType = pType.tableTabs().value(); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
727 |
packageTypesOr = packageTypesOr | pkgType; |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
728 |
String tableId = "i" + counter; |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
729 |
counter++; |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
730 |
typeMap.put(tableId, pkgType); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
731 |
tr.addAttr(HtmlAttr.ID, tableId); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
732 |
tbody.addContent(tr); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
733 |
altColor = !altColor; |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
734 |
} |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
735 |
return counter; |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
736 |
} |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
737 |
|
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
738 |
/** |
44564 | 739 |
* Add the indirect packages for the module being documented. |
42831
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
740 |
* |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
741 |
* @param tbody the content tree to which the table will be added |
44564 | 742 |
* @param ip indirect packages to be added |
42831
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
743 |
*/ |
44564 | 744 |
public void addIndirectPackages(Content tbody, Map<ModuleElement, SortedSet<PackageElement>> ip) { |
42831
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
745 |
boolean altColor = true; |
44564 | 746 |
for (Map.Entry<ModuleElement, SortedSet<PackageElement>> entry : ip.entrySet()) { |
42831
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
747 |
ModuleElement m = entry.getKey(); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
748 |
SortedSet<PackageElement> pkgList = entry.getValue(); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
749 |
Content moduleLinkContent = getModuleLink(m, new StringContent(m.getQualifiedName())); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
750 |
Content thModule = HtmlTree.TH_ROW_SCOPE(HtmlStyle.colFirst, moduleLinkContent); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
751 |
HtmlTree tdPackages = new HtmlTree(HtmlTag.TD); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
752 |
tdPackages.addStyle(HtmlStyle.colLast); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
753 |
String sep = ""; |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
754 |
for (PackageElement pkg : pkgList) { |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
755 |
tdPackages.addContent(sep); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
756 |
tdPackages.addContent(getPackageLink(pkg, new StringContent(utils.getPackageName(pkg)))); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
757 |
sep = " "; |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
758 |
} |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
759 |
HtmlTree tr = HtmlTree.TR(thModule); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
760 |
tr.addContent(tdPackages); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
761 |
tr.addStyle(altColor ? HtmlStyle.altColor : HtmlStyle.rowColor); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
762 |
tbody.addContent(tr); |
39670
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
763 |
altColor = !altColor; |
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
764 |
} |
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
765 |
} |
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
766 |
|
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
767 |
/** |
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
768 |
* {@inheritDoc} |
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
769 |
*/ |
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
770 |
public void addServicesSummary(Content summaryContentTree) { |
42831
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
771 |
if (display(uses) || display(provides)) { |
39670
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
772 |
HtmlTree li = new HtmlTree(HtmlTag.LI); |
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
773 |
li.addStyle(HtmlStyle.blockList); |
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
774 |
addSummaryHeader(HtmlConstants.START_OF_SERVICES_SUMMARY, SectionName.SERVICES, |
40303 | 775 |
contents.navServices, li); |
39670
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
776 |
String text; |
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
777 |
String tableSummary; |
44564 | 778 |
if (display(provides)) { |
779 |
text = configuration.getText("doclet.Provides_Summary"); |
|
780 |
tableSummary = configuration.getText("doclet.Member_Table_Summary", |
|
781 |
configuration.getText("doclet.Provides_Summary"), |
|
782 |
configuration.getText("doclet.types")); |
|
783 |
Content table = getTableHeader(text, tableSummary, HtmlStyle.providesSummary, providesTableHeader); |
|
784 |
Content tbody = new HtmlTree(HtmlTag.TBODY); |
|
785 |
addProvidesList(tbody); |
|
786 |
if (!tbody.isEmpty()) { |
|
787 |
table.addContent(tbody); |
|
788 |
li.addContent(table); |
|
789 |
} |
|
790 |
} |
|
42831
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
791 |
if (display(uses)) { |
39670
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
792 |
text = configuration.getText("doclet.Uses_Summary"); |
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
793 |
tableSummary = configuration.getText("doclet.Member_Table_Summary", |
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
794 |
configuration.getText("doclet.Uses_Summary"), |
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
795 |
configuration.getText("doclet.types")); |
42831
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
796 |
Content table = getTableHeader(text, tableSummary, HtmlStyle.usesSummary, usesTableHeader); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
797 |
Content tbody = new HtmlTree(HtmlTag.TBODY); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
798 |
addUsesList(tbody); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
799 |
if (!tbody.isEmpty()) { |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
800 |
table.addContent(tbody); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
801 |
li.addContent(table); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
802 |
} |
39670
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
803 |
} |
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
804 |
HtmlTree ul = HtmlTree.UL(HtmlStyle.blockList, li); |
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
805 |
summaryContentTree.addContent(ul); |
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
806 |
} |
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
807 |
} |
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
808 |
|
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
809 |
/** |
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
810 |
* Add the uses list for the module. |
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
811 |
* |
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
812 |
* @param tbody the content tree to which the directive will be added |
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
813 |
*/ |
42831
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
814 |
public void addUsesList(Content tbody) { |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
815 |
boolean altColor = true; |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
816 |
Content typeLinkContent; |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
817 |
Content thType; |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
818 |
HtmlTree tdSummary; |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
819 |
Content description; |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
820 |
for (TypeElement t : uses) { |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
821 |
// For each uses directive in the module declaration, if we are in the "api" mode and |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
822 |
// if there are service types listed using @uses javadoc tag, check if the service type in |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
823 |
// the uses directive is specified using the @uses tag. If not, we do not display the |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
824 |
// service type in the "api" mode. |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
825 |
if (moduleMode == ModuleMode.API && display(usesTrees) && !usesTrees.containsKey(t)) { |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
826 |
continue; |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
827 |
} |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
828 |
typeLinkContent = getLink(new LinkInfoImpl(configuration, LinkInfoImpl.Kind.PACKAGE, t)); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
829 |
thType = HtmlTree.TH_ROW_SCOPE(HtmlStyle.colFirst, typeLinkContent); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
830 |
tdSummary = new HtmlTree(HtmlTag.TD); |
39670
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
831 |
tdSummary.addStyle(HtmlStyle.colLast); |
42831
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
832 |
if (display(usesTrees)) { |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
833 |
description = usesTrees.get(t); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
834 |
if (description != null) { |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
835 |
tdSummary.addContent(description); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
836 |
} |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
837 |
} |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
838 |
addSummaryComment(t, tdSummary); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
839 |
HtmlTree tr = HtmlTree.TR(thType); |
39670
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
840 |
tr.addContent(tdSummary); |
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
841 |
tr.addStyle(altColor ? HtmlStyle.altColor : HtmlStyle.rowColor); |
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
842 |
tbody.addContent(tr); |
42831
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
843 |
altColor = !altColor; |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
844 |
} |
39670
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
845 |
} |
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
846 |
|
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
847 |
/** |
42831
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
848 |
* Add the provides list for the module. |
39670
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
849 |
* |
42831
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
850 |
* @param tbody the content tree to which the directive will be added |
39670
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
851 |
*/ |
42831
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
852 |
public void addProvidesList(Content tbody) { |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
853 |
boolean altColor = true; |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
854 |
TypeElement srv; |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
855 |
SortedSet<TypeElement> implSet; |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
856 |
Content description; |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
857 |
for (Map.Entry<TypeElement, SortedSet<TypeElement>> entry : provides.entrySet()) { |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
858 |
srv = entry.getKey(); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
859 |
// For each provides directive in the module declaration, if we are in the "api" mode and |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
860 |
// if there are service types listed using @provides javadoc tag, check if the service type in |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
861 |
// the provides directive is specified using the @provides tag. If not, we do not display the |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
862 |
// service type in the "api" mode. |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
863 |
if (moduleMode == ModuleMode.API && display(providesTrees) && !providesTrees.containsKey(srv)) { |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
864 |
continue; |
39670
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
865 |
} |
42831
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
866 |
implSet = entry.getValue(); |
42407
f3702cff2933
8169069: Module system implementation refresh (11/2016)
alanb
parents:
41452
diff
changeset
|
867 |
Content srvLinkContent = getLink(new LinkInfoImpl(configuration, LinkInfoImpl.Kind.PACKAGE, srv)); |
f3702cff2933
8169069: Module system implementation refresh (11/2016)
alanb
parents:
41452
diff
changeset
|
868 |
HtmlTree thType = HtmlTree.TH_ROW_SCOPE(HtmlStyle.colFirst, srvLinkContent); |
f3702cff2933
8169069: Module system implementation refresh (11/2016)
alanb
parents:
41452
diff
changeset
|
869 |
HtmlTree tdDesc = new HtmlTree(HtmlTag.TD); |
f3702cff2933
8169069: Module system implementation refresh (11/2016)
alanb
parents:
41452
diff
changeset
|
870 |
tdDesc.addStyle(HtmlStyle.colLast); |
42831
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
871 |
if (display(providesTrees)) { |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
872 |
description = providesTrees.get(srv); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
873 |
if (description != null) { |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
874 |
tdDesc.addContent(description); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
875 |
} |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
876 |
} |
42407
f3702cff2933
8169069: Module system implementation refresh (11/2016)
alanb
parents:
41452
diff
changeset
|
877 |
addSummaryComment(srv, tdDesc); |
42831
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
878 |
// Only display the implementation details in the "all" mode. |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
879 |
if (moduleMode == ModuleMode.ALL && !implSet.isEmpty()) { |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
880 |
tdDesc.addContent(new HtmlTree(HtmlTag.BR)); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
881 |
tdDesc.addContent("("); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
882 |
HtmlTree implSpan = HtmlTree.SPAN(HtmlStyle.implementationLabel, contents.implementation); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
883 |
tdDesc.addContent(implSpan); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
884 |
tdDesc.addContent(Contents.SPACE); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
885 |
String sep = ""; |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
886 |
for (TypeElement impl : implSet) { |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
887 |
tdDesc.addContent(sep); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
888 |
tdDesc.addContent(getLink(new LinkInfoImpl(configuration, LinkInfoImpl.Kind.PACKAGE, impl))); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
889 |
sep = ", "; |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
890 |
} |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
891 |
tdDesc.addContent(")"); |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
892 |
} |
42407
f3702cff2933
8169069: Module system implementation refresh (11/2016)
alanb
parents:
41452
diff
changeset
|
893 |
HtmlTree tr = HtmlTree.TR(thType); |
f3702cff2933
8169069: Module system implementation refresh (11/2016)
alanb
parents:
41452
diff
changeset
|
894 |
tr.addContent(tdDesc); |
f3702cff2933
8169069: Module system implementation refresh (11/2016)
alanb
parents:
41452
diff
changeset
|
895 |
tr.addStyle(altColor ? HtmlStyle.altColor : HtmlStyle.rowColor); |
f3702cff2933
8169069: Module system implementation refresh (11/2016)
alanb
parents:
41452
diff
changeset
|
896 |
tbody.addContent(tr); |
42831
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
897 |
altColor = !altColor; |
42407
f3702cff2933
8169069: Module system implementation refresh (11/2016)
alanb
parents:
41452
diff
changeset
|
898 |
} |
f3702cff2933
8169069: Module system implementation refresh (11/2016)
alanb
parents:
41452
diff
changeset
|
899 |
} |
f3702cff2933
8169069: Module system implementation refresh (11/2016)
alanb
parents:
41452
diff
changeset
|
900 |
|
f3702cff2933
8169069: Module system implementation refresh (11/2016)
alanb
parents:
41452
diff
changeset
|
901 |
/** |
f3702cff2933
8169069: Module system implementation refresh (11/2016)
alanb
parents:
41452
diff
changeset
|
902 |
* Add the module deprecation information to the documentation tree. |
f3702cff2933
8169069: Module system implementation refresh (11/2016)
alanb
parents:
41452
diff
changeset
|
903 |
* |
f3702cff2933
8169069: Module system implementation refresh (11/2016)
alanb
parents:
41452
diff
changeset
|
904 |
* @param div the content tree to which the deprecation information will be added |
f3702cff2933
8169069: Module system implementation refresh (11/2016)
alanb
parents:
41452
diff
changeset
|
905 |
*/ |
f3702cff2933
8169069: Module system implementation refresh (11/2016)
alanb
parents:
41452
diff
changeset
|
906 |
public void addDeprecationInfo(Content div) { |
f3702cff2933
8169069: Module system implementation refresh (11/2016)
alanb
parents:
41452
diff
changeset
|
907 |
List<? extends DocTree> deprs = utils.getBlockTags(mdle, DocTree.Kind.DEPRECATED); |
f3702cff2933
8169069: Module system implementation refresh (11/2016)
alanb
parents:
41452
diff
changeset
|
908 |
if (utils.isDeprecated(mdle)) { |
f3702cff2933
8169069: Module system implementation refresh (11/2016)
alanb
parents:
41452
diff
changeset
|
909 |
CommentHelper ch = utils.getCommentHelper(mdle); |
f3702cff2933
8169069: Module system implementation refresh (11/2016)
alanb
parents:
41452
diff
changeset
|
910 |
HtmlTree deprDiv = new HtmlTree(HtmlTag.DIV); |
f3702cff2933
8169069: Module system implementation refresh (11/2016)
alanb
parents:
41452
diff
changeset
|
911 |
deprDiv.addStyle(HtmlStyle.deprecatedContent); |
42816
3638773ff1b0
8162674: change javadoc output text and style emitted by for-removal deprecations
bpatel
parents:
42407
diff
changeset
|
912 |
Content deprPhrase = HtmlTree.SPAN(HtmlStyle.deprecatedLabel, getDeprecatedPhrase(mdle)); |
42407
f3702cff2933
8169069: Module system implementation refresh (11/2016)
alanb
parents:
41452
diff
changeset
|
913 |
deprDiv.addContent(deprPhrase); |
f3702cff2933
8169069: Module system implementation refresh (11/2016)
alanb
parents:
41452
diff
changeset
|
914 |
if (!deprs.isEmpty()) { |
f3702cff2933
8169069: Module system implementation refresh (11/2016)
alanb
parents:
41452
diff
changeset
|
915 |
List<? extends DocTree> commentTags = ch.getDescription(configuration, deprs.get(0)); |
f3702cff2933
8169069: Module system implementation refresh (11/2016)
alanb
parents:
41452
diff
changeset
|
916 |
if (!commentTags.isEmpty()) { |
f3702cff2933
8169069: Module system implementation refresh (11/2016)
alanb
parents:
41452
diff
changeset
|
917 |
addInlineDeprecatedComment(mdle, deprs.get(0), deprDiv); |
f3702cff2933
8169069: Module system implementation refresh (11/2016)
alanb
parents:
41452
diff
changeset
|
918 |
} |
f3702cff2933
8169069: Module system implementation refresh (11/2016)
alanb
parents:
41452
diff
changeset
|
919 |
} |
f3702cff2933
8169069: Module system implementation refresh (11/2016)
alanb
parents:
41452
diff
changeset
|
920 |
div.addContent(deprDiv); |
f3702cff2933
8169069: Module system implementation refresh (11/2016)
alanb
parents:
41452
diff
changeset
|
921 |
} |
36526 | 922 |
} |
923 |
||
924 |
/** |
|
37747
878801512393
8154119: Module summary page should display module description
bpatel
parents:
36526
diff
changeset
|
925 |
* {@inheritDoc} |
878801512393
8154119: Module summary page should display module description
bpatel
parents:
36526
diff
changeset
|
926 |
*/ |
42407
f3702cff2933
8169069: Module system implementation refresh (11/2016)
alanb
parents:
41452
diff
changeset
|
927 |
@Override |
37747
878801512393
8154119: Module summary page should display module description
bpatel
parents:
36526
diff
changeset
|
928 |
public void addModuleDescription(Content moduleContentTree) { |
41452 | 929 |
if (!utils.getFullBody(mdle).isEmpty()) { |
37747
878801512393
8154119: Module summary page should display module description
bpatel
parents:
36526
diff
changeset
|
930 |
Content tree = configuration.allowTag(HtmlTag.SECTION) ? HtmlTree.SECTION() : moduleContentTree; |
42407
f3702cff2933
8169069: Module system implementation refresh (11/2016)
alanb
parents:
41452
diff
changeset
|
931 |
addDeprecationInfo(tree); |
37747
878801512393
8154119: Module summary page should display module description
bpatel
parents:
36526
diff
changeset
|
932 |
tree.addContent(HtmlConstants.START_OF_MODULE_DESCRIPTION); |
878801512393
8154119: Module summary page should display module description
bpatel
parents:
36526
diff
changeset
|
933 |
tree.addContent(getMarkerAnchor(SectionName.MODULE_DESCRIPTION)); |
878801512393
8154119: Module summary page should display module description
bpatel
parents:
36526
diff
changeset
|
934 |
addInlineComment(mdle, tree); |
878801512393
8154119: Module summary page should display module description
bpatel
parents:
36526
diff
changeset
|
935 |
if (configuration.allowTag(HtmlTag.SECTION)) { |
878801512393
8154119: Module summary page should display module description
bpatel
parents:
36526
diff
changeset
|
936 |
moduleContentTree.addContent(tree); |
878801512393
8154119: Module summary page should display module description
bpatel
parents:
36526
diff
changeset
|
937 |
} |
878801512393
8154119: Module summary page should display module description
bpatel
parents:
36526
diff
changeset
|
938 |
} |
878801512393
8154119: Module summary page should display module description
bpatel
parents:
36526
diff
changeset
|
939 |
} |
878801512393
8154119: Module summary page should display module description
bpatel
parents:
36526
diff
changeset
|
940 |
|
878801512393
8154119: Module summary page should display module description
bpatel
parents:
36526
diff
changeset
|
941 |
/** |
38911
48a00b5ee366
8156077: Support javadoc tags in module documentation
bpatel
parents:
37943
diff
changeset
|
942 |
* {@inheritDoc} |
48a00b5ee366
8156077: Support javadoc tags in module documentation
bpatel
parents:
37943
diff
changeset
|
943 |
*/ |
42407
f3702cff2933
8169069: Module system implementation refresh (11/2016)
alanb
parents:
41452
diff
changeset
|
944 |
@Override |
38911
48a00b5ee366
8156077: Support javadoc tags in module documentation
bpatel
parents:
37943
diff
changeset
|
945 |
public void addModuleTags(Content moduleContentTree) { |
48a00b5ee366
8156077: Support javadoc tags in module documentation
bpatel
parents:
37943
diff
changeset
|
946 |
Content tree = (configuration.allowTag(HtmlTag.SECTION)) |
48a00b5ee366
8156077: Support javadoc tags in module documentation
bpatel
parents:
37943
diff
changeset
|
947 |
? HtmlTree.SECTION() |
48a00b5ee366
8156077: Support javadoc tags in module documentation
bpatel
parents:
37943
diff
changeset
|
948 |
: moduleContentTree; |
48a00b5ee366
8156077: Support javadoc tags in module documentation
bpatel
parents:
37943
diff
changeset
|
949 |
addTagsInfo(mdle, tree); |
48a00b5ee366
8156077: Support javadoc tags in module documentation
bpatel
parents:
37943
diff
changeset
|
950 |
if (configuration.allowTag(HtmlTag.SECTION)) { |
48a00b5ee366
8156077: Support javadoc tags in module documentation
bpatel
parents:
37943
diff
changeset
|
951 |
moduleContentTree.addContent(tree); |
48a00b5ee366
8156077: Support javadoc tags in module documentation
bpatel
parents:
37943
diff
changeset
|
952 |
} |
48a00b5ee366
8156077: Support javadoc tags in module documentation
bpatel
parents:
37943
diff
changeset
|
953 |
} |
48a00b5ee366
8156077: Support javadoc tags in module documentation
bpatel
parents:
37943
diff
changeset
|
954 |
|
48a00b5ee366
8156077: Support javadoc tags in module documentation
bpatel
parents:
37943
diff
changeset
|
955 |
/** |
39670
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
956 |
* Add summary details to the navigation bar. |
36526 | 957 |
* |
39670
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
958 |
* @param subDiv the content tree to which the summary detail links will be added |
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
959 |
*/ |
42407
f3702cff2933
8169069: Module system implementation refresh (11/2016)
alanb
parents:
41452
diff
changeset
|
960 |
@Override |
39670
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
961 |
protected void addSummaryDetailLinks(Content subDiv) { |
40587 | 962 |
Content div = HtmlTree.DIV(getNavSummaryLinks()); |
963 |
subDiv.addContent(div); |
|
39670
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
964 |
} |
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
965 |
|
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
966 |
/** |
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
967 |
* Get summary links for navigation bar. |
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
968 |
* |
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
969 |
* @return the content tree for the navigation summary links |
36526 | 970 |
*/ |
40587 | 971 |
protected Content getNavSummaryLinks() { |
40303 | 972 |
Content li = HtmlTree.LI(contents.moduleSubNavLabel); |
973 |
li.addContent(Contents.SPACE); |
|
39670
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
974 |
Content ulNav = HtmlTree.UL(HtmlStyle.subNavList, li); |
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
975 |
Content liNav = new HtmlTree(HtmlTag.LI); |
41452 | 976 |
liNav.addContent(!utils.getFullBody(mdle).isEmpty() && !configuration.nocomment |
40303 | 977 |
? getHyperLink(SectionName.MODULE_DESCRIPTION, contents.navModuleDescription) |
978 |
: contents.navModuleDescription); |
|
39670
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
979 |
addNavGap(liNav); |
44564 | 980 |
liNav.addContent((display(requires) || display(indirectModules)) |
40303 | 981 |
? getHyperLink(SectionName.MODULES, contents.navModules) |
982 |
: contents.navModules); |
|
39670
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
983 |
addNavGap(liNav); |
42831
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
984 |
liNav.addContent((display(exportedPackages) || display(openedPackages) || display(concealedPackages) |
44564 | 985 |
|| display(indirectPackages) || display(indirectOpenPackages)) |
40303 | 986 |
? getHyperLink(SectionName.PACKAGES, contents.navPackages) |
987 |
: contents.navPackages); |
|
39670
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
988 |
addNavGap(liNav); |
42831
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
989 |
liNav.addContent((display(uses) || (moduleMode == ModuleMode.API && display(usesTrees)) |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
990 |
|| display(provides) || (moduleMode == ModuleMode.API && display(providesTrees))) |
40303 | 991 |
? getHyperLink(SectionName.SERVICES, contents.navServices) |
992 |
: contents.navServices); |
|
39670
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
993 |
ulNav.addContent(liNav); |
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
994 |
return ulNav; |
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
995 |
} |
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
996 |
|
9d1eafbf29c6
8154261: Module summary page should display directives for the module
bpatel
parents:
38911
diff
changeset
|
997 |
/** |
36526 | 998 |
* {@inheritDoc} |
999 |
*/ |
|
42407
f3702cff2933
8169069: Module system implementation refresh (11/2016)
alanb
parents:
41452
diff
changeset
|
1000 |
@Override |
36526 | 1001 |
public void addModuleContent(Content contentTree, Content moduleContentTree) { |
1002 |
if (configuration.allowTag(HtmlTag.MAIN)) { |
|
1003 |
mainTree.addContent(moduleContentTree); |
|
1004 |
contentTree.addContent(mainTree); |
|
1005 |
} else { |
|
1006 |
contentTree.addContent(moduleContentTree); |
|
1007 |
} |
|
1008 |
} |
|
1009 |
||
1010 |
/** |
|
1011 |
* {@inheritDoc} |
|
1012 |
*/ |
|
42407
f3702cff2933
8169069: Module system implementation refresh (11/2016)
alanb
parents:
41452
diff
changeset
|
1013 |
@Override |
36526 | 1014 |
public void addModuleFooter(Content contentTree) { |
1015 |
Content htmlTree = (configuration.allowTag(HtmlTag.FOOTER)) |
|
1016 |
? HtmlTree.FOOTER() |
|
1017 |
: contentTree; |
|
1018 |
addNavLinks(false, htmlTree); |
|
1019 |
addBottom(htmlTree); |
|
1020 |
if (configuration.allowTag(HtmlTag.FOOTER)) { |
|
1021 |
contentTree.addContent(htmlTree); |
|
1022 |
} |
|
1023 |
} |
|
1024 |
||
1025 |
/** |
|
1026 |
* {@inheritDoc} |
|
42831
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
1027 |
* |
feff6f296019
8160196: Module summary page should display information based on "api" or "detail" mode.
bpatel
parents:
42816
diff
changeset
|
1028 |
* @throws jdk.javadoc.internal.doclets.toolkit.util.DocFileIOException |
36526 | 1029 |
*/ |
40587 | 1030 |
@Override |
1031 |
public void printDocument(Content contentTree) throws DocFileIOException { |
|
36526 | 1032 |
printHtmlDocument(configuration.metakeywords.getMetaKeywordsForModule(mdle), |
1033 |
true, contentTree); |
|
1034 |
} |
|
1035 |
||
1036 |
/** |
|
1037 |
* Add the module package deprecation information to the documentation tree. |
|
1038 |
* |
|
1039 |
* @param li the content tree to which the deprecation information will be added |
|
1040 |
* @param pkg the PackageDoc that is added |
|
1041 |
*/ |
|
1042 |
public void addPackageDeprecationInfo(Content li, PackageElement pkg) { |
|
1043 |
List<? extends DocTree> deprs; |
|
1044 |
if (utils.isDeprecated(pkg)) { |
|
1045 |
deprs = utils.getDeprecatedTrees(pkg); |
|
1046 |
HtmlTree deprDiv = new HtmlTree(HtmlTag.DIV); |
|
1047 |
deprDiv.addStyle(HtmlStyle.deprecatedContent); |
|
42816
3638773ff1b0
8162674: change javadoc output text and style emitted by for-removal deprecations
bpatel
parents:
42407
diff
changeset
|
1048 |
Content deprPhrase = HtmlTree.SPAN(HtmlStyle.deprecatedLabel, getDeprecatedPhrase(pkg)); |
36526 | 1049 |
deprDiv.addContent(deprPhrase); |
1050 |
if (!deprs.isEmpty()) { |
|
1051 |
CommentHelper ch = utils.getCommentHelper(pkg); |
|
1052 |
List<? extends DocTree> commentTags = ch.getDescription(configuration, deprs.get(0)); |
|
1053 |
if (!commentTags.isEmpty()) { |
|
1054 |
addInlineDeprecatedComment(pkg, deprs.get(0), deprDiv); |
|
1055 |
} |
|
1056 |
} |
|
1057 |
li.addContent(deprDiv); |
|
1058 |
} |
|
1059 |
} |
|
1060 |
||
1061 |
/** |
|
37943
2efb75c09230
8154262: Navigation bar in javadoc generated pages needs to be updated to display module information
bpatel
parents:
37747
diff
changeset
|
1062 |
* Get this module link. |
2efb75c09230
8154262: Navigation bar in javadoc generated pages needs to be updated to display module information
bpatel
parents:
37747
diff
changeset
|
1063 |
* |
2efb75c09230
8154262: Navigation bar in javadoc generated pages needs to be updated to display module information
bpatel
parents:
37747
diff
changeset
|
1064 |
* @return a content tree for the module link |
2efb75c09230
8154262: Navigation bar in javadoc generated pages needs to be updated to display module information
bpatel
parents:
37747
diff
changeset
|
1065 |
*/ |
2efb75c09230
8154262: Navigation bar in javadoc generated pages needs to be updated to display module information
bpatel
parents:
37747
diff
changeset
|
1066 |
@Override |
2efb75c09230
8154262: Navigation bar in javadoc generated pages needs to be updated to display module information
bpatel
parents:
37747
diff
changeset
|
1067 |
protected Content getNavLinkModule() { |
40303 | 1068 |
Content li = HtmlTree.LI(HtmlStyle.navBarCell1Rev, contents.moduleLabel); |
37943
2efb75c09230
8154262: Navigation bar in javadoc generated pages needs to be updated to display module information
bpatel
parents:
37747
diff
changeset
|
1069 |
return li; |
2efb75c09230
8154262: Navigation bar in javadoc generated pages needs to be updated to display module information
bpatel
parents:
37747
diff
changeset
|
1070 |
} |
2efb75c09230
8154262: Navigation bar in javadoc generated pages needs to be updated to display module information
bpatel
parents:
37747
diff
changeset
|
1071 |
|
2efb75c09230
8154262: Navigation bar in javadoc generated pages needs to be updated to display module information
bpatel
parents:
37747
diff
changeset
|
1072 |
/** |
36526 | 1073 |
* Get "PREV MODULE" link in the navigation bar. |
1074 |
* |
|
1075 |
* @return a content tree for the previous link |
|
1076 |
*/ |
|
42407
f3702cff2933
8169069: Module system implementation refresh (11/2016)
alanb
parents:
41452
diff
changeset
|
1077 |
@Override |
36526 | 1078 |
public Content getNavLinkPrevious() { |
1079 |
Content li; |
|
1080 |
if (prevModule == null) { |
|
40303 | 1081 |
li = HtmlTree.LI(contents.prevModuleLabel); |
36526 | 1082 |
} else { |
1083 |
li = HtmlTree.LI(getHyperLink(pathToRoot.resolve(DocPaths.moduleSummary( |
|
40303 | 1084 |
prevModule)), contents.prevModuleLabel, "", "")); |
36526 | 1085 |
} |
1086 |
return li; |
|
1087 |
} |
|
1088 |
||
1089 |
/** |
|
1090 |
* Get "NEXT MODULE" link in the navigation bar. |
|
1091 |
* |
|
1092 |
* @return a content tree for the next link |
|
1093 |
*/ |
|
42407
f3702cff2933
8169069: Module system implementation refresh (11/2016)
alanb
parents:
41452
diff
changeset
|
1094 |
@Override |
36526 | 1095 |
public Content getNavLinkNext() { |
1096 |
Content li; |
|
1097 |
if (nextModule == null) { |
|
40303 | 1098 |
li = HtmlTree.LI(contents.nextModuleLabel); |
36526 | 1099 |
} else { |
1100 |
li = HtmlTree.LI(getHyperLink(pathToRoot.resolve(DocPaths.moduleSummary( |
|
40303 | 1101 |
nextModule)), contents.nextModuleLabel, "", "")); |
36526 | 1102 |
} |
1103 |
return li; |
|
1104 |
} |
|
1105 |
} |