duke@1: /* jjg@1735: * Copyright (c) 2003, 2013, Oracle and/or its affiliates. All rights reserved. duke@1: * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. duke@1: * duke@1: * This code is free software; you can redistribute it and/or modify it duke@1: * under the terms of the GNU General Public License version 2 only, as ohair@554: * published by the Free Software Foundation. Oracle designates this duke@1: * particular file as subject to the "Classpath" exception as provided ohair@554: * by Oracle in the LICENSE file that accompanied this code. duke@1: * duke@1: * This code is distributed in the hope that it will be useful, but WITHOUT duke@1: * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or duke@1: * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License duke@1: * version 2 for more details (a copy is included in the LICENSE file that duke@1: * accompanied this code). duke@1: * duke@1: * You should have received a copy of the GNU General Public License version duke@1: * 2 along with this work; if not, write to the Free Software Foundation, duke@1: * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. duke@1: * ohair@554: * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA ohair@554: * or visit www.oracle.com if you need additional information or have any ohair@554: * questions. duke@1: */ duke@1: duke@1: package com.sun.tools.doclets.formats.html; duke@1: bpatel@233: import java.io.*; bpatel@233: bpatel@233: import com.sun.javadoc.*; bpatel@766: import com.sun.tools.doclets.formats.html.markup.*; duke@1: import com.sun.tools.doclets.internal.toolkit.*; duke@1: import com.sun.tools.doclets.internal.toolkit.util.*; duke@1: duke@1: /** duke@1: * Writes enum constant documentation in HTML format. duke@1: * jjg@1359: *

This is NOT part of any supported API. jjg@1359: * If you write code that depends on this, you do so at your own risk. jjg@1359: * This code and its internal interfaces are subject to change or jjg@1359: * deletion without notice. jjg@1359: * duke@1: * @author Jamie Ho bpatel@243: * @author Bhavesh Patel (Modified) duke@1: */ duke@1: public class EnumConstantWriterImpl extends AbstractMemberWriter duke@1: implements EnumConstantWriter, MemberSummaryWriter { duke@1: duke@1: public EnumConstantWriterImpl(SubWriterHolderWriter writer, duke@1: ClassDoc classdoc) { duke@1: super(writer, classdoc); duke@1: } duke@1: duke@1: public EnumConstantWriterImpl(SubWriterHolderWriter writer) { duke@1: super(writer); duke@1: } duke@1: duke@1: /** bpatel@766: * {@inheritDoc} duke@1: */ bpatel@766: public Content getMemberSummaryHeader(ClassDoc classDoc, bpatel@766: Content memberSummaryTree) { bpatel@766: memberSummaryTree.addContent(HtmlConstants.START_OF_ENUM_CONSTANT_SUMMARY); bpatel@766: Content memberTree = writer.getMemberTreeHeader(); bpatel@766: writer.addSummaryHeader(this, classDoc, memberTree); bpatel@766: return memberTree; duke@1: } duke@1: duke@1: /** duke@1: * {@inheritDoc} duke@1: */ bpatel@766: public Content getEnumConstantsDetailsTreeHeader(ClassDoc classDoc, bpatel@766: Content memberDetailsTree) { bpatel@766: memberDetailsTree.addContent(HtmlConstants.START_OF_ENUM_CONSTANT_DETAILS); bpatel@766: Content enumConstantsDetailsTree = writer.getMemberTreeHeader(); bpatel@766: enumConstantsDetailsTree.addContent(writer.getMarkerAnchor("enum_constant_detail")); bpatel@766: Content heading = HtmlTree.HEADING(HtmlConstants.DETAILS_HEADING, bpatel@766: writer.enumConstantsDetailsLabel); bpatel@766: enumConstantsDetailsTree.addContent(heading); bpatel@766: return enumConstantsDetailsTree; duke@1: } duke@1: duke@1: /** duke@1: * {@inheritDoc} duke@1: */ bpatel@766: public Content getEnumConstantsTreeHeader(FieldDoc enumConstant, bpatel@766: Content enumConstantsDetailsTree) { bpatel@766: enumConstantsDetailsTree.addContent( bpatel@766: writer.getMarkerAnchor(enumConstant.name())); bpatel@766: Content enumConstantsTree = writer.getMemberTreeHeader(); bpatel@766: Content heading = new HtmlTree(HtmlConstants.MEMBER_HEADING); bpatel@766: heading.addContent(enumConstant.name()); bpatel@766: enumConstantsTree.addContent(heading); bpatel@766: return enumConstantsTree; duke@1: } duke@1: duke@1: /** duke@1: * {@inheritDoc} duke@1: */ bpatel@766: public Content getSignature(FieldDoc enumConstant) { bpatel@766: Content pre = new HtmlTree(HtmlTag.PRE); bpatel@766: writer.addAnnotationInfo(enumConstant, pre); bpatel@766: addModifiers(enumConstant, pre); jjg@1736: Content enumConstantLink = writer.getLink(new LinkInfoImpl( jjg@1736: configuration, LinkInfoImpl.Kind.MEMBER, enumConstant.type())); bpatel@766: pre.addContent(enumConstantLink); bpatel@766: pre.addContent(" "); jjg@1410: if (configuration.linksource) { bpatel@766: Content enumConstantName = new StringContent(enumConstant.name()); bpatel@766: writer.addSrcLink(enumConstant, enumConstantName, pre); bpatel@766: } else { bpatel@766: addName(enumConstant.name(), pre); duke@1: } bpatel@766: return pre; duke@1: } duke@1: duke@1: /** duke@1: * {@inheritDoc} duke@1: */ bpatel@766: public void addDeprecated(FieldDoc enumConstant, Content enumConstantsTree) { bpatel@766: addDeprecatedInfo(enumConstant, enumConstantsTree); duke@1: } duke@1: duke@1: /** duke@1: * {@inheritDoc} duke@1: */ bpatel@766: public void addComments(FieldDoc enumConstant, Content enumConstantsTree) { bpatel@766: addComment(enumConstant, enumConstantsTree); duke@1: } duke@1: duke@1: /** duke@1: * {@inheritDoc} duke@1: */ bpatel@766: public void addTags(FieldDoc enumConstant, Content enumConstantsTree) { bpatel@766: writer.addTagsInfo(enumConstant, enumConstantsTree); duke@1: } duke@1: duke@1: /** duke@1: * {@inheritDoc} duke@1: */ bpatel@766: public Content getEnumConstantsDetails(Content enumConstantsDetailsTree) { bpatel@766: return getMemberTree(enumConstantsDetailsTree); duke@1: } duke@1: duke@1: /** duke@1: * {@inheritDoc} duke@1: */ bpatel@766: public Content getEnumConstants(Content enumConstantsTree, bpatel@766: boolean isLastContent) { bpatel@766: return getMemberTree(enumConstantsTree, isLastContent); duke@1: } duke@1: duke@1: /** duke@1: * {@inheritDoc} duke@1: */ duke@1: public void close() throws IOException { duke@1: writer.close(); duke@1: } duke@1: duke@1: public int getMemberKind() { duke@1: return VisibleMemberMap.ENUM_CONSTANTS; duke@1: } duke@1: bpatel@766: /** bpatel@766: * {@inheritDoc} bpatel@766: */ bpatel@766: public void addSummaryLabel(Content memberTree) { bpatel@766: Content label = HtmlTree.HEADING(HtmlConstants.SUMMARY_HEADING, bpatel@766: writer.getResource("doclet.Enum_Constant_Summary")); bpatel@766: memberTree.addContent(label); bpatel@243: } bpatel@243: bpatel@766: /** bpatel@766: * {@inheritDoc} bpatel@766: */ bpatel@766: public String getTableSummary() { jjg@1410: return configuration.getText("doclet.Member_Table_Summary", jjg@1410: configuration.getText("doclet.Enum_Constant_Summary"), jjg@1410: configuration.getText("doclet.enum_constants")); bpatel@243: } bpatel@243: bpatel@766: /** bpatel@766: * {@inheritDoc} bpatel@766: */ jjg@1747: public Content getCaption() { jjg@1747: return configuration.getResource("doclet.Enum_Constants"); bpatel@766: } bpatel@766: bpatel@766: /** bpatel@766: * {@inheritDoc} bpatel@766: */ bpatel@766: public String[] getSummaryTableHeader(ProgramElementDoc member) { bpatel@243: String[] header = new String[] { jjg@1410: configuration.getText("doclet.0_and_1", jjg@1410: configuration.getText("doclet.Enum_Constant"), jjg@1410: configuration.getText("doclet.Description")) bpatel@243: }; bpatel@766: return header; duke@1: } duke@1: bpatel@766: /** bpatel@766: * {@inheritDoc} bpatel@766: */ bpatel@766: public void addSummaryAnchor(ClassDoc cd, Content memberTree) { bpatel@766: memberTree.addContent(writer.getMarkerAnchor("enum_constant_summary")); duke@1: } duke@1: bpatel@766: /** bpatel@766: * {@inheritDoc} bpatel@766: */ bpatel@766: public void addInheritedSummaryAnchor(ClassDoc cd, Content inheritedTree) { duke@1: } duke@1: bpatel@766: /** bpatel@766: * {@inheritDoc} bpatel@766: */ bpatel@766: public void addInheritedSummaryLabel(ClassDoc cd, Content inheritedTree) { duke@1: } duke@1: bpatel@766: /** bpatel@766: * {@inheritDoc} bpatel@766: */ jjg@1735: protected void addSummaryLink(LinkInfoImpl.Kind context, ClassDoc cd, ProgramElementDoc member, bpatel@766: Content tdSummary) { bpatel@1935: Content strong = HtmlTree.SPAN(HtmlStyle.strong, jjg@1736: writer.getDocLink(context, (MemberDoc) member, member.name(), false)); bpatel@766: Content code = HtmlTree.CODE(strong); bpatel@766: tdSummary.addContent(code); duke@1: } duke@1: bpatel@766: /** bpatel@766: * {@inheritDoc} bpatel@766: */ bpatel@766: @Override bpatel@766: public void setSummaryColumnStyle(HtmlTree tdTree) { bpatel@766: tdTree.addStyle(HtmlStyle.colOne); bpatel@766: } bpatel@766: bpatel@766: /** bpatel@766: * {@inheritDoc} bpatel@766: */ bpatel@766: protected void addInheritedSummaryLink(ClassDoc cd, bpatel@766: ProgramElementDoc member, Content linksTree) { bpatel@766: } bpatel@766: bpatel@766: /** bpatel@766: * {@inheritDoc} bpatel@766: */ bpatel@766: protected void addSummaryType(ProgramElementDoc member, Content tdSummaryType) { duke@1: //Not applicable. duke@1: } duke@1: bpatel@766: /** bpatel@766: * {@inheritDoc} bpatel@766: */ bpatel@766: protected Content getDeprecatedLink(ProgramElementDoc member) { jjg@1735: return writer.getDocLink(LinkInfoImpl.Kind.MEMBER, bpatel@766: (MemberDoc) member, ((FieldDoc)member).qualifiedName()); duke@1: } duke@1: bpatel@766: /** bpatel@766: * {@inheritDoc} bpatel@766: */ bpatel@766: protected Content getNavSummaryLink(ClassDoc cd, boolean link) { duke@1: if (link) { jjg@1372: return writer.getHyperLink((cd == null)? bpatel@766: "enum_constant_summary": bpatel@766: "enum_constants_inherited_from_class_" + jjg@1410: configuration.getClassName(cd), bpatel@766: writer.getResource("doclet.navEnum")); duke@1: } else { bpatel@766: return writer.getResource("doclet.navEnum"); duke@1: } duke@1: } duke@1: bpatel@766: /** bpatel@766: * {@inheritDoc} bpatel@766: */ bpatel@766: protected void addNavDetailLink(boolean link, Content liNav) { duke@1: if (link) { jjg@1372: liNav.addContent(writer.getHyperLink("enum_constant_detail", bpatel@766: writer.getResource("doclet.navEnum"))); duke@1: } else { bpatel@766: liNav.addContent(writer.getResource("doclet.navEnum")); duke@1: } duke@1: } duke@1: }