< prev index next >

src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/NestedClassWriterImpl.java

Print this page




  51  */
  52 public class NestedClassWriterImpl extends AbstractMemberWriter
  53     implements MemberSummaryWriter {
  54 
  55     public NestedClassWriterImpl(SubWriterHolderWriter writer, TypeElement typeElement) {
  56         super(writer, typeElement);
  57     }
  58 
  59     public NestedClassWriterImpl(SubWriterHolderWriter writer) {
  60         super(writer);
  61     }
  62 
  63     /**
  64      * {@inheritDoc}
  65      */
  66     @Override
  67     public Content getMemberSummaryHeader(TypeElement typeElement,
  68             Content memberSummaryTree) {
  69         memberSummaryTree.add(MarkerComments.START_OF_NESTED_CLASS_SUMMARY);
  70         Content memberTree = new ContentBuilder();
  71         writer.addSummaryHeader(this, typeElement, memberTree);
  72         return memberTree;
  73     }
  74 
  75     /**
  76      * {@inheritDoc}
  77      */
  78     @Override
  79     public void addMemberTree(Content memberSummaryTree, Content memberTree) {
  80         writer.addMemberTree(HtmlStyle.nestedClassSummary, memberSummaryTree, memberTree);

  81     }
  82 
  83     /**
  84      * {@inheritDoc}
  85      */
  86     @Override
  87     public void addSummaryLabel(Content memberTree) {
  88         Content label = HtmlTree.HEADING(Headings.TypeDeclaration.SUMMARY_HEADING,
  89                 contents.nestedClassSummary);
  90         memberTree.add(label);
  91     }
  92 
  93     /**
  94      * {@inheritDoc}
  95      */
  96     @Override
  97     public TableHeader getSummaryTableHeader(Element member) {
  98         Content label = utils.isInterface(member) ?
  99                 contents.interfaceLabel : contents.classLabel;
 100 
 101         return new TableHeader(contents.modifierAndTypeLabel, label, contents.descriptionLabel);
 102     }
 103 
 104     @Override
 105     protected Table createSummaryTable() {
 106         List<HtmlStyle> bodyRowStyles = Arrays.asList(HtmlStyle.colFirst, HtmlStyle.colSecond,
 107                 HtmlStyle.colLast);
 108 
 109         return new Table(HtmlStyle.memberSummary)
 110                 .setCaption(contents.getContent("doclet.Nested_Classes"))
 111                 .setHeader(getSummaryTableHeader(typeElement))
 112                 .setRowScopeColumn(1)
 113                 .setColumnStyles(bodyRowStyles);
 114     }
 115 
 116     /**
 117      * {@inheritDoc}
 118      */
 119     @Override
 120     public void addSummaryAnchor(TypeElement typeElement, Content memberTree) {
 121         memberTree.add(links.createAnchor(
 122                 SectionName.NESTED_CLASS_SUMMARY));
 123     }
 124 
 125     /**
 126      * {@inheritDoc}
 127      */
 128     @Override
 129     public void addInheritedSummaryAnchor(TypeElement typeElement, Content inheritedTree) {
 130         inheritedTree.add(links.createAnchor(
 131                 SectionName.NESTED_CLASSES_INHERITANCE,
 132                 utils.getFullyQualifiedName(typeElement)));
 133     }
 134 
 135     /**
 136      * {@inheritDoc}
 137      */
 138     @Override
 139     public void addInheritedSummaryLabel(TypeElement typeElement, Content inheritedTree) {
 140         Content classLink = writer.getPreQualifiedClassLink(
 141                 LinkInfoImpl.Kind.MEMBER, typeElement, false);
 142         Content label;
 143         if (configuration.summarizeOverriddenMethods) {
 144             label = new StringContent(utils.isInterface(typeElement)
 145                     ? resources.getText("doclet.Nested_Classes_Interfaces_Declared_In_Interface")
 146                     : resources.getText("doclet.Nested_Classes_Interfaces_Declared_In_Class"));
 147         } else {
 148             label = new StringContent(utils.isInterface(typeElement)
 149                     ? resources.getText("doclet.Nested_Classes_Interfaces_Inherited_From_Interface")
 150                     : resources.getText("doclet.Nested_Classes_Interfaces_Inherited_From_Class"));
 151         }
 152         Content labelHeading = HtmlTree.HEADING(Headings.TypeDeclaration.SUMMARY_HEADING, label);


 153         labelHeading.add(Entity.NO_BREAK_SPACE);
 154         labelHeading.add(classLink);
 155         inheritedTree.add(labelHeading);
 156     }
 157 
 158     /**
 159      * {@inheritDoc}
 160      */
 161     @Override
 162     protected void addSummaryLink(LinkInfoImpl.Kind context, TypeElement typeElement, Element member,
 163             Content tdSummary) {
 164         Content memberLink = HtmlTree.SPAN(HtmlStyle.memberNameLink,
 165                 writer.getLink(new LinkInfoImpl(configuration, context, (TypeElement)member)));
 166         Content code = HtmlTree.CODE(memberLink);
 167         tdSummary.add(code);
 168     }
 169 
 170     /**
 171      * {@inheritDoc}
 172      */




  51  */
  52 public class NestedClassWriterImpl extends AbstractMemberWriter
  53     implements MemberSummaryWriter {
  54 
  55     public NestedClassWriterImpl(SubWriterHolderWriter writer, TypeElement typeElement) {
  56         super(writer, typeElement);
  57     }
  58 
  59     public NestedClassWriterImpl(SubWriterHolderWriter writer) {
  60         super(writer);
  61     }
  62 
  63     /**
  64      * {@inheritDoc}
  65      */
  66     @Override
  67     public Content getMemberSummaryHeader(TypeElement typeElement,
  68             Content memberSummaryTree) {
  69         memberSummaryTree.add(MarkerComments.START_OF_NESTED_CLASS_SUMMARY);
  70         Content memberTree = new ContentBuilder();
  71         writer.addSummaryHeader(this, memberTree);
  72         return memberTree;
  73     }
  74 
  75     /**
  76      * {@inheritDoc}
  77      */
  78     @Override
  79     public void addMemberTree(Content memberSummaryTree, Content memberTree) {
  80         writer.addMemberTree(HtmlStyle.nestedClassSummary,
  81                 SectionName.NESTED_CLASS_SUMMARY, memberSummaryTree, memberTree);
  82     }
  83 
  84     /**
  85      * {@inheritDoc}
  86      */
  87     @Override
  88     public void addSummaryLabel(Content memberTree) {
  89         Content label = HtmlTree.HEADING(Headings.TypeDeclaration.SUMMARY_HEADING,
  90                 contents.nestedClassSummary);
  91         memberTree.add(label);
  92     }
  93 
  94     /**
  95      * {@inheritDoc}
  96      */
  97     @Override
  98     public TableHeader getSummaryTableHeader(Element member) {
  99         Content label = utils.isInterface(member) ?
 100                 contents.interfaceLabel : contents.classLabel;
 101 
 102         return new TableHeader(contents.modifierAndTypeLabel, label, contents.descriptionLabel);
 103     }
 104 
 105     @Override
 106     protected Table createSummaryTable() {
 107         List<HtmlStyle> bodyRowStyles = Arrays.asList(HtmlStyle.colFirst, HtmlStyle.colSecond,
 108                 HtmlStyle.colLast);
 109 
 110         return new Table(HtmlStyle.memberSummary)
 111                 .setCaption(contents.getContent("doclet.Nested_Classes"))
 112                 .setHeader(getSummaryTableHeader(typeElement))
 113                 .setRowScopeColumn(1)
 114                 .setColumnStyles(bodyRowStyles);
 115     }
 116 
 117     /**
 118      * {@inheritDoc}
 119      */
 120     @Override



















 121     public void addInheritedSummaryLabel(TypeElement typeElement, Content inheritedTree) {
 122         Content classLink = writer.getPreQualifiedClassLink(
 123                 LinkInfoImpl.Kind.MEMBER, typeElement, false);
 124         Content label;
 125         if (configuration.summarizeOverriddenMethods) {
 126             label = new StringContent(utils.isInterface(typeElement)
 127                     ? resources.getText("doclet.Nested_Classes_Interfaces_Declared_In_Interface")
 128                     : resources.getText("doclet.Nested_Classes_Interfaces_Declared_In_Class"));
 129         } else {
 130             label = new StringContent(utils.isInterface(typeElement)
 131                     ? resources.getText("doclet.Nested_Classes_Interfaces_Inherited_From_Interface")
 132                     : resources.getText("doclet.Nested_Classes_Interfaces_Inherited_From_Class"));
 133         }
 134         HtmlTree labelHeading = HtmlTree.HEADING(Headings.TypeDeclaration.SUMMARY_HEADING, label);
 135         labelHeading.setId(SectionName.NESTED_CLASSES_INHERITANCE.getName()
 136                 + links.getName(utils.getFullyQualifiedName(typeElement)));
 137         labelHeading.add(Entity.NO_BREAK_SPACE);
 138         labelHeading.add(classLink);
 139         inheritedTree.add(labelHeading);
 140     }
 141 
 142     /**
 143      * {@inheritDoc}
 144      */
 145     @Override
 146     protected void addSummaryLink(LinkInfoImpl.Kind context, TypeElement typeElement, Element member,
 147             Content tdSummary) {
 148         Content memberLink = HtmlTree.SPAN(HtmlStyle.memberNameLink,
 149                 writer.getLink(new LinkInfoImpl(configuration, context, (TypeElement)member)));
 150         Content code = HtmlTree.CODE(memberLink);
 151         tdSummary.add(code);
 152     }
 153 
 154     /**
 155      * {@inheritDoc}
 156      */


< prev index next >