duke@1: /*
duke@1:  * Copyright 1997-2004 Sun Microsystems, Inc.  All Rights Reserved.
duke@1:  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
duke@1:  *
duke@1:  * This code is free software; you can redistribute it and/or modify it
duke@1:  * under the terms of the GNU General Public License version 2 only, as
duke@1:  * published by the Free Software Foundation.  Sun designates this
duke@1:  * particular file as subject to the "Classpath" exception as provided
duke@1:  * by Sun in the LICENSE file that accompanied this code.
duke@1:  *
duke@1:  * This code is distributed in the hope that it will be useful, but WITHOUT
duke@1:  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
duke@1:  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
duke@1:  * version 2 for more details (a copy is included in the LICENSE file that
duke@1:  * accompanied this code).
duke@1:  *
duke@1:  * You should have received a copy of the GNU General Public License version
duke@1:  * 2 along with this work; if not, write to the Free Software Foundation,
duke@1:  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
duke@1:  *
duke@1:  * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
duke@1:  * CA 95054 USA or visit www.sun.com if you need additional information or
duke@1:  * have any questions.
duke@1:  */
duke@1: 
duke@1: package com.sun.tools.doclets.formats.html;
duke@1: 
duke@1: import com.sun.tools.doclets.internal.toolkit.*;
duke@1: import com.sun.tools.doclets.internal.toolkit.util.*;
duke@1: import com.sun.javadoc.*;
duke@1: 
duke@1: import java.io.*;
duke@1: 
duke@1: /**
duke@1:  * Writes nested class documentation in HTML format.
duke@1:  *
duke@1:  * @author Robert Field
duke@1:  * @author Atul M Dambalkar
duke@1:  * @author Jamie Ho (rewrite)
duke@1:  */
duke@1: public class NestedClassWriterImpl extends AbstractMemberWriter
duke@1:     implements MemberSummaryWriter {
duke@1: 
duke@1:     private boolean printedSummaryHeader = false;
duke@1: 
duke@1:     public NestedClassWriterImpl(SubWriterHolderWriter writer,
duke@1:             ClassDoc classdoc) {
duke@1:         super(writer, classdoc);
duke@1:     }
duke@1: 
duke@1:     public NestedClassWriterImpl(SubWriterHolderWriter writer) {
duke@1:         super(writer);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Write the classes summary header for the given class.
duke@1:      *
duke@1:      * @param classDoc the class the summary belongs to.
duke@1:      */
duke@1:     public void writeMemberSummaryHeader(ClassDoc classDoc) {
duke@1:         printedSummaryHeader = true;
duke@1:         writer.println("<!-- ======== NESTED CLASS SUMMARY ======== -->");
duke@1:         writer.println();
duke@1:         writer.printSummaryHeader(this, classDoc);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Write the classes summary footer for the given class.
duke@1:      *
duke@1:      * @param classDoc the class the summary belongs to.
duke@1:      */
duke@1:     public void writeMemberSummaryFooter(ClassDoc classDoc) {
duke@1:         writer.printSummaryFooter(this, classDoc);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Write the inherited classes summary header for the given class.
duke@1:      *
duke@1:      * @param classDoc the class the summary belongs to.
duke@1:      */
duke@1:     public void writeInheritedMemberSummaryHeader(ClassDoc classDoc) {
duke@1:         if(! printedSummaryHeader){
duke@1:             //We don't want inherited summary to not be under heading.
duke@1:             writeMemberSummaryHeader(classDoc);
duke@1:             writeMemberSummaryFooter(classDoc);
duke@1:             printedSummaryHeader = true;
duke@1:         }
duke@1:         writer.printInheritedSummaryHeader(this, classDoc);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * {@inheritDoc}
duke@1:      */
duke@1:     public void writeInheritedMemberSummary(ClassDoc classDoc,
duke@1:             ProgramElementDoc nestedClass, boolean isFirst, boolean isLast) {
duke@1:         writer.printInheritedSummaryMember(this, classDoc, nestedClass, isFirst);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Write the inherited classes summary footer for the given class.
duke@1:      *
duke@1:      * @param classDoc the class the summary belongs to.
duke@1:      */
duke@1:     public void writeInheritedMemberSummaryFooter(ClassDoc classDoc) {
duke@1:         writer.printInheritedSummaryFooter(this, classDoc);
duke@1:         writer.println();
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Write the header for the nested class documentation.
duke@1:      *
duke@1:      * @param classDoc the class that the classes belong to.
duke@1:      */
duke@1:     public void writeHeader(ClassDoc classDoc, String header) {
duke@1:         writer.anchor("nested class_detail");
duke@1:         writer.printTableHeadingBackground(header);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Write the nested class header for the given nested class.
duke@1:      *
duke@1:      * @param nestedClass the nested class being documented.
duke@1:      * @param isFirst the flag to indicate whether or not the nested class is the
duke@1:      *        first to be documented.
duke@1:      */
duke@1:     public void writeClassHeader(ClassDoc nestedClass, boolean isFirst) {
duke@1:         if (! isFirst) {
duke@1:             writer.printMemberHeader();
duke@1:             writer.println("");
duke@1:         }
duke@1:         writer.anchor(nestedClass.name());
duke@1:         writer.dl();
duke@1:         writer.h3();
duke@1:         writer.print(nestedClass.name());
duke@1:         writer.h3End();
duke@1:     }
duke@1: 
duke@1: 
duke@1: 
duke@1:     /**
duke@1:      * Close the writer.
duke@1:      */
duke@1:     public void close() throws IOException {
duke@1:         writer.close();
duke@1:     }
duke@1: 
duke@1:     public int getMemberKind() {
duke@1:         return VisibleMemberMap.INNERCLASSES;
duke@1:     }
duke@1: 
duke@1:     public void printSummaryLabel(ClassDoc cd) {
duke@1:         writer.boldText("doclet.Nested_Class_Summary");
duke@1:     }
duke@1: 
duke@1:     public void printSummaryAnchor(ClassDoc cd) {
duke@1:         writer.anchor("nested_class_summary");
duke@1:     }
duke@1: 
duke@1:     public void printInheritedSummaryAnchor(ClassDoc cd) {
duke@1:         writer.anchor("nested_classes_inherited_from_class_" +
duke@1:                        cd.qualifiedName());
duke@1:     }
duke@1: 
duke@1:     public void printInheritedSummaryLabel(ClassDoc cd) {
duke@1:         String clslink = writer.getPreQualifiedClassLink(
duke@1:             LinkInfoImpl.CONTEXT_MEMBER, cd, false);
duke@1:         writer.bold();
duke@1:         writer.printText(cd.isInterface() ?
duke@1:             "doclet.Nested_Classes_Interface_Inherited_From_Interface" :
duke@1:             "doclet.Nested_Classes_Interfaces_Inherited_From_Class",
duke@1:             clslink);
duke@1:         writer.boldEnd();
duke@1:     }
duke@1: 
duke@1:     protected void writeSummaryLink(int context, ClassDoc cd, ProgramElementDoc member) {
duke@1:         writer.bold();
duke@1:         writer.printLink(new LinkInfoImpl(context, (ClassDoc)member, false));
duke@1:         writer.boldEnd();
duke@1:     }
duke@1: 
duke@1:     protected void writeInheritedSummaryLink(ClassDoc cd,
duke@1:             ProgramElementDoc member) {
duke@1:         writer.printLink(new LinkInfoImpl(LinkInfoImpl.CONTEXT_MEMBER,
duke@1:             (ClassDoc)member, false));
duke@1:     }
duke@1: 
duke@1:     protected void printSummaryType(ProgramElementDoc member) {
duke@1:         ClassDoc cd = (ClassDoc)member;
duke@1:         printModifierAndType(cd, null);
duke@1:     }
duke@1: 
duke@1:     protected void printHeader(ClassDoc cd) {
duke@1:         // N.A.
duke@1:     }
duke@1: 
duke@1:     protected void printBodyHtmlEnd(ClassDoc cd) {
duke@1:         // N.A.
duke@1:     }
duke@1: 
duke@1:     protected void printMember(ProgramElementDoc member) {
duke@1:         // N.A.
duke@1:     }
duke@1: 
duke@1:     protected void writeDeprecatedLink(ProgramElementDoc member) {
duke@1:         writer.printQualifiedClassLink(LinkInfoImpl.CONTEXT_MEMBER,
duke@1:             (ClassDoc)member);
duke@1:     }
duke@1: 
duke@1:     protected void printNavSummaryLink(ClassDoc cd, boolean link) {
duke@1:         if (link) {
duke@1:             writer.printHyperLink("", (cd == null) ? "nested_class_summary":
duke@1:                     "nested_classes_inherited_from_class_" +
duke@1:                 cd.qualifiedName(),
duke@1:                 ConfigurationImpl.getInstance().getText("doclet.navNested"));
duke@1:         } else {
duke@1:             writer.printText("doclet.navNested");
duke@1:         }
duke@1:     }
duke@1: 
duke@1:     protected void printNavDetailLink(boolean link) {
duke@1:     }
duke@1: 
duke@1:     protected void printMemberLink(ProgramElementDoc member) {
duke@1:     }
duke@1: 
duke@1:     protected void printMembersSummaryLink(ClassDoc cd, ClassDoc icd,
duke@1:                                            boolean link) {
duke@1:         if (link) {
duke@1:             writer.printHyperLink(cd.name() + ".html",
duke@1:                 (cd == icd)?
duke@1:                     "nested_class_summary":
duke@1:                     "nested_classes_inherited_from_class_" +
duke@1:                     icd.qualifiedName(),
duke@1:                     ConfigurationImpl.getInstance().getText(
duke@1:                         "doclet.Nested_Class_Summary"));
duke@1:         } else {
duke@1:             writer.printText("doclet.Nested_Class_Summary");
duke@1:         }
duke@1:     }
duke@1: }