Contents | Package | Class | Tree | Index
PREV | NEXT SHOW LISTS | HIDE LISTS

Class sun.tools.javadoc.doclets.HtmlDocWriter

sun.tools.javadoc.doclets.HtmlWriter
    |
    +----sun.tools.javadoc.doclets.HtmlDocWriter
Subclasses:
AbstractIndexWriter, AbstractPackageIndexWriter, AbstractPackageWriter, AbstractTreeWriter, FrameOutputWriter, SubWriterHolderWriter

public class HtmlDocWriter
extends HtmlWriter
Class for the Html Format Code Generation specific to JavaDoc. This Class contains methods related to the Html Code Generation which are used by the Sub-Classes: PackageIndexWriter, PackageWriter, ClassWriter which are Standard Doclets. Super-Class is HtmlWriter.

Since:
JDK1.2

Field Summary
static Configuration  configuration
          All the user given options on the command line.
sun.tools.javadoc.doclets.String  htmlFilename
           
 

Constructor Summary
 HtmlDocWriter(sun.tools.javadoc.doclets.String filename)
          Constructor.
 

Method Summary
void  boldText(sun.tools.javadoc.doclets.String key)
           
static void  error(sun.tools.javadoc.doclets.String key)
          Print error message, increment error count.
static void  error(sun.tools.javadoc.doclets.String key, sun.tools.javadoc.doclets.String a1)
          Print error message, increment error count.
static void  error(sun.tools.javadoc.doclets.String key, sun.tools.javadoc.doclets.String a1, sun.tools.javadoc.doclets.String a2)
          Print error message, increment error count.
static void  error(sun.tools.javadoc.doclets.String key, sun.tools.javadoc.doclets.String a1, sun.tools.javadoc.doclets.String a2, sun.tools.javadoc.doclets.String a3)
          Print error message, increment error count.
sun.tools.javadoc.doclets.String  firstSentence(sun.tools.javadoc.doclets.String s)
          Return the first sentence of a string, where a sentence ends with a period followed be white space.
void  frame(sun.tools.javadoc.doclets.String arg)
           
void  frameEnd()
           
void  frameSet(sun.tools.javadoc.doclets.String arg)
           
void  frameSetEnd()
           
void  generateTagInfo(sun.tools.javadoc.doclets.Doc doc)
          Print tag information
static sun.tools.javadoc.doclets.String  getText(sun.tools.javadoc.doclets.String key)
          get and format message string from resource
static sun.tools.javadoc.doclets.String  getText(sun.tools.javadoc.doclets.String key, sun.tools.javadoc.doclets.String a1)
          get and format message string from resource
static sun.tools.javadoc.doclets.String  getText(sun.tools.javadoc.doclets.String key, sun.tools.javadoc.doclets.String a1, sun.tools.javadoc.doclets.String a2)
          get and format message string from resource
static sun.tools.javadoc.doclets.String  getText(sun.tools.javadoc.doclets.String key, sun.tools.javadoc.doclets.String a1, sun.tools.javadoc.doclets.String a2, sun.tools.javadoc.doclets.String a3)
          get and format message string from resource
void  navGap()
           
void  navHideLists(sun.tools.javadoc.doclets.String link)
          Print hide lists switch
void  navHideLists()
          Print hide lists switch
void  navLinkClass()
          Print class page indicator
void  navLinkContents()
          Print packages contents link
void  navLinkDeprecated()
          Print deprecated API link
void  navLinkHelp()
          Print help file link, considering the user options.
void  navLinkIndex()
          Print link for generated index file, depending upon the user option.
void  navLinkMainTree(sun.tools.javadoc.doclets.String link)
          Print class/interface hierarchy link
void  navLinkNext(sun.tools.javadoc.doclets.String next)
          Print link for next file.
void  navLinkNext()
          Print next item link
void  navLinkPackage(sun.tools.javadoc.doclets.PackageDoc pkg)
          Print this package link
void  navLinkPackage()
          Print this package link
void  navLinkPrevious(sun.tools.javadoc.doclets.String prev)
          Print link for previous file.
void  navLinkPrevious()
          Print previous item link
void  navLinks(boolean header)
           
void  navLinkTree(sun.tools.javadoc.doclets.PackageDoc pkg)
           
void  navLinkTree()
          Print class/interface hierarchy link
void  navShowLists(sun.tools.javadoc.doclets.String link)
          Print show lists switch
void  navShowLists()
          Print show lists switch
static void  notice(sun.tools.javadoc.doclets.String key)
          Print a message.
