home *** CD-ROM | disk | FTP | other *** search
/ Internet News 1999 October / INEWS_10_CD.ISO / pc / jdk / jdk1.2.2 / docs / tooldocs / javadoc / source / standard / FieldSubWriter.java < prev    next >
Encoding:
Java Source  |  1999-09-19  |  3.9 KB  |  131 lines
  1. /*
  2.  * @(#)FieldSubWriter.java    1.15 98/07/17
  3.  *
  4.  * Copyright 1997, 1998 by Sun Microsystems, Inc.,
  5.  * 901 San Antonio Road, Palo Alto, California, 94303, U.S.A.
  6.  * All rights reserved.
  7.  *
  8.  * This software is the confidential and proprietary information
  9.  * of Sun Microsystems, Inc. ("Confidential Information").  You
  10.  * shall not disclose such Confidential Information and shall use
  11.  * it only in accordance with the terms of the license agreement
  12.  * you entered into with Sun.
  13.  */
  14.  
  15. package com.sun.tools.doclets.standard;
  16.  
  17. import com.sun.tools.doclets.*;
  18. import com.sun.javadoc.*;
  19.  
  20. /**
  21.  *
  22.  * @author Robert Field
  23.  * @author Atul M Dambalkar
  24.  */
  25. public class FieldSubWriter extends AbstractSubWriter {
  26.  
  27.     FieldSubWriter(SubWriterHolderWriter writer) {
  28.         super(writer);
  29.     }
  30.  
  31.     public ProgramElementDoc[] members(ClassDoc cd) {
  32.         return eligibleMembers(cd.fields());
  33.     }
  34.  
  35.     public void printSummaryLabel(ClassDoc cd) {
  36.         writer.boldText("doclet.Field_Summary"); 
  37.     }
  38.  
  39.     public void printSummaryAnchor(ClassDoc cd) {
  40.         writer.anchor("field_summary");
  41.     }
  42.  
  43.     public void printInheritedSummaryAnchor(ClassDoc cd) {
  44.         writer.anchor("fields_inherited_from_class_" + cd.qualifiedName());
  45.     }
  46.  
  47.     public void printInheritedSummaryLabel(ClassDoc cd) {
  48.         String classlink = writer.getPreQualifiedClassLink(cd);
  49.         writer.bold();
  50.         writer.printText("doclet.Fields_Inherited_From_Class", classlink);
  51.         writer.boldEnd();
  52.     }
  53.  
  54.     void printSignature(MemberDoc member) {
  55.         FieldDoc field = (FieldDoc)member;
  56.     writer.pre();
  57.         printModifiers(field);
  58.         printTypeLink(field.type());
  59.         print(' ');
  60.         bold(field.name());
  61.     writer.preEnd();
  62.     }
  63.  
  64.     protected void printSummaryLink(ClassDoc cd, ProgramElementDoc member) {
  65.         String name = member.name();
  66.         ClassDoc mcd = member.containingClass();
  67.         writer.bold();
  68.         if (mcd != cd) {
  69.             writer.print(mcd.name() + ".");
  70.         }
  71.         writer.printClassLink(mcd, name, name, false);
  72.         writer.boldEnd();
  73.     }
  74.   
  75.     protected void printInheritedSummaryLink(ClassDoc cd, 
  76.                                              ProgramElementDoc member) {
  77.         String name = member.name();
  78.         writer.printClassLink(cd, name, name, false);
  79.     }
  80.  
  81.     protected void printSummaryType(ProgramElementDoc member) {
  82.         FieldDoc field = (FieldDoc)member;
  83.         printModifierAndType(field, field.type());
  84.     }
  85.  
  86.     protected void printHeader(ClassDoc cd) {
  87.         writer.anchor("field_detail");
  88.         writer.printTableHeadingBackground(writer.
  89.                                               getText("doclet.Field_Detail"));
  90.     }
  91.  
  92.     protected void printBodyHtmlEnd(ClassDoc cd) {
  93.     }
  94.  
  95.     protected void printMember(ProgramElementDoc member) {
  96.         FieldDoc field = (FieldDoc)member;
  97.         writer.anchor(field.name());
  98.         printHead(field);
  99.         printSignature(field);
  100.         printFullComment(field);
  101.     }
  102.  
  103.     protected void printDeprecatedLink(ProgramElementDoc member) {
  104.         writer.printClassLink(member.containingClass(), member.name(), 
  105.                               ((FieldDoc)member).qualifiedName());
  106.     }
  107.  
  108.     protected void printNavSummaryLink(ClassDoc cd, boolean link) {
  109.         if (link) {
  110.             writer.printHyperLink("", (cd == null)?
  111.                                           "field_summary":
  112.                                           "fields_inherited_from_class_" +
  113.                                            cd.qualifiedName(),
  114.                                   writer.getText("doclet.navField"));
  115.         } else {               
  116.             writer.printText("doclet.navField");
  117.         }
  118.     }
  119.  
  120.     protected void printNavDetailLink(boolean link) {
  121.         if (link) {
  122.             writer.printHyperLink("", "field_detail",
  123.                                   writer.getText("doclet.navField"));
  124.         } else {
  125.             writer.printText("doclet.navField");
  126.         } 
  127.     }
  128. }  
  129.     
  130.     
  131.