author | ksrini |
Sun, 15 Jun 2014 08:41:57 -0700 | |
changeset 25454 | 376a52c9540c |
parent 25287 | d2440361b323 |
permissions | -rw-r--r-- |
15723
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
1 |
/* |
24221
2376793dd33b
8038583: [javadoc] Refactor uses of arrays to Collections
ksrini
parents:
22159
diff
changeset
|
2 |
* Copyright (c) 2013, 2014, Oracle and/or its affiliates. All rights reserved. |
15723
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
3 |
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
4 |
* |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
5 |
* This code is free software; you can redistribute it and/or modify it |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
6 |
* under the terms of the GNU General Public License version 2 only, as |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
7 |
* published by the Free Software Foundation. Oracle designates this |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
8 |
* particular file as subject to the "Classpath" exception as provided |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
9 |
* by Oracle in the LICENSE file that accompanied this code. |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
10 |
* |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
11 |
* This code is distributed in the hope that it will be useful, but WITHOUT |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
12 |
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
13 |
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
14 |
* version 2 for more details (a copy is included in the LICENSE file that |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
15 |
* accompanied this code). |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
16 |
* |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
17 |
* You should have received a copy of the GNU General Public License version |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
18 |
* 2 along with this work; if not, write to the Free Software Foundation, |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
19 |
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
20 |
* |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
21 |
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
22 |
* or visit www.oracle.com if you need additional information or have any |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
23 |
* questions. |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
24 |
*/ |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
25 |
|
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
26 |
package com.sun.tools.doclets.formats.html; |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
27 |
|
24221
2376793dd33b
8038583: [javadoc] Refactor uses of arrays to Collections
ksrini
parents:
22159
diff
changeset
|
28 |
import java.io.IOException; |
2376793dd33b
8038583: [javadoc] Refactor uses of arrays to Collections
ksrini
parents:
22159
diff
changeset
|
29 |
import java.util.List; |
15723
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
30 |
|
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
31 |
import com.sun.javadoc.*; |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
32 |
import com.sun.tools.javac.sym.Profiles; |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
33 |
import com.sun.tools.doclets.formats.html.markup.*; |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
34 |
import com.sun.tools.doclets.internal.toolkit.*; |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
35 |
import com.sun.tools.doclets.internal.toolkit.util.*; |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
36 |
|
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
37 |
/** |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
38 |
* Generate the profile package index for the left-hand frame in the generated output. |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
39 |
* A click on the package name in this frame will update the page in the bottom |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
40 |
* left hand frame with the listing of contents of the clicked profile package. |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
41 |
* |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
42 |
* <p><b>This is NOT part of any supported API. |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
43 |
* If you write code that depends on this, you do so at your own risk. |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
44 |
* This code and its internal interfaces are subject to change or |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
45 |
* deletion without notice.</b> |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
46 |
* |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
47 |
* @author Bhavesh Patel |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
48 |
*/ |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
49 |
public class ProfilePackageIndexFrameWriter extends AbstractProfileIndexWriter { |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
50 |
|
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
51 |
/** |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
52 |
* Construct the ProfilePackageIndexFrameWriter object. |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
53 |
* |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
54 |
* @param configuration the configuration object |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
55 |
* @param filename Name of the package index file to be generated. |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
56 |
*/ |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
57 |
public ProfilePackageIndexFrameWriter(ConfigurationImpl configuration, |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
58 |
DocPath filename) throws IOException { |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
59 |
super(configuration, filename); |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
60 |
} |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
61 |
|
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
62 |
/** |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
63 |
* Generate the profile package index file. |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
64 |
* @throws DocletAbortException |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
65 |
* @param configuration the configuration object |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
66 |
* @param profileName the name of the profile being documented |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
67 |
*/ |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
68 |
public static void generate(ConfigurationImpl configuration, String profileName) { |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
69 |
ProfilePackageIndexFrameWriter profpackgen; |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
70 |
DocPath filename = DocPaths.profileFrame(profileName); |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
71 |
try { |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
72 |
profpackgen = new ProfilePackageIndexFrameWriter(configuration, filename); |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
73 |
profpackgen.buildProfilePackagesIndexFile("doclet.Window_Overview", false, profileName); |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
74 |
profpackgen.close(); |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
75 |
} catch (IOException exc) { |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
76 |
configuration.standardmessage.error( |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
77 |
"doclet.exception_encountered", |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
78 |
exc.toString(), filename); |
19667
fdfce85627a9
8001669: javadoc internal DocletAbortException should set cause when appropriate
jjg
parents:
17570
diff
changeset
|
79 |
throw new DocletAbortException(exc); |
15723
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
80 |
} |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
81 |
} |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
82 |
|
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
83 |
/** |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
84 |
* {@inheritDoc} |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
85 |
*/ |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
86 |
protected void addProfilePackagesList(Profiles profiles, String text, |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
87 |
String tableSummary, Content body, String profileName) { |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
88 |
Content profNameContent = new StringContent(profileName); |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
89 |
Content heading = HtmlTree.HEADING(HtmlConstants.PACKAGE_HEADING, true, |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
90 |
getTargetProfileLink("classFrame", profNameContent, profileName)); |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
91 |
heading.addContent(getSpace()); |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
92 |
heading.addContent(packagesLabel); |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
93 |
Content div = HtmlTree.DIV(HtmlStyle.indexContainer, heading); |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
94 |
HtmlTree ul = new HtmlTree(HtmlTag.UL); |
17570
78512b2899db
8012183: replace some uses of Configuration.getText with Configuration.getResource
jjg
parents:
17560
diff
changeset
|
95 |
ul.setTitle(packagesLabel); |
24221
2376793dd33b
8038583: [javadoc] Refactor uses of arrays to Collections
ksrini
parents:
22159
diff
changeset
|
96 |
List<PackageDoc> packages = configuration.profilePackages.get(profileName); |
22159
682da512ec17
8030253: Update langtools to use strings-in-switch
briangoetz
parents:
19667
diff
changeset
|
97 |
for (PackageDoc packageDoc : packages) { |
25454
376a52c9540c
8039028: [javadoc] refactor the usage of Util.java
ksrini
parents:
25287
diff
changeset
|
98 |
if ((!(configuration.nodeprecated && utils.isDeprecated(packageDoc)))) { |
22159
682da512ec17
8030253: Update langtools to use strings-in-switch
briangoetz
parents:
19667
diff
changeset
|
99 |
ul.addContent(getPackage(packageDoc, profileName)); |
15723
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
100 |
} |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
101 |
} |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
102 |
div.addContent(ul); |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
103 |
body.addContent(div); |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
104 |
} |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
105 |
|
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
106 |
/** |
25287 | 107 |
* Returns each package name as a separate link. |
15723
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
108 |
* |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
109 |
* @param pd PackageDoc |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
110 |
* @param profileName the name of the profile being documented |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
111 |
* @return content for the package link |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
112 |
*/ |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
113 |
protected Content getPackage(PackageDoc pd, String profileName) { |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
114 |
Content packageLinkContent; |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
115 |
Content pkgLabel; |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
116 |
if (pd.name().length() > 0) { |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
117 |
pkgLabel = getPackageLabel(pd.name()); |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
118 |
packageLinkContent = getHyperLink(pathString(pd, |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
119 |
DocPaths.profilePackageFrame(profileName)), pkgLabel, "", |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
120 |
"packageFrame"); |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
121 |
} else { |
17560 | 122 |
pkgLabel = new StringContent("<unnamed package>"); |
15723
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
123 |
packageLinkContent = getHyperLink(DocPaths.PACKAGE_FRAME, |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
124 |
pkgLabel, "", "packageFrame"); |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
125 |
} |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
126 |
Content li = HtmlTree.LI(packageLinkContent); |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
127 |
return li; |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
128 |
} |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
129 |
|
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
130 |
/** |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
131 |
* {@inheritDoc} |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
132 |
*/ |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
133 |
protected void addNavigationBarHeader(Content body) { |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
134 |
Content headerContent; |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
135 |
if (configuration.packagesheader.length() > 0) { |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
136 |
headerContent = new RawHtml(replaceDocRootDir(configuration.packagesheader)); |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
137 |
} else { |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
138 |
headerContent = new RawHtml(replaceDocRootDir(configuration.header)); |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
139 |
} |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
140 |
Content heading = HtmlTree.HEADING(HtmlConstants.TITLE_HEADING, true, |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
141 |
HtmlStyle.bar, headerContent); |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
142 |
body.addContent(heading); |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
143 |
} |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
144 |
|
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
145 |
/** |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
146 |
* Do nothing as there is no overview information in this page. |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
147 |
*/ |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
148 |
protected void addOverviewHeader(Content body) { |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
149 |
} |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
150 |
|
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
151 |
protected void addProfilesList(Profiles profiles, String text, |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
152 |
String tableSummary, Content body) { |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
153 |
} |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
154 |
|
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
155 |
/** |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
156 |
* Adds "All Classes" link for the top of the left-hand frame page to the |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
157 |
* documentation tree. |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
158 |
* |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
159 |
* @param div the Content object to which the all classes link should be added |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
160 |
*/ |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
161 |
protected void addAllClassesLink(Content div) { |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
162 |
Content linkContent = getHyperLink(DocPaths.ALLCLASSES_FRAME, |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
163 |
allclassesLabel, "", "packageFrame"); |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
164 |
Content span = HtmlTree.SPAN(linkContent); |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
165 |
div.addContent(span); |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
166 |
} |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
167 |
|
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
168 |
/** |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
169 |
* Adds "All Packages" link for the top of the left-hand frame page to the |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
170 |
* documentation tree. |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
171 |
* |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
172 |
* @param div the Content object to which the all packages link should be added |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
173 |
*/ |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
174 |
protected void addAllPackagesLink(Content div) { |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
175 |
Content linkContent = getHyperLink(DocPaths.OVERVIEW_FRAME, |
16547
3dd72ee2623d
8009684: Default top left frame should be "All Packages" in the generated javadoc documentation
bpatel
parents:
15723
diff
changeset
|
176 |
allpackagesLabel, "", "packageListFrame"); |
15723
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
177 |
Content span = HtmlTree.SPAN(linkContent); |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
178 |
div.addContent(span); |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
179 |
} |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
180 |
|
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
181 |
/** |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
182 |
* Adds "All Profiles" link for the top of the left-hand frame page to the |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
183 |
* documentation tree. |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
184 |
* |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
185 |
* @param div the Content object to which the all profiles link should be added |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
186 |
*/ |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
187 |
protected void addAllProfilesLink(Content div) { |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
188 |
Content linkContent = getHyperLink(DocPaths.PROFILE_OVERVIEW_FRAME, |
16547
3dd72ee2623d
8009684: Default top left frame should be "All Packages" in the generated javadoc documentation
bpatel
parents:
15723
diff
changeset
|
189 |
allprofilesLabel, "", "packageListFrame"); |
15723
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
190 |
Content span = HtmlTree.SPAN(linkContent); |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
191 |
div.addContent(span); |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
192 |
} |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
193 |
|
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
194 |
/** |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
195 |
* {@inheritDoc} |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
196 |
*/ |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
197 |
protected void addNavigationBarFooter(Content body) { |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
198 |
Content p = HtmlTree.P(getSpace()); |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
199 |
body.addContent(p); |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
200 |
} |
58a73dac9ee4
8006124: javadoc/doclet should be updated to support profiles
bpatel
parents:
diff
changeset
|
201 |
} |