static void  notice(sun.tools.javadoc.doclets.String key, sun.tools.javadoc.doclets.String a1)
          Print a message.
static void  notice(sun.tools.javadoc.doclets.String key, sun.tools.javadoc.doclets.String a1, sun.tools.javadoc.doclets.String a2)
          Print a message.
static void  notice(sun.tools.javadoc.doclets.String key, sun.tools.javadoc.doclets.String a1, sun.tools.javadoc.doclets.String a2, sun.tools.javadoc.doclets.String a3)
          Print a message.
void  printBottom()
          Print the user specified bottom.
void  printClassLink(sun.tools.javadoc.doclets.ClassDoc cd, sun.tools.javadoc.doclets.String where, sun.tools.javadoc.doclets.String tag)
          Print Class Link with the generated file name with position.
void  printClassLink(sun.tools.javadoc.doclets.ClassDoc cd, sun.tools.javadoc.doclets.String tag)
          Print Class Link with the generated file name without position.
void  printClassLink(sun.tools.javadoc.doclets.ClassDoc cd)
          Print Class link.
void  printFooter()
          Print the html file footer.
void  printHeader(sun.tools.javadoc.doclets.String title)
          Print the html file header.
void  printHyperLink(sun.tools.javadoc.doclets.String link, sun.tools.javadoc.doclets.String where, sun.tools.javadoc.doclets.String tag)
          Print Html Hyper Link.
void  printHyperLink(sun.tools.javadoc.doclets.String link, sun.tools.javadoc.doclets.String tag)
          Print link without positioning in the file.
void  printImage(sun.tools.javadoc.doclets.String imggif, sun.tools.javadoc.doclets.String imgname, int width, int height)
          Print the html tag for image with all the parameters.
void  printIndexHeading(sun.tools.javadoc.doclets.String str)
           
void  printMemberHyperLink(sun.tools.javadoc.doclets.String link, sun.tools.javadoc.doclets.String tag)
          Print class link.
void  printNbsps()
           
void  printPackageLink(sun.tools.javadoc.doclets.PackageDoc pkg, sun.tools.javadoc.doclets.String linkLabel)
          Print link for individual package file.
void  printPackageLink(sun.tools.javadoc.doclets.PackageDoc pkg)
          Print link for individual package file.
void  printPartialHeader(sun.tools.javadoc.doclets.String title)
          Print some part of the Html file header.
void  printPreQualifiedClassLink(sun.tools.javadoc.doclets.ClassDoc cd)
          Print Class link, with only class name as the link and prefixing plain package name.
void  printQualifiedClassLink(sun.tools.javadoc.doclets.ClassDoc cd)
          Print Class link, with tag as qualified name.
void  printSeeTags(sun.tools.javadoc.doclets.Doc doc)
          Print the see tags information given the doc comment.
void  printTargetClassLink(sun.tools.javadoc.doclets.ClassDoc cd, sun.tools.javadoc.doclets.String target)
          Print Class link, with target frame.
void  printTargetHyperLink(sun.tools.javadoc.doclets.String link, sun.tools.javadoc.doclets.String target, sun.tools.javadoc.doclets.String tag)
          Print Html Hyper Link, with target frame.
void  printText(sun.tools.javadoc.doclets.String key)
           
void  printText(sun.tools.javadoc.doclets.String key, sun.tools.javadoc.doclets.String a1)
           
void  printUserHeaderFooter(boolean header)
          Print user specified header and the footer.
sun.tools.javadoc.doclets.String  spaces(int len)
          Print the appropriate spaces to format the class tree in the class page.
void  summaryRow(int width)
           
void  summaryRowEnd()
           
void  table()
          Just sufficient to take care of the 1.1 output format Can be modified further
void  tableEnd()
           
void  tableHeaderEnd()
           
void  tableHeaderStart(sun.tools.javadoc.doclets.String color, int span)
           
void  tableHeaderStart(sun.tools.javadoc.doclets.String color)
           
void  tableHeaderStart(int span)
           
void  tableHeaderStart()
           
void  tableIndexDetail()
           
void  tableIndexSummary()
           
void  tableInheritedHeaderStart()
           
void  tablePackageFrame()
           
void  td(boolean width)
          Just sufficient to take care of the 1.1 output format Can be modified further
void  td(sun.tools.javadoc.doclets.String str)
           
void  tdIndex()
           
sun.tools.javadoc.doclets.String  today()
          Print the today info., depending upon user option
static void  warning(sun.tools.javadoc.doclets.String key)
          Print warning message, increment warning count.
