< prev index next >

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

Print this page




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

  80     }
  81 
  82     /**
  83      * {@inheritDoc}
  84      */
  85     @Override
  86     public Content getEnumConstantsDetailsTreeHeader(TypeElement typeElement,
  87             Content memberDetailsTree) {
  88         memberDetailsTree.add(MarkerComments.START_OF_ENUM_CONSTANT_DETAILS);
  89         Content enumConstantsDetailsTree = new ContentBuilder();
  90         Content heading = HtmlTree.HEADING(Headings.TypeDeclaration.DETAILS_HEADING,
  91                 contents.enumConstantDetailLabel);
  92         enumConstantsDetailsTree.add(links.createAnchor(
  93                 SectionName.ENUM_CONSTANT_DETAIL));
  94         enumConstantsDetailsTree.add(heading);
  95         return enumConstantsDetailsTree;
  96     }
  97 
  98     /**
  99      * {@inheritDoc}
 100      */
 101     @Override
 102     public Content getEnumConstantsTreeHeader(VariableElement enumConstant,
 103             Content enumConstantsDetailsTree) {
 104         Content enumConstantsTree = new ContentBuilder();
 105         Content heading = new HtmlTree(Headings.TypeDeclaration.MEMBER_HEADING);
 106         heading.add(links.createAnchor(name(enumConstant), new StringContent(name(enumConstant))));
 107         enumConstantsTree.add(heading);
 108         return HtmlTree.SECTION(HtmlStyle.detail, enumConstantsTree);

 109     }
 110 
 111     /**
 112      * {@inheritDoc}
 113      */
 114     @Override
 115     public Content getSignature(VariableElement enumConstant) {
 116         return new MemberSignature(enumConstant)
 117                 .addType(enumConstant.asType())
 118                 .toContent();
 119     }
 120 
 121     /**
 122      * {@inheritDoc}
 123      */
 124     @Override
 125     public void addDeprecated(VariableElement enumConstant, Content enumConstantsTree) {
 126         addDeprecatedInfo(enumConstant, enumConstantsTree);
 127     }
 128 


 133     public void addComments(VariableElement enumConstant, Content enumConstantsTree) {
 134         addComment(enumConstant, enumConstantsTree);
 135     }
 136 
 137     /**
 138      * {@inheritDoc}
 139      */
 140     @Override
 141     public void addTags(VariableElement enumConstant, Content enumConstantsTree) {
 142         writer.addTagsInfo(enumConstant, enumConstantsTree);
 143     }
 144 
 145     /**
 146      * {@inheritDoc}
 147      */
 148     @Override
 149     public Content getEnumConstantsDetails(Content enumConstantsDetailsTreeHeader,
 150             Content enumConstantsDetailsTree) {
 151         Content enumConstantsDetails =
 152                 new ContentBuilder(enumConstantsDetailsTreeHeader, enumConstantsDetailsTree);
 153         return getMemberTree(HtmlTree.SECTION(HtmlStyle.constantDetails, enumConstantsDetails));

 154     }
 155 
 156     /**
 157      * {@inheritDoc}
 158      */
 159     @Override
 160     public Content getEnumConstants(Content enumConstantsTree) {
 161         return getMemberTree(enumConstantsTree);
 162     }
 163 
 164     /**
 165      * {@inheritDoc}
 166      */
 167     @Override
 168     public void addSummaryLabel(Content memberTree) {
 169         Content label = HtmlTree.HEADING(Headings.TypeDeclaration.SUMMARY_HEADING,
 170                 contents.enumConstantSummary);
 171         memberTree.add(label);
 172     }
 173 


 177     @Override
 178     public TableHeader getSummaryTableHeader(Element member) {
 179         return new TableHeader(contents.enumConstantLabel, contents.descriptionLabel);
 180     }
 181 
 182     /**
 183      * {@inheritDoc}
 184      */
 185     @Override
 186     protected Table createSummaryTable() {
 187         return new Table(HtmlStyle.memberSummary)
 188                 .setCaption(contents.getContent("doclet.Enum_Constants"))
 189                 .setHeader(getSummaryTableHeader(typeElement))
 190                 .setColumnStyles(HtmlStyle.colFirst, HtmlStyle.colLast);
 191     }
 192 
 193     /**
 194      * {@inheritDoc}
 195      */
 196     @Override
 197     public void addSummaryAnchor(TypeElement typeElement, Content memberTree) {
 198         memberTree.add(links.createAnchor(SectionName.ENUM_CONSTANT_SUMMARY));
 199     }
 200 
 201     /**
 202      * {@inheritDoc}
 203      */
 204     @Override
 205     public void addInheritedSummaryAnchor(TypeElement typeElement, Content inheritedTree) {
 206     }
 207 
 208     /**
 209      * {@inheritDoc}
 210      */
 211     @Override
 212     public void addInheritedSummaryLabel(TypeElement typeElement, Content inheritedTree) {
 213     }
 214 
 215     /**
 216      * {@inheritDoc}
 217      */
 218     @Override
 219     protected void addSummaryLink(LinkInfoImpl.Kind context, TypeElement typeElement, Element member,
 220             Content tdSummary) {
 221         Content memberLink = HtmlTree.SPAN(HtmlStyle.memberNameLink,
 222                 writer.getDocLink(context, member, name(member), false));
 223         Content code = HtmlTree.CODE(memberLink);
 224         tdSummary.add(code);
 225     }
 226 
 227     /**
 228      * {@inheritDoc}
 229      */
 230     @Override
 231     protected void addInheritedSummaryLink(TypeElement typeElement, Element member, Content linksTree) {




  50  */
  51 public class EnumConstantWriterImpl extends AbstractMemberWriter
  52     implements EnumConstantWriter, MemberSummaryWriter {
  53 
  54     public EnumConstantWriterImpl(SubWriterHolderWriter writer, TypeElement typeElement) {
  55         super(writer, typeElement);
  56     }
  57 
  58     public EnumConstantWriterImpl(SubWriterHolderWriter writer) {
  59         super(writer);
  60     }
  61 
  62     /**
  63      * {@inheritDoc}
  64      */
  65     @Override
  66     public Content getMemberSummaryHeader(TypeElement typeElement,
  67             Content memberSummaryTree) {
  68         memberSummaryTree.add(MarkerComments.START_OF_ENUM_CONSTANT_SUMMARY);
  69         Content memberTree = new ContentBuilder();
  70         writer.addSummaryHeader(this, memberTree);
  71         return memberTree;
  72     }
  73 
  74     /**
  75      * {@inheritDoc}
  76      */
  77     @Override
  78     public void addMemberTree(Content memberSummaryTree, Content memberTree) {
  79         writer.addMemberTree(HtmlStyle.constantsSummary,
  80                 SectionName.ENUM_CONSTANT_SUMMARY, memberSummaryTree, memberTree);
  81     }
  82 
  83     /**
  84      * {@inheritDoc}
  85      */
  86     @Override
  87     public Content getEnumConstantsDetailsTreeHeader(TypeElement typeElement,
  88             Content memberDetailsTree) {
  89         memberDetailsTree.add(MarkerComments.START_OF_ENUM_CONSTANT_DETAILS);
  90         Content enumConstantsDetailsTree = new ContentBuilder();
  91         Content heading = HtmlTree.HEADING(Headings.TypeDeclaration.DETAILS_HEADING,
  92                 contents.enumConstantDetailLabel);


  93         enumConstantsDetailsTree.add(heading);
  94         return enumConstantsDetailsTree;
  95     }
  96 
  97     /**
  98      * {@inheritDoc}
  99      */
 100     @Override
 101     public Content getEnumConstantsTreeHeader(VariableElement enumConstant,
 102             Content enumConstantsDetailsTree) {
 103         Content enumConstantsTree = new ContentBuilder();
 104         HtmlTree heading = new HtmlTree(Headings.TypeDeclaration.MEMBER_HEADING,
 105                 new StringContent(name(enumConstant)));
 106         enumConstantsTree.add(heading);
 107         return HtmlTree.SECTION(HtmlStyle.detail, enumConstantsTree)
 108                 .setId(name(enumConstant));
 109     }
 110 
 111     /**
 112      * {@inheritDoc}
 113      */
 114     @Override
 115     public Content getSignature(VariableElement enumConstant) {
 116         return new MemberSignature(enumConstant)
 117                 .addType(enumConstant.asType())
 118                 .toContent();
 119     }
 120 
 121     /**
 122      * {@inheritDoc}
 123      */
 124     @Override
 125     public void addDeprecated(VariableElement enumConstant, Content enumConstantsTree) {
 126         addDeprecatedInfo(enumConstant, enumConstantsTree);
 127     }
 128 


 133     public void addComments(VariableElement enumConstant, Content enumConstantsTree) {
 134         addComment(enumConstant, enumConstantsTree);
 135     }
 136 
 137     /**
 138      * {@inheritDoc}
 139      */
 140     @Override
 141     public void addTags(VariableElement enumConstant, Content enumConstantsTree) {
 142         writer.addTagsInfo(enumConstant, enumConstantsTree);
 143     }
 144 
 145     /**
 146      * {@inheritDoc}
 147      */
 148     @Override
 149     public Content getEnumConstantsDetails(Content enumConstantsDetailsTreeHeader,
 150             Content enumConstantsDetailsTree) {
 151         Content enumConstantsDetails =
 152                 new ContentBuilder(enumConstantsDetailsTreeHeader, enumConstantsDetailsTree);
 153         return getMemberTree(HtmlTree.SECTION(HtmlStyle.constantDetails, enumConstantsDetails)
 154                 .setId(SectionName.ENUM_CONSTANT_DETAIL.getName()));
 155     }
 156 
 157     /**
 158      * {@inheritDoc}
 159      */
 160     @Override
 161     public Content getEnumConstants(Content enumConstantsTree) {
 162         return getMemberTree(enumConstantsTree);
 163     }
 164 
 165     /**
 166      * {@inheritDoc}
 167      */
 168     @Override
 169     public void addSummaryLabel(Content memberTree) {
 170         Content label = HtmlTree.HEADING(Headings.TypeDeclaration.SUMMARY_HEADING,
 171                 contents.enumConstantSummary);
 172         memberTree.add(label);
 173     }
 174 


 178     @Override
 179     public TableHeader getSummaryTableHeader(Element member) {
 180         return new TableHeader(contents.enumConstantLabel, contents.descriptionLabel);
 181     }
 182 
 183     /**
 184      * {@inheritDoc}
 185      */
 186     @Override
 187     protected Table createSummaryTable() {
 188         return new Table(HtmlStyle.memberSummary)
 189                 .setCaption(contents.getContent("doclet.Enum_Constants"))
 190                 .setHeader(getSummaryTableHeader(typeElement))
 191                 .setColumnStyles(HtmlStyle.colFirst, HtmlStyle.colLast);
 192     }
 193 
 194     /**
 195      * {@inheritDoc}
 196      */
 197     @Override















 198     public void addInheritedSummaryLabel(TypeElement typeElement, Content inheritedTree) {
 199     }
 200 
 201     /**
 202      * {@inheritDoc}
 203      */
 204     @Override
 205     protected void addSummaryLink(LinkInfoImpl.Kind context, TypeElement typeElement, Element member,
 206             Content tdSummary) {
 207         Content memberLink = HtmlTree.SPAN(HtmlStyle.memberNameLink,
 208                 writer.getDocLink(context, member, name(member), false));
 209         Content code = HtmlTree.CODE(memberLink);
 210         tdSummary.add(code);
 211     }
 212 
 213     /**
 214      * {@inheritDoc}
 215      */
 216     @Override
 217     protected void addInheritedSummaryLink(TypeElement typeElement, Element member, Content linksTree) {


< prev index next >