Class SubWriterHolderWriter

Direct Known Subclasses:
AnnotationTypeWriterImpl, ClassUseWriter, ClassWriterImpl, DeprecatedListWriter, PackageUseWriter, SerializedFormWriterImpl

@Deprecated public abstract class SubWriterHolderWriter extends HtmlDocletWriter
Deprecated.
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.

This is NOT part of any supported API. If you write code that depends on this, you do so at your own risk. This code and its internal interfaces are subject to change or deletion without notice.

See Also:
  • Field Details

    • mainTree

      protected HtmlTree mainTree
      Deprecated.
      The HTML tree for main tag.
  • Constructor Details

  • Method Details

    • addSummaryHeader

      public void addSummaryHeader(AbstractMemberWriter mw, ClassDoc cd, Content memberTree)
      Deprecated.
      Add the summary header.
      Parameters:
      mw - the writer for the member being documented
      cd - the classdoc to be documented
      memberTree - the content tree to which the summary header will be added
    • getSummaryTableTree

      public Content getSummaryTableTree(AbstractMemberWriter mw, ClassDoc cd, List<Content> tableContents, boolean showTabs)
      Deprecated.
      Get the summary table.
      Parameters:
      mw - the writer for the member being documented
      cd - the classdoc to be documented
      tableContents - list of summary table contents
      showTabs - true if the table needs to show tabs
      Returns:
      the content tree for the summary table
    • getTableCaption

      public Content getTableCaption(Set<MethodTypes> methodTypes)
      Deprecated.
      Get the summary table caption.
      Parameters:
      methodTypes - set comprising of method types to show as table caption
      Returns:
      the caption for the summary table
    • getMethodTypeLinks

      public Content getMethodTypeLinks(MethodTypes methodType)
      Deprecated.
      Get the method type links for the table caption.
      Parameters:
      methodType - the method type to be displayed as link
      Returns:
      the content tree for the method type link
    • addInheritedSummaryHeader

      public void addInheritedSummaryHeader(AbstractMemberWriter mw, ClassDoc cd, Content inheritedTree)
      Deprecated.
      Add the inherited summary header.
      Parameters:
      mw - the writer for the member being documented
      cd - the classdoc to be documented
      inheritedTree - the content tree to which the inherited summary header will be added
    • addIndexComment

      protected void addIndexComment(Doc member, Content contentTree)
      Deprecated.
      Add the index comment.
      Parameters:
      member - the member being documented
      contentTree - the content tree to which the comment will be added
    • addIndexComment

      protected void addIndexComment(Doc member, Tag[] firstSentenceTags, Content tdSummary)
      Deprecated.
      Add the index comment.
      Parameters:
      member - the member being documented
      firstSentenceTags - the first sentence tags for the member to be documented
      tdSummary - the content tree to which the comment will be added
    • addSummaryType

      public void addSummaryType(AbstractMemberWriter mw, ProgramElementDoc member, Content tdSummaryType)
      Deprecated.
      Add the summary type for the member.
      Parameters:
      mw - the writer for the member being documented
      member - the member to be documented
      tdSummaryType - the content tree to which the type will be added
    • addSummaryLinkComment

      public void addSummaryLinkComment(AbstractMemberWriter mw, ProgramElementDoc member, Content contentTree)
      Deprecated.
      Add the summary link for the member.
      Parameters:
      mw - the writer for the member being documented
      member - the member to be documented
      contentTree - the content tree to which the link will be added
    • addSummaryLinkComment

      public void addSummaryLinkComment(AbstractMemberWriter mw, ProgramElementDoc member, Tag[] firstSentenceTags, Content tdSummary)
      Deprecated.
      Add the summary link comment.
      Parameters:
      mw - the writer for the member being documented
      member - the member being documented
      firstSentenceTags - the first sentence tags for the member to be documented
      tdSummary - the content tree to which the comment will be added
    • addInheritedMemberSummary

      public void addInheritedMemberSummary(AbstractMemberWriter mw, ClassDoc cd, ProgramElementDoc member, boolean isFirst, Content linksTree)
      Deprecated.
      Add the inherited member summary.
      Parameters:
      mw - the writer for the member being documented
      cd - the class being documented
      member - the member being documented
      isFirst - true if its the first link being documented
      linksTree - the content tree to which the summary will be added
    • getContentHeader

      public Content getContentHeader()
      Deprecated.
      Get the document content header tree
      Returns:
      a content tree the document content header
    • addClassContentTree

      public void addClassContentTree(Content contentTree, Content classContentTree)
      Deprecated.
      Add the class content tree.
      Parameters:
      contentTree - content tree to which the class content will be added
      classContentTree - class content tree which will be added to the content tree
    • addAnnotationContentTree

      public void addAnnotationContentTree(Content contentTree, Content annotationContentTree)
      Deprecated.
      Add the annotation content tree.
      Parameters:
      contentTree - content tree to which the annotation content will be added
      annotationContentTree - annotation content tree which will be added to the content tree
    • getMemberTreeHeader

      public Content getMemberTreeHeader()
      Deprecated.
      Get the member header tree
      Returns:
      a content tree the member header
    • addMemberTree

      public void addMemberTree(Content memberSummaryTree, Content memberTree)
      Deprecated.
      Add the member tree.
      Parameters:
      memberSummaryTree - the content tree representing the member summary
      memberTree - the content tree representing the member
    • getMemberTree

      public Content getMemberTree(Content contentTree)
      Deprecated.
      Get the member tree
      Parameters:
      contentTree - the tree used to generate the complete member tree
      Returns:
      a content tree for the member
    • getMemberSummaryTree

      public Content getMemberSummaryTree(Content contentTree)
      Deprecated.
      Get the member summary tree
      Parameters:
      contentTree - the tree used to generate the member summary tree
      Returns:
      a content tree for the member summary
    • getMemberDetailsTree

      public Content getMemberDetailsTree(Content contentTree)
      Deprecated.
      Get the member details tree
      Parameters:
      contentTree - the tree used to generate the member details tree
      Returns:
      a content tree for the member details
    • getMemberTree

      public Content getMemberTree(HtmlStyle style, Content contentTree)
      Deprecated.
      Get the member tree
      Parameters:
      style - the style class to be added to the content tree
      contentTree - the tree used to generate the complete member tree