FileDocCategorySizeDatePackage
SubWriterHolderWriter.javaAPI DocExample4531Wed Apr 19 11:17:14 BST 2000com.sun.tools.doclets.standard

SubWriterHolderWriter

public abstract class SubWriterHolderWriter extends HtmlStandardWriter
This abstract class exists to provide functionality needed in the the formatting of member information. Since AbstractSubWriter and its subclasses control this, they would be the logical place to put this. However, because each member type has its own subclass, subclassing can not be used effectively to change formatting. The concrete class subclass of this class can be subclassed to change formatting.
see
AbstractSubWriter
see
ClassWriter
author
Robert Field
author
Atul M Dambalkar

Fields Summary
Constructors Summary
public SubWriterHolderWriter(String filename)

        super(filename);
    
public SubWriterHolderWriter(String path, String filename, String relpath)

        super(path, filename, relpath);
    
Methods Summary
protected voidprintCommentDef(com.sun.javadoc.Doc member)

        printNbsps();
        printIndexComment(member); 
    
protected voidprintIndexComment(com.sun.javadoc.Doc member)

        Tag[] deprs = member.tags("deprecated");
        boolean deprecated = false;
        if (deprs.length > 0) {
            boldText("doclet.Deprecated"); space();
            printInlineDeprecatedComment(deprs[0]);
            return;
        } else {
            ClassDoc cd = ((ProgramElementDoc)member).containingClass();
            if (cd != null && cd.tags("deprecated").length > 0) {
                boldText("doclet.Deprecated"); space();
            } 
        }
        printSummaryComment(member);
    
public voidprintInheritedSummaryFooter(AbstractSubWriter mw, com.sun.javadoc.ClassDoc cd)

        codeEnd();
        summaryRowEnd();
        trEnd(); 
        tableEnd();
        space();
    
public voidprintInheritedSummaryHeader(AbstractSubWriter mw, com.sun.javadoc.ClassDoc cd)

        mw.printInheritedSummaryAnchor(cd);
        tableIndexSummary();
        tableInheritedHeaderStart("#EEEEFF");
        mw.printInheritedSummaryLabel(cd);
        tableInheritedHeaderEnd();
        trBgcolorStyle("white", "TableRowColor");
        summaryRow(0);
        code();
    
public voidprintInheritedSummaryMember(AbstractSubWriter mw, com.sun.javadoc.ClassDoc cd, com.sun.javadoc.ProgramElementDoc member)

        mw.printInheritedSummaryLink(cd, member);
    
public voidprintMemberFooter()

    
public voidprintMemberHeader()

        hr();
    
public voidprintSummaryFooter(AbstractSubWriter mw, com.sun.javadoc.ClassDoc cd)

        tableEnd();
        space();
    
public voidprintSummaryHeader(AbstractSubWriter mw, com.sun.javadoc.ClassDoc cd)

        mw.printSummaryAnchor(cd);
        tableIndexSummary();
        tableHeaderStart("#CCCCFF");
        mw.printSummaryLabel(cd);
        tableHeaderEnd();
    
public voidprintSummaryLinkComment(AbstractSubWriter mw, com.sun.javadoc.ProgramElementDoc member)

        codeEnd();
        println(); br();
        printCommentDef(member);
        summaryRowEnd();
        trEnd(); 
    
public voidprintSummaryLinkType(AbstractSubWriter mw, com.sun.javadoc.ProgramElementDoc member)

        trBgcolorStyle("white", "TableRowColor");
        mw.printSummaryType(member);
        summaryRow(0);
        code();
    
public voidprintSummaryMember(AbstractSubWriter mw, com.sun.javadoc.ClassDoc cd, com.sun.javadoc.ProgramElementDoc member)

        printSummaryLinkType(mw, member);
        /*if (cd == null) {
            cd = member.containingClass();
        }*/
        mw.printSummaryLink(cd, member);
        printSummaryLinkComment(mw, member);     
    
public voidprintTableHeadingBackground(java.lang.String str)

        tableIndexDetail();
        tableHeaderStart("#CCCCFF", 1);
        bold(str);
        tableHeaderEnd();
        tableEnd();
    
public voidprintTypeSummaryFooter()

        codeEnd();
        fontEnd();
        tdEnd();
    
public voidprintTypeSummaryHeader()

        tdIndex();
        font("-1");
        code();