static void  warning(sun.tools.javadoc.doclets.String key, sun.tools.javadoc.doclets.String a1)
          Print warning message, increment warning count.
static void  warning(sun.tools.javadoc.doclets.String key, sun.tools.javadoc.doclets.String a1, sun.tools.javadoc.doclets.String a2)
          Print warning message, increment warning count.
static void  warning(sun.tools.javadoc.doclets.String key, sun.tools.javadoc.doclets.String a1, sun.tools.javadoc.doclets.String a2, sun.tools.javadoc.doclets.String a3)
          Print warning message, increment warning count.
 
Methods inherited from class sun.tools.javadoc.doclets.HtmlWriter
 address, addressEnd, aEnd, aName, anchor, anchor, body, body, bodyEnd, bold, bold, boldEnd, br, center, centerEnd, code, codeEnd, dd, ddEnd, dl, dlEnd, dt, em, emEnd, font, fontColor, fontEnd, h1, h1, h1End, h2, h2, h2End, h3, h3, h3End, h4, h4, h4End, h5, h5End, head, headEnd, hr, hr, html, htmlEnd, img, italics, li, li, menu, menuEnd, p, pre, preEnd, space, sup, supEnd, td, tdAlign, tdAlignRowspan, tdColspan, tdEnd, title, titleEnd, tr, trBgcolor, trEnd, ul, ulEnd
 

Field Detail

htmlFilename

protected final sun.tools.javadoc.doclets.String htmlFilename

configuration

public static Configuration configuration
          All the user given options on the command line.
Constructor Detail

HtmlDocWriter

public HtmlDocWriter(sun.tools.javadoc.doclets.String filename) throws sun.tools.javadoc.doclets.IOException
          Constructor. Initializes the destination file name through1 the super class HtmlWriter.A
Parameters:
filename - String file name.
Method Detail

printHyperLink

public void printHyperLink(sun.tools.javadoc.doclets.String link,
                           sun.tools.javadoc.doclets.String where,
                           sun.tools.javadoc.doclets.String tag)
          Print Html Hyper Link.
Parameters:
link - String name of the file.
where - Position of the link in the file.
tag - Tag for the link.

printTargetHyperLink

public void printTargetHyperLink(sun.tools.javadoc.doclets.String link,
                                 sun.tools.javadoc.doclets.String target,
                                 sun.tools.javadoc.doclets.String tag)
          Print Html Hyper Link, with target frame.
Parameters:
link - String name of the file.
target - Position of the link in the file.
tag - Tag for the link.

printHyperLink

public void printHyperLink(sun.tools.javadoc.doclets.String link,
                           sun.tools.javadoc.doclets.String tag)
          Print link without positioning in the file.

printClassLink

public void printClassLink(sun.tools.javadoc.doclets.ClassDoc cd,
                           sun.tools.javadoc.doclets.String where,
                           sun.tools.javadoc.doclets.String tag)
          Print Class Link with the generated file name with position.

printClassLink

public void printClassLink(sun.tools.javadoc.doclets.ClassDoc cd,
                           sun.tools.javadoc.doclets.String tag)
          Print Class Link with the generated file name without position.

printClassLink

public void printClassLink(sun.tools.javadoc.doclets.ClassDoc cd)
          Print Class link.

printQualifiedClassLink

public void printQualifiedClassLink(sun.tools.javadoc.doclets.ClassDoc cd)
          Print Class link, with tag as qualified name.

printPreQualifiedClassLink

public void printPreQualifiedClassLink(sun.tools.javadoc.doclets.ClassDoc cd)
          Print Class link, with only class name as the link and prefixing plain package name.

printTargetClassLink

public void printTargetClassLink(sun.tools.javadoc.doclets.ClassDoc cd,
                                 sun.tools.javadoc.doclets.String target)
          Print Class link, with target frame.

printMemberHyperLink

public void printMemberHyperLink(sun.tools.javadoc.doclets.String link,
                                 sun.tools.javadoc.doclets.String tag)
          Print class link.

printPackageLink

public void printPackageLink(sun.tools.javadoc.doclets.PackageDoc pkg,
                             sun.tools.javadoc.doclets.String linkLabel)
          Print link for individual package file.

printPackageLink

public void printPackageLink(sun.tools.javadoc.doclets.PackageDoc pkg)
          Print link for individual package file.

printHeader

public void printHeader(sun.tools.javadoc.doclets.String title)
          Print the html file header.
Parameters:
title - String title for the generated html file.

printPartialHeader

