Mercurial > jdk8-mips64-public > langtools / annotate
src/share/classes/com/sun/tools/doclets/formats/html/ProfileIndexFrameWriter.java@e468915bad3a (annotated)
src/share/classes/com/sun/tools/doclets/formats/html/ProfileIndexFrameWriter.java
Thu, 24 May 2018 18:02:46 +0800
- author
- aoqi
- date
- Thu, 24 May 2018 18:02:46 +0800
- changeset 3446
- e468915bad3a
- parent 2525
- 2eb010b6cb22
- permissions
- -rw-r--r--
Merge
| aoqi@0 | 1 | /* |
| aoqi@0 | 2 | * Copyright (c) 2013, Oracle and/or its affiliates. All rights reserved. |
| aoqi@0 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| aoqi@0 | 4 | * |
| aoqi@0 | 5 | * This code is free software; you can redistribute it and/or modify it |
| aoqi@0 | 6 | * under the terms of the GNU General Public License version 2 only, as |
| aoqi@0 | 7 | * published by the Free Software Foundation. Oracle designates this |
| aoqi@0 | 8 | * particular file as subject to the "Classpath" exception as provided |
| aoqi@0 | 9 | * by Oracle in the LICENSE file that accompanied this code. |
| aoqi@0 | 10 | * |
| aoqi@0 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
| aoqi@0 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| aoqi@0 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| aoqi@0 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
| aoqi@0 | 15 | * accompanied this code). |
| aoqi@0 | 16 | * |
| aoqi@0 | 17 | * You should have received a copy of the GNU General Public License version |
| aoqi@0 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
| aoqi@0 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| aoqi@0 | 20 | * |
| aoqi@0 | 21 | * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| aoqi@0 | 22 | * or visit www.oracle.com if you need additional information or have any |
| aoqi@0 | 23 | * questions. |
| aoqi@0 | 24 | */ |
| aoqi@0 | 25 | |
| aoqi@0 | 26 | package com.sun.tools.doclets.formats.html; |
| aoqi@0 | 27 | |
| aoqi@0 | 28 | import java.io.*; |
| aoqi@0 | 29 | |
| aoqi@0 | 30 | import com.sun.tools.javac.sym.Profiles; |
| aoqi@0 | 31 | import com.sun.tools.doclets.formats.html.markup.*; |
| aoqi@0 | 32 | import com.sun.tools.doclets.internal.toolkit.*; |
| aoqi@0 | 33 | import com.sun.tools.doclets.internal.toolkit.util.*; |
| aoqi@0 | 34 | import com.sun.tools.javac.jvm.Profile; |
| aoqi@0 | 35 | |
| aoqi@0 | 36 | /** |
| aoqi@0 | 37 | * Generate the profile index for the left-hand frame in the generated output. |
| aoqi@0 | 38 | * A click on the profile name in this frame will update the page in the top |
| aoqi@0 | 39 | * left hand frame with the listing of packages of the clicked profile. |
| aoqi@0 | 40 | * |
| aoqi@0 | 41 | * <p><b>This is NOT part of any supported API. |
| aoqi@0 | 42 | * If you write code that depends on this, you do so at your own risk. |
| aoqi@0 | 43 | * This code and its internal interfaces are subject to change or |
| aoqi@0 | 44 | * deletion without notice.</b> |
| aoqi@0 | 45 | * |
| aoqi@0 | 46 | * @author Bhavesh Patel |
| aoqi@0 | 47 | */ |
| aoqi@0 | 48 | public class ProfileIndexFrameWriter extends AbstractProfileIndexWriter { |
| aoqi@0 | 49 | |
| aoqi@0 | 50 | /** |
| aoqi@0 | 51 | * Construct the ProfileIndexFrameWriter object. |
| aoqi@0 | 52 | * |
| aoqi@0 | 53 | * @param configuration the configuration object |
| aoqi@0 | 54 | * @param filename Name of the profile index file to be generated. |
| aoqi@0 | 55 | */ |
| aoqi@0 | 56 | public ProfileIndexFrameWriter(ConfigurationImpl configuration, |
| aoqi@0 | 57 | DocPath filename) throws IOException { |
| aoqi@0 | 58 | super(configuration, filename); |
| aoqi@0 | 59 | } |
| aoqi@0 | 60 | |
| aoqi@0 | 61 | /** |
| aoqi@0 | 62 | * Generate the profile index file named "profile-overview-frame.html". |
| aoqi@0 | 63 | * @throws DocletAbortException |
| aoqi@0 | 64 | * @param configuration the configuration object |
| aoqi@0 | 65 | */ |
| aoqi@0 | 66 | public static void generate(ConfigurationImpl configuration) { |
| aoqi@0 | 67 | ProfileIndexFrameWriter profilegen; |
| aoqi@0 | 68 | DocPath filename = DocPaths.PROFILE_OVERVIEW_FRAME; |
| aoqi@0 | 69 | try { |
| aoqi@0 | 70 | profilegen = new ProfileIndexFrameWriter(configuration, filename); |
| aoqi@0 | 71 | profilegen.buildProfileIndexFile("doclet.Window_Overview", false); |
| aoqi@0 | 72 | profilegen.close(); |
| aoqi@0 | 73 | } catch (IOException exc) { |
| aoqi@0 | 74 | configuration.standardmessage.error( |
| aoqi@0 | 75 | "doclet.exception_encountered", |
| aoqi@0 | 76 | exc.toString(), filename); |
| aoqi@0 | 77 | throw new DocletAbortException(exc); |
| aoqi@0 | 78 | } |
| aoqi@0 | 79 | } |
| aoqi@0 | 80 | |
| aoqi@0 | 81 | /** |
| aoqi@0 | 82 | * {@inheritDoc} |
| aoqi@0 | 83 | */ |
| aoqi@0 | 84 | protected void addProfilesList(Profiles profiles, String text, |
| aoqi@0 | 85 | String tableSummary, Content body) { |
| aoqi@0 | 86 | Content heading = HtmlTree.HEADING(HtmlConstants.PROFILE_HEADING, true, |
| aoqi@0 | 87 | profilesLabel); |
| aoqi@0 | 88 | Content div = HtmlTree.DIV(HtmlStyle.indexContainer, heading); |
| aoqi@0 | 89 | HtmlTree ul = new HtmlTree(HtmlTag.UL); |
| aoqi@0 | 90 | ul.setTitle(profilesLabel); |
| aoqi@0 | 91 | String profileName; |
| aoqi@0 | 92 | for (int i = 1; i < profiles.getProfileCount(); i++) { |
| aoqi@0 | 93 | profileName = (Profile.lookup(i)).name; |
| aoqi@0 | 94 | // If the profile has valid packages to be documented, add it to the |
| aoqi@0 | 95 | // left-frame generated for profile index. |
| aoqi@0 | 96 | if (configuration.shouldDocumentProfile(profileName)) |
| aoqi@0 | 97 | ul.addContent(getProfile(profileName)); |
| aoqi@0 | 98 | } |
| aoqi@0 | 99 | div.addContent(ul); |
| aoqi@0 | 100 | body.addContent(div); |
| aoqi@0 | 101 | } |
| aoqi@0 | 102 | |
| aoqi@0 | 103 | /** |
| aoqi@0 | 104 | * Gets each profile name as a separate link. |
| aoqi@0 | 105 | * |
| aoqi@0 | 106 | * @param profileName the profile being documented |
| aoqi@0 | 107 | * @return content for the profile link |
| aoqi@0 | 108 | */ |
| aoqi@0 | 109 | protected Content getProfile(String profileName) { |
| aoqi@0 | 110 | Content profileLinkContent; |
| aoqi@0 | 111 | Content profileLabel; |
| aoqi@0 | 112 | profileLabel = new StringContent(profileName); |
| aoqi@0 | 113 | profileLinkContent = getHyperLink(DocPaths.profileFrame(profileName), profileLabel, "", |
| aoqi@0 | 114 | "packageListFrame"); |
| aoqi@0 | 115 | Content li = HtmlTree.LI(profileLinkContent); |
| aoqi@0 | 116 | return li; |
| aoqi@0 | 117 | } |
| aoqi@0 | 118 | |
| aoqi@0 | 119 | /** |
| aoqi@0 | 120 | * {@inheritDoc} |
| aoqi@0 | 121 | */ |
| aoqi@0 | 122 | protected void addNavigationBarHeader(Content body) { |
| aoqi@0 | 123 | Content headerContent; |
| aoqi@0 | 124 | if (configuration.packagesheader.length() > 0) { |
| aoqi@0 | 125 | headerContent = new RawHtml(replaceDocRootDir(configuration.packagesheader)); |
| aoqi@0 | 126 | } else { |
| aoqi@0 | 127 | headerContent = new RawHtml(replaceDocRootDir(configuration.header)); |
| aoqi@0 | 128 | } |
| aoqi@0 | 129 | Content heading = HtmlTree.HEADING(HtmlConstants.TITLE_HEADING, true, |
| aoqi@0 | 130 | HtmlStyle.bar, headerContent); |
| aoqi@0 | 131 | body.addContent(heading); |
| aoqi@0 | 132 | } |
| aoqi@0 | 133 | |
| aoqi@0 | 134 | /** |
| aoqi@0 | 135 | * Do nothing as there is no overview information in this page. |
| aoqi@0 | 136 | */ |
| aoqi@0 | 137 | protected void addOverviewHeader(Content body) { |
| aoqi@0 | 138 | } |
| aoqi@0 | 139 | |
| aoqi@0 | 140 | /** |
| aoqi@0 | 141 | * Adds "All Classes" link for the top of the left-hand frame page to the |
| aoqi@0 | 142 | * documentation tree. |
| aoqi@0 | 143 | * |
| aoqi@0 | 144 | * @param div the Content object to which the all classes link should be added |
| aoqi@0 | 145 | */ |
| aoqi@0 | 146 | protected void addAllClassesLink(Content div) { |
| aoqi@0 | 147 | Content linkContent = getHyperLink(DocPaths.ALLCLASSES_FRAME, |
| aoqi@0 | 148 | allclassesLabel, "", "packageFrame"); |
| aoqi@0 | 149 | Content span = HtmlTree.SPAN(linkContent); |
| aoqi@0 | 150 | div.addContent(span); |
| aoqi@0 | 151 | } |
| aoqi@0 | 152 | |
| aoqi@0 | 153 | /** |
| aoqi@0 | 154 | * Adds "All Packages" link for the top of the left-hand frame page to the |
| aoqi@0 | 155 | * documentation tree. |
| aoqi@0 | 156 | * |
| aoqi@0 | 157 | * @param div the Content object to which the all packages link should be added |
| aoqi@0 | 158 | */ |
| aoqi@0 | 159 | protected void addAllPackagesLink(Content div) { |
| aoqi@0 | 160 | Content linkContent = getHyperLink(DocPaths.OVERVIEW_FRAME, |
| aoqi@0 | 161 | allpackagesLabel, "", "packageListFrame"); |
| aoqi@0 | 162 | Content span = HtmlTree.SPAN(linkContent); |
| aoqi@0 | 163 | div.addContent(span); |
| aoqi@0 | 164 | } |
| aoqi@0 | 165 | |
| aoqi@0 | 166 | /** |
| aoqi@0 | 167 | * {@inheritDoc} |
| aoqi@0 | 168 | */ |
| aoqi@0 | 169 | protected void addNavigationBarFooter(Content body) { |
| aoqi@0 | 170 | Content p = HtmlTree.P(getSpace()); |
| aoqi@0 | 171 | body.addContent(p); |
| aoqi@0 | 172 | } |
| aoqi@0 | 173 | |
| aoqi@0 | 174 | protected void addProfilePackagesList(Profiles profiles, String text, |
| aoqi@0 | 175 | String tableSummary, Content body, String profileName) { |
| aoqi@0 | 176 | } |
| aoqi@0 | 177 | } |
