duke@1: /*
duke@1:  * Copyright 1998-2005 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.javadoc.*;
duke@1: import java.io.*;
duke@1: 
duke@1: /**
duke@1:  * Generate the Serialized Form Information Page.
duke@1:  *
duke@1:  * @author Atul M Dambalkar
duke@1:  */
duke@1: public class SerializedFormWriterImpl extends SubWriterHolderWriter
duke@1:     implements com.sun.tools.doclets.internal.toolkit.SerializedFormWriter {
duke@1: 
duke@1:     private static final String FILE_NAME = "serialized-form.html";
duke@1: 
duke@1:     /**
duke@1:      * @throws IOException
duke@1:      * @throws DocletAbortException
duke@1:      */
duke@1:     public SerializedFormWriterImpl() throws IOException {
duke@1:         super(ConfigurationImpl.getInstance(), FILE_NAME);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Writes the given header.
duke@1:      *
duke@1:      * @param header the header to write.
duke@1:      */
duke@1:     public void writeHeader(String header) {
duke@1:         printHtmlHeader(header, null, true);
duke@1:         printTop();
duke@1:         navLinks(true);
duke@1:         hr();
duke@1:         center();
duke@1:         h1();
duke@1:         print(header);
duke@1:         h1End();
duke@1:         centerEnd();
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Write the given package header.
duke@1:      *
duke@1:      * @param packageName the package header to write.
duke@1:      */
duke@1:     public void writePackageHeader(String packageName) {
duke@1:         hr(4, "noshade");
duke@1:         tableHeader();
duke@1:         thAlign("center");
duke@1:         font("+2");
bpatel@182:         strongText("doclet.Package");
duke@1:         print(' ');
bpatel@182:         strong(packageName);
duke@1:         tableFooter();
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Write the serial UID info.
duke@1:      *
duke@1:      * @param header the header that will show up before the UID.
duke@1:      * @param serialUID the serial UID to print.
duke@1:      */
duke@1:     public void writeSerialUIDInfo(String header, String serialUID) {
bpatel@182:         strong(header + " ");
duke@1:         println(serialUID);
duke@1:         p();
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Write the footer.
duke@1:      */
duke@1:     public void writeFooter() {
duke@1:         p();
duke@1:         hr();
duke@1:         navLinks(false);
duke@1:         printBottom();
duke@1:         printBodyHtmlEnd();
duke@1:     }
duke@1: 
duke@1: 
duke@1:     /**
duke@1:      * Write the serializable class heading.
duke@1:      *
duke@1:      * @param classDoc the class being processed.
duke@1:      */
duke@1:     public void writeClassHeader(ClassDoc classDoc) {
duke@1:         String classLink = (classDoc.isPublic() || classDoc.isProtected())?
duke@1:             getLink(new LinkInfoImpl(classDoc,
duke@1:                 configuration.getClassName(classDoc))):
duke@1:             classDoc.qualifiedName();
duke@1:         p();
duke@1:         anchor(classDoc.qualifiedName());
duke@1:         String superClassLink =
duke@1:             classDoc.superclassType() != null ?
duke@1:                 getLink(new LinkInfoImpl(LinkInfoImpl.CONTEXT_SERIALIZED_FORM,
duke@1:                     classDoc.superclassType())) :
duke@1:                 null;
duke@1: 
duke@1:         //Print the heading.
duke@1:         String className = superClassLink == null ?
duke@1:             configuration.getText(
duke@1:                 "doclet.Class_0_implements_serializable", classLink) :
duke@1:             configuration.getText(
duke@1:                 "doclet.Class_0_extends_implements_serializable", classLink,
duke@1:                     superClassLink);
duke@1:         tableHeader();
duke@1:         thAlignColspan("left", 2);
duke@1:         font("+2");
bpatel@182:         strong(className);
duke@1:         tableFooter();
duke@1:         p();
duke@1:     }
duke@1: 
duke@1:     private void tableHeader() {
duke@1:         tableIndexSummary();
duke@1:         trBgcolorStyle("#CCCCFF", "TableSubHeadingColor");
duke@1:     }
duke@1: 
duke@1:     private void tableFooter() {
duke@1:         fontEnd();
duke@1:         thEnd(); trEnd(); tableEnd();
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Return an instance of a SerialFieldWriter.
duke@1:      *
duke@1:      * @return an instance of a SerialFieldWriter.
duke@1:      */
duke@1:     public SerialFieldWriter getSerialFieldWriter(ClassDoc classDoc) {
duke@1:         return new HtmlSerialFieldWriter(this, classDoc);
duke@1:     }
duke@1: 
duke@1:     /**
duke@1:      * Return an instance of a SerialMethodWriter.
duke@1:      *
duke@1:      * @return an instance of a SerialMethodWriter.
duke@1:      */
duke@1:     public SerialMethodWriter getSerialMethodWriter(ClassDoc classDoc) {
duke@1:         return new HtmlSerialMethodWriter(this, classDoc);
duke@1:     }
duke@1: }