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.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 only one index file for all the Member Names with Indexing in
aoqi@0:  * Unicode Order. The name of the generated file is "index-all.html" and it is
aoqi@0:  * generated in current or the destination directory.
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:  * @see java.lang.Character
aoqi@0:  * @author Atul M Dambalkar
aoqi@0:  * @author Bhavesh Patel (Modified)
aoqi@0:  */
aoqi@0: public class SingleIndexWriter extends AbstractIndexWriter {
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Construct the SingleIndexWriter with filename "index-all.html" and the
aoqi@0:      * {@link IndexBuilder}
aoqi@0:      *
aoqi@0:      * @param filename     Name of the index file to be generated.
aoqi@0:      * @param indexbuilder Unicode based Index from {@link IndexBuilder}
aoqi@0:      */
aoqi@0:     public SingleIndexWriter(ConfigurationImpl configuration,
aoqi@0:                              DocPath filename,
aoqi@0:                              IndexBuilder indexbuilder) throws IOException {
aoqi@0:         super(configuration, filename, indexbuilder);
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Generate single index file, for all Unicode characters.
aoqi@0:      *
aoqi@0:      * @param indexbuilder IndexBuilder built by {@link IndexBuilder}
aoqi@0:      * @throws DocletAbortException
aoqi@0:      */
aoqi@0:     public static void generate(ConfigurationImpl configuration,
aoqi@0:                                 IndexBuilder indexbuilder) {
aoqi@0:         SingleIndexWriter indexgen;
aoqi@0:         DocPath filename = DocPaths.INDEX_ALL;
aoqi@0:         try {
aoqi@0:             indexgen = new SingleIndexWriter(configuration,
aoqi@0:                                              filename, indexbuilder);
aoqi@0:             indexgen.generateIndexFile();
aoqi@0:             indexgen.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:      * Generate the contents of each index file, with Header, Footer,
aoqi@0:      * Member Field, Method and Constructor Description.
aoqi@0:      */
aoqi@0:     protected void generateIndexFile() throws IOException {
aoqi@0:         String title = configuration.getText("doclet.Window_Single_Index");
aoqi@0:         Content body = getBody(true, getWindowTitle(title));
aoqi@0:         addTop(body);
aoqi@0:         addNavLinks(true, body);
aoqi@0:         HtmlTree divTree = new HtmlTree(HtmlTag.DIV);
aoqi@0:         divTree.addStyle(HtmlStyle.contentContainer);
aoqi@0:         addLinksForIndexes(divTree);
aoqi@0:         for (int i = 0; i < indexbuilder.elements().length; i++) {
aoqi@0:             Character unicode = (Character)((indexbuilder.elements())[i]);
aoqi@0:             addContents(unicode, indexbuilder.getMemberList(unicode), divTree);
aoqi@0:         }
aoqi@0:         addLinksForIndexes(divTree);
aoqi@0:         body.addContent(divTree);
aoqi@0:         addNavLinks(false, body);
aoqi@0:         addBottom(body);
aoqi@0:         printHtmlDocument(null, true, body);
aoqi@0:     }
aoqi@0: 
aoqi@0:     /**
aoqi@0:      * Add links for all the Index Files per unicode character.
aoqi@0:      *
aoqi@0:      * @param contentTree the content tree to which the links for indexes will be added
aoqi@0:      */
aoqi@0:     protected void addLinksForIndexes(Content contentTree) {
aoqi@0:         for (int i = 0; i < indexbuilder.elements().length; i++) {
aoqi@0:             String unicode = (indexbuilder.elements())[i].toString();
aoqi@0:             contentTree.addContent(
aoqi@0:                     getHyperLink(getNameForIndex(unicode),
aoqi@0:                     new StringContent(unicode)));
aoqi@0:             contentTree.addContent(getSpace());
aoqi@0:         }
aoqi@0:     }
aoqi@0: }