langtools/src/share/classes/com/sun/tools/doclets/formats/html/SerializedFormWriterImpl.java
changeset 10 06bc494ca11e
child 1787 1aa079321cd2
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/langtools/src/share/classes/com/sun/tools/doclets/formats/html/SerializedFormWriterImpl.java	Sat Dec 01 00:00:00 2007 +0000
@@ -0,0 +1,166 @@
+/*
+ * Copyright 1998-2005 Sun Microsystems, Inc.  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.  Sun designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Sun 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 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
+ * CA 95054 USA or visit www.sun.com if you need additional information or
+ * have any questions.
+ */
+
+package com.sun.tools.doclets.formats.html;
+
+import com.sun.javadoc.*;
+import java.io.*;
+
+/**
+ * Generate the Serialized Form Information Page.
+ *
+ * @author Atul M Dambalkar
+ */
+public class SerializedFormWriterImpl extends SubWriterHolderWriter
+    implements com.sun.tools.doclets.internal.toolkit.SerializedFormWriter {
+
+    private static final String FILE_NAME = "serialized-form.html";
+
+    /**
+     * @throws IOException
+     * @throws DocletAbortException
+     */
+    public SerializedFormWriterImpl() throws IOException {
+        super(ConfigurationImpl.getInstance(), FILE_NAME);
+    }
+
+    /**
+     * Writes the given header.
+     *
+     * @param header the header to write.
+     */
+    public void writeHeader(String header) {
+        printHtmlHeader(header, null, true);
+        printTop();
+        navLinks(true);
+        hr();
+        center();
+        h1();
+        print(header);
+        h1End();
+        centerEnd();
+    }
+
+    /**
+     * Write the given package header.
+     *
+     * @param packageName the package header to write.
+     */
+    public void writePackageHeader(String packageName) {
+        hr(4, "noshade");
+        tableHeader();
+        thAlign("center");
+        font("+2");
+        boldText("doclet.Package");
+        print(' ');
+        bold(packageName);
+        tableFooter();
+    }
+
+    /**
+     * Write the serial UID info.
+     *
+     * @param header the header that will show up before the UID.
+     * @param serialUID the serial UID to print.
+     */
+    public void writeSerialUIDInfo(String header, String serialUID) {
+        bold(header + " ");
+        println(serialUID);
+        p();
+    }
+
+    /**
+     * Write the footer.
+     */
+    public void writeFooter() {
+        p();
+        hr();
+        navLinks(false);
+        printBottom();
+        printBodyHtmlEnd();
+    }
+
+
+    /**
+     * Write the serializable class heading.
+     *
+     * @param classDoc the class being processed.
+     */
+    public void writeClassHeader(ClassDoc classDoc) {
+        String classLink = (classDoc.isPublic() || classDoc.isProtected())?
+            getLink(new LinkInfoImpl(classDoc,
+                configuration.getClassName(classDoc))):
+            classDoc.qualifiedName();
+        p();
+        anchor(classDoc.qualifiedName());
+        String superClassLink =
+            classDoc.superclassType() != null ?
+                getLink(new LinkInfoImpl(LinkInfoImpl.CONTEXT_SERIALIZED_FORM,
+                    classDoc.superclassType())) :
+                null;
+
+        //Print the heading.
+        String className = superClassLink == null ?
+            configuration.getText(
+                "doclet.Class_0_implements_serializable", classLink) :
+            configuration.getText(
+                "doclet.Class_0_extends_implements_serializable", classLink,
+                    superClassLink);
+        tableHeader();
+        thAlignColspan("left", 2);
+        font("+2");
+        bold(className);
+        tableFooter();
+        p();
+    }
+
+    private void tableHeader() {
+        tableIndexSummary();
+        trBgcolorStyle("#CCCCFF", "TableSubHeadingColor");
+    }
+
+    private void tableFooter() {
+        fontEnd();
+        thEnd(); trEnd(); tableEnd();
+    }
+
+    /**
+     * Return an instance of a SerialFieldWriter.
+     *
+     * @return an instance of a SerialFieldWriter.
+     */
+    public SerialFieldWriter getSerialFieldWriter(ClassDoc classDoc) {
+        return new HtmlSerialFieldWriter(this, classDoc);
+    }
+
+    /**
+     * Return an instance of a SerialMethodWriter.
+     *
+     * @return an instance of a SerialMethodWriter.
+     */
+    public SerialMethodWriter getSerialMethodWriter(ClassDoc classDoc) {
+        return new HtmlSerialMethodWriter(this, classDoc);
+    }
+}