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.javadoc.*; duke@1: import com.sun.tools.doclets.internal.toolkit.util.*; duke@1: duke@1: import java.io.*; duke@1: duke@1: /** duke@1: * This abstract class exists to provide functionality needed in the duke@1: * the formatting of member information. Since AbstractSubWriter and its duke@1: * subclasses control this, they would be the logical place to put this. duke@1: * However, because each member type has its own subclass, subclassing duke@1: * can not be used effectively to change formatting. The concrete duke@1: * class subclass of this class can be subclassed to change formatting. duke@1: * duke@1: * @see AbstractMemberWriter duke@1: * @see ClassWriterImpl duke@1: * duke@1: * @author Robert Field duke@1: * @author Atul M Dambalkar duke@1: */ duke@1: public abstract class SubWriterHolderWriter extends HtmlDocletWriter { duke@1: duke@1: public SubWriterHolderWriter(ConfigurationImpl configuration, duke@1: String filename) throws IOException { duke@1: super(configuration, filename); duke@1: } duke@1: duke@1: duke@1: public SubWriterHolderWriter(ConfigurationImpl configuration, duke@1: String path, String filename, String relpath) duke@1: throws IOException { duke@1: super(configuration, path, filename, relpath); duke@1: } duke@1: duke@1: public void printTypeSummaryHeader() { duke@1: tdIndex(); duke@1: font("-1"); duke@1: code(); duke@1: } duke@1: duke@1: public void printTypeSummaryFooter() { duke@1: codeEnd(); duke@1: fontEnd(); duke@1: tdEnd(); duke@1: } duke@1: duke@1: public void printSummaryHeader(AbstractMemberWriter mw, ClassDoc cd) { duke@1: mw.printSummaryAnchor(cd); duke@1: tableIndexSummary(); duke@1: tableHeaderStart("#CCCCFF"); duke@1: mw.printSummaryLabel(cd); duke@1: tableHeaderEnd(); duke@1: } duke@1: duke@1: public void printTableHeadingBackground(String str) { duke@1: tableIndexDetail(); duke@1: tableHeaderStart("#CCCCFF", 1); duke@1: bold(str); duke@1: tableHeaderEnd(); duke@1: tableEnd(); duke@1: } duke@1: duke@1: public void printInheritedSummaryHeader(AbstractMemberWriter mw, ClassDoc cd) { duke@1: mw.printInheritedSummaryAnchor(cd); duke@1: tableIndexSummary(); duke@1: tableInheritedHeaderStart("#EEEEFF"); duke@1: mw.printInheritedSummaryLabel(cd); duke@1: tableInheritedHeaderEnd(); duke@1: trBgcolorStyle("white", "TableRowColor"); duke@1: summaryRow(0); duke@1: code(); duke@1: } duke@1: duke@1: public void printSummaryFooter(AbstractMemberWriter mw, ClassDoc cd) { duke@1: tableEnd(); duke@1: space(); duke@1: } duke@1: duke@1: public void printInheritedSummaryFooter(AbstractMemberWriter mw, ClassDoc cd) { duke@1: codeEnd(); duke@1: summaryRowEnd(); duke@1: trEnd(); duke@1: tableEnd(); duke@1: space(); duke@1: } duke@1: duke@1: protected void printIndexComment(Doc member) { duke@1: printIndexComment(member, member.firstSentenceTags()); duke@1: } duke@1: duke@1: protected void printIndexComment(Doc member, Tag[] firstSentenceTags) { duke@1: Tag[] deprs = member.tags("deprecated"); duke@1: if (Util.isDeprecated((ProgramElementDoc) member)) { duke@1: boldText("doclet.Deprecated"); duke@1: space(); duke@1: if (deprs.length > 0) { duke@1: printInlineDeprecatedComment(member, deprs[0]); duke@1: } duke@1: return; duke@1: } else { duke@1: ClassDoc cd = ((ProgramElementDoc)member).containingClass(); duke@1: if (cd != null && Util.isDeprecated(cd)) { duke@1: boldText("doclet.Deprecated"); space(); duke@1: } duke@1: } duke@1: printSummaryComment(member, firstSentenceTags); duke@1: } duke@1: duke@1: public void printSummaryLinkType(AbstractMemberWriter mw, duke@1: ProgramElementDoc member) { duke@1: trBgcolorStyle("white", "TableRowColor"); duke@1: mw.printSummaryType(member); duke@1: summaryRow(0); duke@1: code(); duke@1: } duke@1: duke@1: public void printSummaryLinkComment(AbstractMemberWriter mw, duke@1: ProgramElementDoc member) { duke@1: printSummaryLinkComment(mw, member, member.firstSentenceTags()); duke@1: } duke@1: duke@1: public void printSummaryLinkComment(AbstractMemberWriter mw, duke@1: ProgramElementDoc member, duke@1: Tag[] firstSentenceTags) { duke@1: codeEnd(); duke@1: println(); duke@1: br(); duke@1: printNbsps(); duke@1: printIndexComment(member, firstSentenceTags); duke@1: summaryRowEnd(); duke@1: trEnd(); duke@1: } duke@1: duke@1: public void printInheritedSummaryMember(AbstractMemberWriter mw, ClassDoc cd, duke@1: ProgramElementDoc member, boolean isFirst) { duke@1: if (! isFirst) { duke@1: mw.print(", "); duke@1: } duke@1: mw.writeInheritedSummaryLink(cd, member); duke@1: } duke@1: duke@1: public void printMemberHeader() { duke@1: hr(); duke@1: } duke@1: duke@1: public void printMemberFooter() { duke@1: } duke@1: duke@1: }