public void printPartialHeader(sun.tools.javadoc.doclets.String title)
          Print some part of the Html file header.

printUserHeaderFooter

public void printUserHeaderFooter(boolean header)
          Print user specified header and the footer.
Parameters:
header - boolean if true print the header else footer.

spaces

public sun.tools.javadoc.doclets.String spaces(int len)
          Print the appropriate spaces to format the class tree in the class page.

printNbsps

public void printNbsps()

printBottom

public void printBottom()
          Print the user specified bottom.

printFooter

public void printFooter()
          Print the html file footer. If there is a user given footer, use it or else print standard html completion.

printImage

public void printImage(sun.tools.javadoc.doclets.String imggif,
                       sun.tools.javadoc.doclets.String imgname,
                       int width,
                       int height)
          Print the html tag for image with all the parameters.

printSeeTags

protected void printSeeTags(sun.tools.javadoc.doclets.Doc doc)
          Print the see tags information given the doc comment.
Parameters:
doc - Doc doc
See Also:
sun.tools.javadoc.Doc

navGap

protected void navGap()

navLinks

protected void navLinks(boolean header)

navLinkContents

protected void navLinkContents()
          Print packages contents link

navLinkPackage

protected void navLinkPackage(sun.tools.javadoc.doclets.PackageDoc pkg)
          Print this package link

navLinkPackage

protected void navLinkPackage()
          Print this package link

navLinkPrevious

public void navLinkPrevious(sun.tools.javadoc.doclets.String prev)
          Print link for previous file.
Parameters:
next - String previous link name

navLinkPrevious

protected void navLinkPrevious()
          Print previous item link

navLinkNext

public void navLinkNext(sun.tools.javadoc.doclets.String next)
          Print link for next file.
Parameters:
next - String next link name

navLinkNext

protected void navLinkNext()
          Print next item link

navShowLists

protected void navShowLists(sun.tools.javadoc.doclets.String link)
          Print show lists switch

navShowLists

protected void navShowLists()
          Print show lists switch

navHideLists

protected void navHideLists(sun.tools.javadoc.doclets.String link)
          Print hide lists switch

navHideLists

protected void navHideLists()
          Print hide lists switch

navLinkTree

protected void navLinkTree(sun.tools.javadoc.doclets.PackageDoc pkg)

navLinkMainTree

protected void navLinkMainTree(sun.tools.javadoc.doclets.String link)
          Print class/interface hierarchy link

navLinkTree

protected void navLinkTree()
          Print class/interface hierarchy link

navLinkClass

protected void navLinkClass()
          Print class page indicator

navLinkDeprecated

protected void navLinkDeprecated()
          Print deprecated API link

navLinkIndex

protected void navLinkIndex()
          Print link for generated index file, depending upon the user option.

navLinkHelp

protected void navLinkHelp()
          Print help file link, considering the user options.

printText

public void printText(sun.tools.javadoc.doclets.String key)

printText

public void printText(sun.tools.javadoc.doclets.String key,
                      sun.tools.javadoc.doclets.String a1)

boldText

public void boldText(sun.tools.javadoc.doclets.String key)

firstSentence

public sun.tools.javadoc.doclets.String firstSentence(sun.tools.javadoc.doclets.String s)
          Return the first sentence of a string, where a sentence ends with a period followed be white space.

generateTagInfo

protected void generateTagInfo(sun.tools.javadoc.doclets.Doc doc)
          Print tag information

today

public sun.tools.javadoc.doclets.String today()
          Print the today info., depending upon user option

getText

public static sun.tools.javadoc.doclets.String getText(sun.tools.javadoc.doclets.String key)
          get and format message string from resource
Parameters:
key - selects message from resource

getText

public static sun.tools.javadoc.doclets.String getText(sun.tools.javadoc.doclets.String key,
                             sun.tools.javadoc.doclets.String a1)
          get and format message string from resource
Parameters:
key - selects message from resource
a1 - first argument

getText

public static sun.tools.javadoc.doclets.String getText(sun.tools.javadoc.doclets.String key,
                             sun.tools.javadoc.doclets.String a1,
                             sun.tools.javadoc.doclets.String a2)
          get and format message string from resource
Parameters:
key - selects message from resource
a1 - first argument
a2 - second argument

getText

public static sun.tools.javadoc.doclets.String getText(sun.tools.javadoc.doclets.String key,
                             sun.tools.javadoc.doclets.String a1,
                             sun.tools.javadoc.doclets.String a2,
                             sun.tools.javadoc.doclets.String a3)
          get and format message string from resource
