Thu, 19 Mar 2009 19:00:54 -0700
6786688: Javadoc HTML WCAG 2.0 accessibility issues in standard doclet - Table must have captions and headers
Reviewed-by: jjg
duke@1 | 1 | /* |
duke@1 | 2 | * Copyright 2003-2004 Sun Microsystems, Inc. All Rights Reserved. |
duke@1 | 3 | * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER. |
duke@1 | 4 | * |
duke@1 | 5 | * This code is free software; you can redistribute it and/or modify it |
duke@1 | 6 | * under the terms of the GNU General Public License version 2 only, as |
duke@1 | 7 | * published by the Free Software Foundation. Sun designates this |
duke@1 | 8 | * particular file as subject to the "Classpath" exception as provided |
duke@1 | 9 | * by Sun in the LICENSE file that accompanied this code. |
duke@1 | 10 | * |
duke@1 | 11 | * This code is distributed in the hope that it will be useful, but WITHOUT |
duke@1 | 12 | * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
duke@1 | 13 | * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
duke@1 | 14 | * version 2 for more details (a copy is included in the LICENSE file that |
duke@1 | 15 | * accompanied this code). |
duke@1 | 16 | * |
duke@1 | 17 | * You should have received a copy of the GNU General Public License version |
duke@1 | 18 | * 2 along with this work; if not, write to the Free Software Foundation, |
duke@1 | 19 | * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA. |
duke@1 | 20 | * |
duke@1 | 21 | * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, |
duke@1 | 22 | * CA 95054 USA or visit www.sun.com if you need additional information or |
duke@1 | 23 | * have any questions. |
duke@1 | 24 | */ |
duke@1 | 25 | |
duke@1 | 26 | package com.sun.tools.doclets.formats.html; |
duke@1 | 27 | |
bpatel@233 | 28 | import java.io.*; |
bpatel@233 | 29 | |
bpatel@233 | 30 | import com.sun.javadoc.*; |
duke@1 | 31 | import com.sun.tools.doclets.internal.toolkit.*; |
duke@1 | 32 | |
duke@1 | 33 | /** |
duke@1 | 34 | * Writes annotation type required member documentation in HTML format. |
duke@1 | 35 | * |
duke@1 | 36 | * @author Jamie Ho |
bpatel@243 | 37 | * @author Bhavesh Patel (Modified) |
duke@1 | 38 | */ |
duke@1 | 39 | public class AnnotationTypeRequiredMemberWriterImpl extends AbstractMemberWriter |
duke@1 | 40 | implements AnnotationTypeRequiredMemberWriter, MemberSummaryWriter { |
duke@1 | 41 | |
duke@1 | 42 | /** |
duke@1 | 43 | * Construct a new AnnotationTypeRequiredMemberWriterImpl. |
duke@1 | 44 | * |
duke@1 | 45 | * @param writer the writer that will write the output. |
duke@1 | 46 | * @param annotationType the AnnotationType that holds this member. |
duke@1 | 47 | */ |
duke@1 | 48 | public AnnotationTypeRequiredMemberWriterImpl(SubWriterHolderWriter writer, |
duke@1 | 49 | AnnotationTypeDoc annotationType) { |
duke@1 | 50 | super(writer, annotationType); |
duke@1 | 51 | } |
duke@1 | 52 | |
duke@1 | 53 | /** |
duke@1 | 54 | * Write the annotation type member summary header for the given class. |
duke@1 | 55 | * |
duke@1 | 56 | * @param classDoc the class the summary belongs to. |
duke@1 | 57 | */ |
duke@1 | 58 | public void writeMemberSummaryHeader(ClassDoc classDoc) { |
duke@1 | 59 | writer.println("<!-- =========== ANNOTATION TYPE REQUIRED MEMBER SUMMARY =========== -->"); |
duke@1 | 60 | writer.println(); |
duke@1 | 61 | writer.printSummaryHeader(this, classDoc); |
duke@1 | 62 | } |
duke@1 | 63 | |
duke@1 | 64 | /** |
duke@1 | 65 | * Write the annotation type member summary footer for the given class. |
duke@1 | 66 | * |
duke@1 | 67 | * @param classDoc the class the summary belongs to. |
duke@1 | 68 | */ |
duke@1 | 69 | public void writeMemberSummaryFooter(ClassDoc classDoc) { |
duke@1 | 70 | writer.printSummaryFooter(this, classDoc); |
duke@1 | 71 | } |
duke@1 | 72 | |
duke@1 | 73 | /** |
duke@1 | 74 | * {@inheritDoc} |
duke@1 | 75 | */ |
duke@1 | 76 | public void writeInheritedMemberSummaryHeader(ClassDoc classDoc) { |
duke@1 | 77 | //Not appliable. |
duke@1 | 78 | } |
duke@1 | 79 | |
duke@1 | 80 | /** |
duke@1 | 81 | * {@inheritDoc} |
duke@1 | 82 | */ |
duke@1 | 83 | public void writeInheritedMemberSummary(ClassDoc classDoc, |
duke@1 | 84 | ProgramElementDoc member, boolean isFirst, boolean isLast) { |
duke@1 | 85 | //Not appliable. |
duke@1 | 86 | } |
duke@1 | 87 | |
duke@1 | 88 | /** |
duke@1 | 89 | * {@inheritDoc} |
duke@1 | 90 | */ |
duke@1 | 91 | public void writeInheritedMemberSummaryFooter(ClassDoc classDoc) { |
duke@1 | 92 | //Not appliable. |
duke@1 | 93 | } |
duke@1 | 94 | |
duke@1 | 95 | /** |
duke@1 | 96 | * {@inheritDoc} |
duke@1 | 97 | */ |
duke@1 | 98 | public void writeHeader(ClassDoc classDoc, String header) { |
duke@1 | 99 | writer.println(); |
duke@1 | 100 | writer.println("<!-- ============ ANNOTATION TYPE MEMBER DETAIL =========== -->"); |
duke@1 | 101 | writer.println(); |
duke@1 | 102 | writer.anchor("annotation_type_element_detail"); |
duke@1 | 103 | writer.printTableHeadingBackground(header); |
duke@1 | 104 | writer.println(); |
duke@1 | 105 | } |
duke@1 | 106 | |
duke@1 | 107 | /** |
duke@1 | 108 | * {@inheritDoc} |
duke@1 | 109 | */ |
duke@1 | 110 | public void writeMemberHeader(MemberDoc member, boolean isFirst) { |
duke@1 | 111 | if (! isFirst) { |
duke@1 | 112 | writer.printMemberHeader(); |
duke@1 | 113 | writer.println(""); |
duke@1 | 114 | } |
duke@1 | 115 | writer.anchor(member.name() + ((ExecutableMemberDoc) member).signature()); |
duke@1 | 116 | writer.h3(); |
duke@1 | 117 | writer.print(member.name()); |
duke@1 | 118 | writer.h3End(); |
duke@1 | 119 | } |
duke@1 | 120 | |
duke@1 | 121 | /** |
duke@1 | 122 | * {@inheritDoc} |
duke@1 | 123 | */ |
duke@1 | 124 | public void writeSignature(MemberDoc member) { |
duke@1 | 125 | writer.pre(); |
duke@1 | 126 | writer.writeAnnotationInfo(member); |
duke@1 | 127 | printModifiers(member); |
duke@1 | 128 | writer.printLink(new LinkInfoImpl(LinkInfoImpl.CONTEXT_MEMBER, |
duke@1 | 129 | getType(member))); |
duke@1 | 130 | print(' '); |
duke@1 | 131 | if (configuration().linksource) { |
duke@1 | 132 | writer.printSrcLink(member, member.name()); |
duke@1 | 133 | } else { |
bpatel@182 | 134 | strong(member.name()); |
duke@1 | 135 | } |
duke@1 | 136 | writer.preEnd(); |
bpatel@233 | 137 | assert !writer.getMemberDetailsListPrinted(); |
duke@1 | 138 | } |
duke@1 | 139 | |
duke@1 | 140 | /** |
duke@1 | 141 | * {@inheritDoc} |
duke@1 | 142 | */ |
duke@1 | 143 | public void writeComments(MemberDoc member) { |
bpatel@233 | 144 | printComment(member); |
duke@1 | 145 | } |
duke@1 | 146 | |
duke@1 | 147 | /** |
duke@1 | 148 | * Write the tag output for the given member. |
duke@1 | 149 | * |
duke@1 | 150 | * @param member the member being documented. |
duke@1 | 151 | */ |
duke@1 | 152 | public void writeTags(MemberDoc member) { |
duke@1 | 153 | writer.printTags(member); |
duke@1 | 154 | } |
duke@1 | 155 | |
duke@1 | 156 | /** |
duke@1 | 157 | * Write the annotation type member footer. |
duke@1 | 158 | */ |
duke@1 | 159 | public void writeMemberFooter() { |
bpatel@233 | 160 | printMemberFooter(); |
duke@1 | 161 | } |
duke@1 | 162 | |
duke@1 | 163 | /** |
duke@1 | 164 | * Write the footer for the annotation type member documentation. |
duke@1 | 165 | * |
duke@1 | 166 | * @param classDoc the class that the annotation type member belong to. |
duke@1 | 167 | */ |
duke@1 | 168 | public void writeFooter(ClassDoc classDoc) { |
duke@1 | 169 | //No footer to write for annotation type member documentation |
duke@1 | 170 | } |
duke@1 | 171 | |
duke@1 | 172 | /** |
duke@1 | 173 | * Close the writer. |
duke@1 | 174 | */ |
duke@1 | 175 | public void close() throws IOException { |
duke@1 | 176 | writer.close(); |
duke@1 | 177 | } |
duke@1 | 178 | |
duke@1 | 179 | /** |
duke@1 | 180 | * {@inheritDoc} |
duke@1 | 181 | */ |
bpatel@243 | 182 | public void printSummaryLabel() { |
bpatel@243 | 183 | writer.printText("doclet.Annotation_Type_Required_Member_Summary"); |
bpatel@243 | 184 | } |
bpatel@243 | 185 | |
bpatel@243 | 186 | /** |
bpatel@243 | 187 | * {@inheritDoc} |
bpatel@243 | 188 | */ |
bpatel@243 | 189 | public void printTableSummary() { |
bpatel@243 | 190 | writer.tableIndexSummary(configuration().getText("doclet.Member_Table_Summary", |
bpatel@243 | 191 | configuration().getText("doclet.Annotation_Type_Required_Member_Summary"), |
bpatel@243 | 192 | configuration().getText("doclet.annotation_type_required_members"))); |
bpatel@243 | 193 | } |
bpatel@243 | 194 | |
bpatel@243 | 195 | public void printSummaryTableHeader(ProgramElementDoc member) { |
bpatel@243 | 196 | String[] header = new String[] { |
bpatel@243 | 197 | writer.getModifierTypeHeader(), |
bpatel@243 | 198 | configuration().getText("doclet.0_and_1", |
bpatel@243 | 199 | configuration().getText("doclet.Annotation_Type_Required_Member"), |
bpatel@243 | 200 | configuration().getText("doclet.Description")) |
bpatel@243 | 201 | }; |
bpatel@243 | 202 | writer.summaryTableHeader(header, "col"); |
duke@1 | 203 | } |
duke@1 | 204 | |
duke@1 | 205 | /** |
duke@1 | 206 | * {@inheritDoc} |
duke@1 | 207 | */ |
duke@1 | 208 | public void printSummaryAnchor(ClassDoc cd) { |
duke@1 | 209 | writer.anchor("annotation_type_required_element_summary"); |
duke@1 | 210 | } |
duke@1 | 211 | |
duke@1 | 212 | /** |
duke@1 | 213 | * {@inheritDoc} |
duke@1 | 214 | */ |
duke@1 | 215 | public void printInheritedSummaryAnchor(ClassDoc cd) { |
duke@1 | 216 | } // no such |
duke@1 | 217 | |
duke@1 | 218 | /** |
duke@1 | 219 | * {@inheritDoc} |
duke@1 | 220 | */ |
duke@1 | 221 | public void printInheritedSummaryLabel(ClassDoc cd) { |
duke@1 | 222 | // no such |
duke@1 | 223 | } |
duke@1 | 224 | |
duke@1 | 225 | /** |
duke@1 | 226 | * {@inheritDoc} |
duke@1 | 227 | */ |
duke@1 | 228 | protected void writeSummaryLink(int context, ClassDoc cd, ProgramElementDoc member) { |
bpatel@182 | 229 | writer.strong(); |
duke@1 | 230 | writer.printDocLink(context, (MemberDoc) member, member.name(), false); |
bpatel@182 | 231 | writer.strongEnd(); |
duke@1 | 232 | } |
duke@1 | 233 | |
duke@1 | 234 | /** |
duke@1 | 235 | * {@inheritDoc} |
duke@1 | 236 | */ |
duke@1 | 237 | protected void writeInheritedSummaryLink(ClassDoc cd, |
duke@1 | 238 | ProgramElementDoc member) { |
duke@1 | 239 | //Not applicable. |
duke@1 | 240 | } |
duke@1 | 241 | |
duke@1 | 242 | /** |
duke@1 | 243 | * {@inheritDoc} |
duke@1 | 244 | */ |
duke@1 | 245 | protected void printSummaryType(ProgramElementDoc member) { |
duke@1 | 246 | MemberDoc m = (MemberDoc)member; |
duke@1 | 247 | printModifierAndType(m, getType(m)); |
duke@1 | 248 | } |
duke@1 | 249 | |
duke@1 | 250 | /** |
duke@1 | 251 | * {@inheritDoc} |
duke@1 | 252 | */ |
duke@1 | 253 | protected void writeDeprecatedLink(ProgramElementDoc member) { |
duke@1 | 254 | writer.printDocLink(LinkInfoImpl.CONTEXT_MEMBER, |
duke@1 | 255 | (MemberDoc) member, ((MemberDoc)member).qualifiedName(), false); |
duke@1 | 256 | } |
duke@1 | 257 | |
duke@1 | 258 | /** |
duke@1 | 259 | * {@inheritDoc} |
duke@1 | 260 | */ |
duke@1 | 261 | protected void printNavSummaryLink(ClassDoc cd, boolean link) { |
duke@1 | 262 | if (link) { |
duke@1 | 263 | writer.printHyperLink("", "annotation_type_required_element_summary", |
duke@1 | 264 | configuration().getText("doclet.navAnnotationTypeRequiredMember")); |
duke@1 | 265 | } else { |
duke@1 | 266 | writer.printText("doclet.navAnnotationTypeRequiredMember"); |
duke@1 | 267 | } |
duke@1 | 268 | } |
duke@1 | 269 | |
duke@1 | 270 | /** |
duke@1 | 271 | * {@inheritDoc} |
duke@1 | 272 | */ |
duke@1 | 273 | protected void printNavDetailLink(boolean link) { |
duke@1 | 274 | if (link) { |
duke@1 | 275 | writer.printHyperLink("", "annotation_type_element_detail", |
duke@1 | 276 | configuration().getText("doclet.navAnnotationTypeMember")); |
duke@1 | 277 | } else { |
duke@1 | 278 | writer.printText("doclet.navAnnotationTypeMember"); |
duke@1 | 279 | } |
duke@1 | 280 | } |
duke@1 | 281 | |
duke@1 | 282 | /** |
duke@1 | 283 | * {@inheritDoc} |
duke@1 | 284 | */ |
duke@1 | 285 | public void writeDeprecated(MemberDoc member) { |
bpatel@233 | 286 | printDeprecated(member); |
duke@1 | 287 | } |
duke@1 | 288 | |
duke@1 | 289 | private Type getType(MemberDoc member) { |
duke@1 | 290 | if (member instanceof FieldDoc) { |
duke@1 | 291 | return ((FieldDoc) member).type(); |
duke@1 | 292 | } else { |
duke@1 | 293 | return ((MethodDoc) member).returnType(); |
duke@1 | 294 | } |
duke@1 | 295 | } |
duke@1 | 296 | } |