1 /*
   2  * Copyright (c) 2003, 2019, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package jdk.javadoc.internal.doclets.formats.html;
  27 
  28 
  29 import javax.lang.model.element.Element;
  30 import javax.lang.model.element.TypeElement;
  31 import javax.lang.model.element.VariableElement;
  32 
  33 import jdk.javadoc.internal.doclets.formats.html.markup.ContentBuilder;
  34 import jdk.javadoc.internal.doclets.formats.html.markup.HtmlStyle;

  35 import jdk.javadoc.internal.doclets.formats.html.markup.HtmlTree;

  36 import jdk.javadoc.internal.doclets.formats.html.markup.Table;
  37 import jdk.javadoc.internal.doclets.formats.html.markup.TableHeader;
  38 import jdk.javadoc.internal.doclets.toolkit.Content;
  39 import jdk.javadoc.internal.doclets.toolkit.EnumConstantWriter;
  40 import jdk.javadoc.internal.doclets.toolkit.MemberSummaryWriter;
  41 
  42 /**
  43  * Writes enum constant documentation in HTML format.
  44  *
  45  *  <p><b>This is NOT part of any supported API.
  46  *  If you write code that depends on this, you do so at your own risk.
  47  *  This code and its internal interfaces are subject to change or
  48  *  deletion without notice.</b>
  49  *
  50  * @author Jamie Ho
  51  * @author Bhavesh Patel (Modified)
  52  */
  53 public class EnumConstantWriterImpl extends AbstractMemberWriter
  54     implements EnumConstantWriter, MemberSummaryWriter {
  55 
  56     public EnumConstantWriterImpl(SubWriterHolderWriter writer, TypeElement typeElement) {
  57         super(writer, typeElement);
  58     }
  59 
  60     public EnumConstantWriterImpl(SubWriterHolderWriter writer) {
  61         super(writer);
  62     }
  63 
  64     /**
  65      * {@inheritDoc}
  66      */
  67     @Override
  68     public Content getMemberSummaryHeader(TypeElement typeElement,
  69             Content memberSummaryTree) {
  70         memberSummaryTree.add(MarkerComments.START_OF_ENUM_CONSTANT_SUMMARY);
  71         Content memberTree = new ContentBuilder();
  72         writer.addSummaryHeader(this, typeElement, memberTree);
  73         return memberTree;
  74     }
  75 
  76     /**
  77      * {@inheritDoc}
  78      */
  79     @Override
  80     public void addMemberTree(Content memberSummaryTree, Content memberTree) {
  81         writer.addMemberTree(HtmlStyle.constantsSummary, memberSummaryTree, memberTree);
  82     }
  83 
  84     /**
  85      * {@inheritDoc}
  86      */
  87     @Override
  88     public Content getEnumConstantsDetailsTreeHeader(TypeElement typeElement,
  89             Content memberDetailsTree) {
  90         memberDetailsTree.add(MarkerComments.START_OF_ENUM_CONSTANT_DETAILS);
  91         Content enumConstantsDetailsTree = new ContentBuilder();
  92         Content heading = HtmlTree.HEADING(Headings.TypeDeclaration.DETAILS_HEADING,
  93                 contents.enumConstantDetailLabel);
  94         enumConstantsDetailsTree.add(heading);
  95         enumConstantsDetailsTree.add(links.createAnchor(
  96                 SectionName.ENUM_CONSTANT_DETAIL));
  97         return enumConstantsDetailsTree;
  98     }
  99 
 100     /**
 101      * {@inheritDoc}
 102      */
 103     @Override
 104     public Content getEnumConstantsTreeHeader(VariableElement enumConstant,
 105             Content enumConstantsDetailsTree) {
 106         Content enumConstantsTree = new ContentBuilder();
 107         Content heading = new HtmlTree(Headings.TypeDeclaration.MEMBER_HEADING);
 108         heading.add(name(enumConstant));
 109         enumConstantsTree.add(heading);
 110         enumConstantsTree.add(links.createAnchor(name(enumConstant)));
 111         return HtmlTree.SECTION(HtmlStyle.detail, enumConstantsTree);
 112     }
 113 
 114     /**
 115      * {@inheritDoc}
 116      */
 117     @Override
 118     public Content getSignature(VariableElement enumConstant) {
 119         MemberSignature sig = new MemberSignature(enumConstant);
 120         sig.addType(enumConstant.asType());
 121         sig.addName(enumConstant);
 122         return sig.toContent();










 123     }
 124 
 125     /**
 126      * {@inheritDoc}
 127      */
 128     @Override
 129     public void addDeprecated(VariableElement enumConstant, Content enumConstantsTree) {
 130         addDeprecatedInfo(enumConstant, enumConstantsTree);
 131     }
 132 
 133     /**
 134      * {@inheritDoc}
 135      */
 136     @Override
 137     public void addComments(VariableElement enumConstant, Content enumConstantsTree) {
 138         addComment(enumConstant, enumConstantsTree);
 139     }
 140 
 141     /**
 142      * {@inheritDoc}
 143      */
 144     @Override
 145     public void addTags(VariableElement enumConstant, Content enumConstantsTree) {
 146         writer.addTagsInfo(enumConstant, enumConstantsTree);
 147     }
 148 
 149     /**
 150      * {@inheritDoc}
 151      */
 152     @Override
 153     public Content getEnumConstantsDetails(Content enumConstantsDetailsTreeHeader,
 154             Content enumConstantsDetailsTree) {
 155         Content enumConstantsDetails =
 156                 new ContentBuilder(enumConstantsDetailsTreeHeader, enumConstantsDetailsTree);
 157         return getMemberTree(HtmlTree.SECTION(HtmlStyle.constantDetails, enumConstantsDetails));
 158     }
 159 
 160     /**
 161      * {@inheritDoc}
 162      */
 163     @Override
 164     public Content getEnumConstants(Content enumConstantsTree,
 165             boolean isLastContent) {
 166         return getMemberTree(enumConstantsTree, isLastContent);
 167     }
 168 
 169     /**
 170      * {@inheritDoc}
 171      */
 172     @Override
 173     public void addSummaryLabel(Content memberTree) {
 174         Content label = HtmlTree.HEADING(Headings.TypeDeclaration.SUMMARY_HEADING,
 175                 contents.enumConstantSummary);
 176         memberTree.add(label);
 177     }
 178 
 179     /**
 180      * {@inheritDoc}
 181      */
 182     @Override
 183     public TableHeader getSummaryTableHeader(Element member) {
 184         return new TableHeader(contents.enumConstantLabel, contents.descriptionLabel);
 185     }
 186 
 187     /**
 188      * {@inheritDoc}
 189      */
 190     @Override
 191     protected Table createSummaryTable() {
 192         return new Table(HtmlStyle.memberSummary)
 193                 .setCaption(contents.getContent("doclet.Enum_Constants"))
 194                 .setHeader(getSummaryTableHeader(typeElement))
 195                 .setColumnStyles(HtmlStyle.colFirst, HtmlStyle.colLast);
 196     }
 197 
 198     /**
 199      * {@inheritDoc}
 200      */
 201     @Override
 202     public void addSummaryAnchor(TypeElement typeElement, Content memberTree) {
 203         memberTree.add(links.createAnchor(SectionName.ENUM_CONSTANT_SUMMARY));
 204     }
 205 
 206     /**
 207      * {@inheritDoc}
 208      */
 209     @Override
 210     public void addInheritedSummaryAnchor(TypeElement typeElement, Content inheritedTree) {
 211     }
 212 
 213     /**
 214      * {@inheritDoc}
 215      */
 216     @Override
 217     public void addInheritedSummaryLabel(TypeElement typeElement, Content inheritedTree) {
 218     }
 219 
 220     /**
 221      * {@inheritDoc}
 222      */
 223     @Override
 224     protected void addSummaryLink(LinkInfoImpl.Kind context, TypeElement typeElement, Element member,
 225             Content tdSummary) {
 226         Content memberLink = HtmlTree.SPAN(HtmlStyle.memberNameLink,
 227                 writer.getDocLink(context, member, name(member), false));
 228         Content code = HtmlTree.CODE(memberLink);
 229         tdSummary.add(code);
 230     }
 231 
 232     /**
 233      * {@inheritDoc}
 234      */
 235     @Override
 236     protected void addInheritedSummaryLink(TypeElement typeElement, Element member, Content linksTree) {
 237     }
 238 
 239     /**
 240      * {@inheritDoc}
 241      */
 242     @Override
 243     protected void addSummaryType(Element member, Content tdSummaryType) {
 244         //Not applicable.
 245     }
 246 
 247     /**
 248      * {@inheritDoc}
 249      */
 250     @Override
 251     protected Content getDeprecatedLink(Element member) {
 252         String name = utils.getFullyQualifiedName(member) + "." + member.getSimpleName();
 253         return writer.getDocLink(LinkInfoImpl.Kind.MEMBER, member, name);
 254     }
 255 
 256     @Override
 257     public Content getMemberTreeHeader(){
 258         return writer.getMemberTreeHeader();
 259     }
 260 }
--- EOF ---