aoqi@0: /*
aoqi@0:  * Copyright (c) 1998, 2013, Oracle and/or its affiliates. All rights reserved.
aoqi@0:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
aoqi@0:  *
aoqi@0:  * This code is free software; you can redistribute it and/or modify it
aoqi@0:  * under the terms of the GNU General Public License version 2 only, as
aoqi@0:  * published by the Free Software Foundation.  Oracle designates this
aoqi@0:  * particular file as subject to the "Classpath" exception as provided
aoqi@0:  * by Oracle in the LICENSE file that accompanied this code.
aoqi@0:  *
aoqi@0:  * This code is distributed in the hope that it will be useful, but WITHOUT
aoqi@0:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
aoqi@0:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
aoqi@0:  * version 2 for more details (a copy is included in the LICENSE file that
aoqi@0:  * accompanied this code).
aoqi@0:  *
aoqi@0:  * You should have received a copy of the GNU General Public License version
aoqi@0:  * 2 along with this work; if not, write to the Free Software Foundation,
aoqi@0:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
aoqi@0:  *
aoqi@0:  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
aoqi@0:  * or visit www.oracle.com if you need additional information or have any
aoqi@0:  * questions.
aoqi@0:  */
aoqi@0: 
aoqi@0: package com.sun.tools.doclets.formats.html;
aoqi@0: 
aoqi@0: import java.io.*;
aoqi@0: 
aoqi@0: import com.sun.javadoc.*;
aoqi@0: import com.sun.tools.doclets.formats.html.markup.*;
aoqi@0: import com.sun.tools.doclets.internal.toolkit.*;
aoqi@0: import com.sun.tools.doclets.internal.toolkit.util.*;
aoqi@0: 
aoqi@0: /**
aoqi@0:  * Generate the package index for the left-hand frame in the generated output.
aoqi@0:  * A click on the package name in this frame will update the page in the bottom
aoqi@0:  * left hand frame with the listing of contents of the clicked package.
aoqi@0:  *
aoqi@0:  *  <p><b>This is NOT part of any supported API.
aoqi@0:  *  If you write code that depends on this, you do so at your own risk.
aoqi@0:  *  This code and its internal interfaces are subject to change or
aoqi@0:  *  deletion without notice.</b>
aoqi@0:  *
aoqi@0:  * @author Atul M Dambalkar
aoqi@0:  */
aoqi@0: public class PackageIndexFrameWriter extends AbstractPackageIndexWriter {
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Construct the PackageIndexFrameWriter object.
aoqi@0:      *
aoqi@0:      * @param filename Name of the package index file to be generated.
aoqi@0:      */
aoqi@0:     public PackageIndexFrameWriter(ConfigurationImpl configuration,
aoqi@0:                                    DocPath filename) throws IOException {
aoqi@0:         super(configuration, filename);
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Generate the package index file named "overview-frame.html".
aoqi@0:      * @throws DocletAbortException
aoqi@0:      */
aoqi@0:     public static void generate(ConfigurationImpl configuration) {
aoqi@0:         PackageIndexFrameWriter packgen;
aoqi@0:         DocPath filename = DocPaths.OVERVIEW_FRAME;
aoqi@0:         try {
aoqi@0:             packgen = new PackageIndexFrameWriter(configuration, filename);
aoqi@0:             packgen.buildPackageIndexFile("doclet.Window_Overview", false);
aoqi@0:             packgen.close();
aoqi@0:         } catch (IOException exc) {
aoqi@0:             configuration.standardmessage.error(
aoqi@0:                         "doclet.exception_encountered",
aoqi@0:                         exc.toString(), filename);
aoqi@0:             throw new DocletAbortException(exc);
aoqi@0:         }
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * {@inheritDoc}
aoqi@0:      */
aoqi@0:     protected void addPackagesList(PackageDoc[] packages, String text,
aoqi@0:             String tableSummary, Content body) {
aoqi@0:         Content heading = HtmlTree.HEADING(HtmlConstants.PACKAGE_HEADING, true,
aoqi@0:                 packagesLabel);
aoqi@0:         Content div = HtmlTree.DIV(HtmlStyle.indexContainer, heading);
aoqi@0:         HtmlTree ul = new HtmlTree(HtmlTag.UL);
aoqi@0:         ul.setTitle(packagesLabel);
aoqi@0:         for(int i = 0; i < packages.length; i++) {
aoqi@0:             // Do not list the package if -nodeprecated option is set and the
aoqi@0:             // package is marked as deprecated.
aoqi@0:             if (packages[i] != null &&
aoqi@0:                     (!(configuration.nodeprecated && Util.isDeprecated(packages[i])))) {
aoqi@0:                 ul.addContent(getPackage(packages[i]));
aoqi@0:             }
aoqi@0:         }
aoqi@0:         div.addContent(ul);
aoqi@0:         body.addContent(div);
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Gets each package name as a separate link.
aoqi@0:      *
aoqi@0:      * @param pd PackageDoc
aoqi@0:      * @return content for the package link
aoqi@0:      */
aoqi@0:     protected Content getPackage(PackageDoc pd) {
aoqi@0:         Content packageLinkContent;
aoqi@0:         Content packageLabel;
aoqi@0:         if (pd.name().length() > 0) {
aoqi@0:             packageLabel = getPackageLabel(pd.name());
aoqi@0:             packageLinkContent = getHyperLink(pathString(pd,
aoqi@0:                      DocPaths.PACKAGE_FRAME), packageLabel, "",
aoqi@0:                     "packageFrame");
aoqi@0:         } else {
aoqi@0:             packageLabel = new StringContent("<unnamed package>");
aoqi@0:             packageLinkContent = getHyperLink(DocPaths.PACKAGE_FRAME,
aoqi@0:                     packageLabel, "", "packageFrame");
aoqi@0:         }
aoqi@0:         Content li = HtmlTree.LI(packageLinkContent);
aoqi@0:         return li;
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * {@inheritDoc}
aoqi@0:      */
aoqi@0:     protected void addNavigationBarHeader(Content body) {
aoqi@0:         Content headerContent;
aoqi@0:         if (configuration.packagesheader.length() > 0) {
aoqi@0:             headerContent = new RawHtml(replaceDocRootDir(configuration.packagesheader));
aoqi@0:         } else {
aoqi@0:             headerContent = new RawHtml(replaceDocRootDir(configuration.header));
aoqi@0:         }
aoqi@0:         Content heading = HtmlTree.HEADING(HtmlConstants.TITLE_HEADING, true,
aoqi@0:                 HtmlStyle.bar, headerContent);
aoqi@0:         body.addContent(heading);
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Do nothing as there is no overview information in this page.
aoqi@0:      */
aoqi@0:     protected void addOverviewHeader(Content body) {
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Adds "All Classes" link for the top of the left-hand frame page to the
aoqi@0:      * documentation tree.
aoqi@0:      *
aoqi@0:      * @param div the Content object to which the all classes link should be added
aoqi@0:      */
aoqi@0:     protected void addAllClassesLink(Content div) {
aoqi@0:         Content linkContent = getHyperLink(DocPaths.ALLCLASSES_FRAME,
aoqi@0:                 allclassesLabel, "", "packageFrame");
aoqi@0:         Content span = HtmlTree.SPAN(linkContent);
aoqi@0:         div.addContent(span);
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Adds "All Profiles" link for the top of the left-hand frame page to the
aoqi@0:      * documentation tree.
aoqi@0:      *
aoqi@0:      * @param div the Content object to which the all profiles link should be added
aoqi@0:      */
aoqi@0:     protected void addAllProfilesLink(Content div) {
aoqi@0:         Content linkContent = getHyperLink(DocPaths.PROFILE_OVERVIEW_FRAME,
aoqi@0:                 allprofilesLabel, "", "packageListFrame");
aoqi@0:         Content span = HtmlTree.SPAN(linkContent);
aoqi@0:         div.addContent(span);
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * {@inheritDoc}
aoqi@0:      */
aoqi@0:     protected void addNavigationBarFooter(Content body) {
aoqi@0:         Content p = HtmlTree.P(getSpace());
aoqi@0:         body.addContent(p);
aoqi@0:     }
aoqi@0: }