| /* |
| * Copyright (c) 1997, 2014, Oracle and/or its affiliates. All rights reserved. |
| * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
| * |
| * This code is free software; you can redistribute it and/or modify it |
| * under the terms of the GNU General Public License version 2 only, as |
| * published by the Free Software Foundation. Oracle designates this |
| * particular file as subject to the "Classpath" exception as provided |
| * by Oracle in the LICENSE file that accompanied this code. |
| * |
| * This code is distributed in the hope that it will be useful, but WITHOUT |
| * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
| * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
| * version 2 for more details (a copy is included in the LICENSE file that |
| * accompanied this code). |
| * |
| * You should have received a copy of the GNU General Public License version |
| * 2 along with this work; if not, write to the Free Software Foundation, |
| * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
| * |
| * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA |
| * or visit www.oracle.com if you need additional information or have any |
| * questions. |
| */ |
| |
| package com.sun.tools.doclets.formats.html; |
| |
| import java.io.*; |
| |
| import com.sun.tools.doclets.formats.html.markup.*; |
| import com.sun.tools.doclets.internal.toolkit.*; |
| import com.sun.tools.doclets.internal.toolkit.util.*; |
| |
| /** |
| * Generate the documentation in the Html "frame" format in the browser. The |
| * generated documentation will have two or three frames depending upon the |
| * number of packages on the command line. In general there will be three frames |
| * in the output, a left-hand top frame will have a list of all packages with |
| * links to target left-hand bottom frame. The left-hand bottom frame will have |
| * the particular package contents or the all-classes list, where as the single |
| * right-hand frame will have overview or package summary or class file. Also |
| * take care of browsers which do not support Html frames. |
| * |
| * <p><b>This is NOT part of any supported API. |
| * If you write code that depends on this, you do so at your own risk. |
| * This code and its internal interfaces are subject to change or |
| * deletion without notice.</b> |
| * |
| * @author Atul M Dambalkar |
| */ |
| public class FrameOutputWriter extends HtmlDocletWriter { |
| |
| /** |
| * Number of packages specified on the command line. |
| */ |
| int noOfPackages; |
| |
| private final String SCROLL_YES = "yes"; |
| |
| /** |
| * Constructor to construct FrameOutputWriter object. |
| * |
| * @param filename File to be generated. |
| */ |
| public FrameOutputWriter(ConfigurationImpl configuration, |
| DocPath filename) throws IOException { |
| super(configuration, filename); |
| noOfPackages = configuration.packages.size(); |
| } |
| |
| /** |
| * Construct FrameOutputWriter object and then use it to generate the Html |
| * file which will have the description of all the frames in the |
| * documentation. The name of the generated file is "index.html" which is |
| * the default first file for Html documents. |
| * @throws DocletAbortException |
| */ |
| public static void generate(ConfigurationImpl configuration) { |
| FrameOutputWriter framegen; |
| DocPath filename = DocPath.empty; |
| try { |
| filename = DocPaths.INDEX; |
| framegen = new FrameOutputWriter(configuration, filename); |
| framegen.generateFrameFile(); |
| framegen.close(); |
| } catch (IOException exc) { |
| configuration.standardmessage.error( |
| "doclet.exception_encountered", |
| exc.toString(), filename); |
| throw new DocletAbortException(exc); |
| } |
| } |
| |
| /** |
| * Generate the constants in the "index.html" file. Print the frame details |
| * as well as warning if browser is not supporting the Html frames. |
| */ |
| protected void generateFrameFile() throws IOException { |
| Content frameset = getFrameDetails(); |
| if (configuration.windowtitle.length() > 0) { |
| printFramesetDocument(configuration.windowtitle, configuration.notimestamp, |
| frameset); |
| } else { |
| printFramesetDocument(configuration.getText("doclet.Generated_Docs_Untitled"), |
| configuration.notimestamp, frameset); |
| } |
| } |
| |
| /** |
| * Add the code for issueing the warning for a non-frame capable web |
| * client. Also provide links to the non-frame version documentation. |
| * |
| * @param contentTree the content tree to which the non-frames information will be added |
| */ |
| protected void addFrameWarning(Content contentTree) { |
| Content noframes = new HtmlTree(HtmlTag.NOFRAMES); |
| Content noScript = HtmlTree.NOSCRIPT( |
| HtmlTree.DIV(getResource("doclet.No_Script_Message"))); |
| noframes.addContent(noScript); |
| Content noframesHead = HtmlTree.HEADING(HtmlConstants.CONTENT_HEADING, |
| getResource("doclet.Frame_Alert")); |
| noframes.addContent(noframesHead); |
| Content p = HtmlTree.P(getResource("doclet.Frame_Warning_Message", |
| getHyperLink(configuration.topFile, |
| configuration.getText("doclet.Non_Frame_Version")))); |
| noframes.addContent(p); |
| contentTree.addContent(noframes); |
| } |
| |
| /** |
| * Get the frame sizes and their contents. |
| * |
| * @return a content tree for the frame details |
| */ |
| protected Content getFrameDetails() { |
| HtmlTree frameset = HtmlTree.FRAMESET("20%,80%", null, "Documentation frame", |
| "top.loadFrames()"); |
| if (noOfPackages <= 1) { |
| addAllClassesFrameTag(frameset); |
| } else if (noOfPackages > 1) { |
| HtmlTree leftFrameset = HtmlTree.FRAMESET(null, "30%,70%", "Left frames", |
| "top.loadFrames()"); |
| addAllPackagesFrameTag(leftFrameset); |
| addAllClassesFrameTag(leftFrameset); |
| frameset.addContent(leftFrameset); |
| } |
| addClassFrameTag(frameset); |
| addFrameWarning(frameset); |
| return frameset; |
| } |
| |
| /** |
| * Add the FRAME tag for the frame that lists all packages. |
| * |
| * @param contentTree the content tree to which the information will be added |
| */ |
| private void addAllPackagesFrameTag(Content contentTree) { |
| HtmlTree frame = HtmlTree.FRAME(DocPaths.OVERVIEW_FRAME.getPath(), |
| "packageListFrame", configuration.getText("doclet.All_Packages")); |
| contentTree.addContent(frame); |
| } |
| |
| /** |
| * Add the FRAME tag for the frame that lists all classes. |
| * |
| * @param contentTree the content tree to which the information will be added |
| */ |
| private void addAllClassesFrameTag(Content contentTree) { |
| HtmlTree frame = HtmlTree.FRAME(DocPaths.ALLCLASSES_FRAME.getPath(), |
| "packageFrame", configuration.getText("doclet.All_classes_and_interfaces")); |
| contentTree.addContent(frame); |
| } |
| |
| /** |
| * Add the FRAME tag for the frame that describes the class in detail. |
| * |
| * @param contentTree the content tree to which the information will be added |
| */ |
| private void addClassFrameTag(Content contentTree) { |
| HtmlTree frame = HtmlTree.FRAME(configuration.topFile.getPath(), "classFrame", |
| configuration.getText("doclet.Package_class_and_interface_descriptions"), |
| SCROLL_YES); |
| contentTree.addContent(frame); |
| } |
| } |
