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

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