Parameters:
key - selects message from resource
a1 - first argument
a2 - second argument
a3 - third argument

error

public static void error(sun.tools.javadoc.doclets.String key)
          Print error message, increment error count.
Parameters:
key - selects message from resource

error

public static void error(sun.tools.javadoc.doclets.String key,
                         sun.tools.javadoc.doclets.String a1)
          Print error message, increment error count.
Parameters:
key - selects message from resource
a1 - first argument

error

public static void error(sun.tools.javadoc.doclets.String key,
                         sun.tools.javadoc.doclets.String a1,
                         sun.tools.javadoc.doclets.String a2)
          Print error message, increment error count.
Parameters:
key - selects message from resource
a1 - first argument
a2 - second argument

error

public static void error(sun.tools.javadoc.doclets.String key,
                         sun.tools.javadoc.doclets.String a1,
                         sun.tools.javadoc.doclets.String a2,
                         sun.tools.javadoc.doclets.String a3)
          Print error message, increment error count.
Parameters:
key - selects message from resource
a1 - first argument
a2 - second argument
a3 - third argument

warning

public static void warning(sun.tools.javadoc.doclets.String key)
          Print warning message, increment warning count.
Parameters:
key - selects message from resource

warning

public static void warning(sun.tools.javadoc.doclets.String key,
                           sun.tools.javadoc.doclets.String a1)
          Print warning message, increment warning count.
Parameters:
key - selects message from resource
a1 - first argument

warning

public static void warning(sun.tools.javadoc.doclets.String key,
                           sun.tools.javadoc.doclets.String a1,
                           sun.tools.javadoc.doclets.String a2)
          Print warning message, increment warning count.
Parameters:
key - selects message from resource
a1 - first argument
a2 - second argument

warning

public static void warning(sun.tools.javadoc.doclets.String key,
                           sun.tools.javadoc.doclets.String a1,
                           sun.tools.javadoc.doclets.String a2,
                           sun.tools.javadoc.doclets.String a3)
          Print warning message, increment warning count.
Parameters:
key - selects message from resource
a1 - first argument
a2 - second argument
a3 - third argument

notice

public static void notice(sun.tools.javadoc.doclets.String key)
          Print a message.
Parameters:
key - selects message from resource

notice

public static void notice(sun.tools.javadoc.doclets.String key,
                          sun.tools.javadoc.doclets.String a1)
          Print a message.
Parameters:
key - selects message from resource
a1 - first argument

notice

public static void notice(sun.tools.javadoc.doclets.String key,
                          sun.tools.javadoc.doclets.String a1,
                          sun.tools.javadoc.doclets.String a2)
          Print a message.
Parameters:
key - selects message from resource
a1 - first argument
a2 - second argument

notice

public static void notice(sun.tools.javadoc.doclets.String key,
                          sun.tools.javadoc.doclets.String a1,
                          sun.tools.javadoc.doclets.String a2,
                          sun.tools.javadoc.doclets.String a3)
          Print a message.
Parameters:
key - selects message from resource
a1 - first argument
a2 - second argument
a3 - third argument

td

public void td(boolean width)
          Just sufficient to take care of the 1.1 output format Can be modified further

table

public void table()
          Just sufficient to take care of the 1.1 output format Can be modified further

tableEnd

public void tableEnd()

tableIndexSummary

public void tableIndexSummary()

tableIndexDetail

public void tableIndexDetail()

tablePackageFrame

public void tablePackageFrame()

tdIndex

public void tdIndex()

tableHeaderStart

public void tableHeaderStart(sun.tools.javadoc.doclets.String color,
                             int span)

tableInheritedHeaderStart

public void tableInheritedHeaderStart()

tableHeaderStart

public void tableHeaderStart(sun.tools.javadoc.doclets.String color)

tableHeaderStart

public void tableHeaderStart(int span)

tableHeaderStart

public void tableHeaderStart()

tableHeaderEnd

public void tableHeaderEnd()

summaryRow

public void summaryRow(int width)

summaryRowEnd

public void summaryRowEnd()

printIndexHeading

public void printIndexHeading(sun.tools.javadoc.doclets.String str)

frameSet

public void frameSet(sun.tools.javadoc.doclets.String arg)

frameSetEnd

public void frameSetEnd()

frame

public void frame(sun.tools.javadoc.doclets.String arg)

frameEnd

public void frameEnd()

td

public void td(sun.tools.javadoc.doclets.String str)

Contents | Package | Class | Tree | Index
PREV | NEXT SHOW LISTS | HIDE LISTS