Contents | Package | Class | Tree | Index | |||
PREV | NEXT | SHOW LISTS | HIDE LISTS |
sun.tools.javadoc.doclets.HtmlWriter | +----sun.tools.javadoc.doclets.HtmlDocWriter
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 |
protected final sun.tools.javadoc.doclets.String htmlFilename
public static Configuration configuration
Constructor Detail |
public HtmlDocWriter(sun.tools.javadoc.doclets.String filename) throws sun.tools.javadoc.doclets.IOException
filename
- String file name.
Method Detail |
public void printHyperLink(sun.tools.javadoc.doclets.String link, sun.tools.javadoc.doclets.String where, sun.tools.javadoc.doclets.String tag)
link
- String name of the file.
where
- Position of the link in the file.
tag
- Tag for the link.
public void printTargetHyperLink(sun.tools.javadoc.doclets.String link, sun.tools.javadoc.doclets.String target, sun.tools.javadoc.doclets.String tag)
link
- String name of the file.
target
- Position of the link in the file.
tag
- Tag for the link.
public void printHyperLink(sun.tools.javadoc.doclets.String link, sun.tools.javadoc.doclets.String tag)
public void printClassLink(sun.tools.javadoc.doclets.ClassDoc cd, sun.tools.javadoc.doclets.String where, sun.tools.javadoc.doclets.String tag)
public void printClassLink(sun.tools.javadoc.doclets.ClassDoc cd, sun.tools.javadoc.doclets.String tag)
public void printClassLink(sun.tools.javadoc.doclets.ClassDoc cd)
public void printQualifiedClassLink(sun.tools.javadoc.doclets.ClassDoc cd)
public void printPreQualifiedClassLink(sun.tools.javadoc.doclets.ClassDoc cd)
public void printTargetClassLink(sun.tools.javadoc.doclets.ClassDoc cd, sun.tools.javadoc.doclets.String target)
public void printMemberHyperLink(sun.tools.javadoc.doclets.String link, sun.tools.javadoc.doclets.String tag)
public void printPackageLink(sun.tools.javadoc.doclets.PackageDoc pkg, sun.tools.javadoc.doclets.String linkLabel)
public void printPackageLink(sun.tools.javadoc.doclets.PackageDoc pkg)
public void printHeader(sun.tools.javadoc.doclets.String title)
title
- String title for the generated html file.
public void printPartialHeader(sun.tools.javadoc.doclets.String title)
public void printUserHeaderFooter(boolean header)
header
- boolean if true print the header else footer.
public sun.tools.javadoc.doclets.String spaces(int len)
public void printNbsps()
public void printBottom()
public void printFooter()
public void printImage(sun.tools.javadoc.doclets.String imggif, sun.tools.javadoc.doclets.String imgname, int width, int height)
protected void printSeeTags(sun.tools.javadoc.doclets.Doc doc)
doc
- Doc doc
protected void navGap()
protected void navLinks(boolean header)
protected void navLinkContents()
protected void navLinkPackage(sun.tools.javadoc.doclets.PackageDoc pkg)
protected void navLinkPackage()
public void navLinkPrevious(sun.tools.javadoc.doclets.String prev)
next
- String previous link name
protected void navLinkPrevious()
public void navLinkNext(sun.tools.javadoc.doclets.String next)
next
- String next link name
protected void navLinkNext()
protected void navShowLists(sun.tools.javadoc.doclets.String link)
protected void navShowLists()
protected void navHideLists(sun.tools.javadoc.doclets.String link)
protected void navHideLists()
protected void navLinkTree(sun.tools.javadoc.doclets.PackageDoc pkg)
protected void navLinkMainTree(sun.tools.javadoc.doclets.String link)
protected void navLinkTree()
protected void navLinkClass()
protected void navLinkDeprecated()
protected void navLinkIndex()
protected void navLinkHelp()
public void printText(sun.tools.javadoc.doclets.String key)
public void printText(sun.tools.javadoc.doclets.String key, sun.tools.javadoc.doclets.String a1)
public void boldText(sun.tools.javadoc.doclets.String key)
public sun.tools.javadoc.doclets.String firstSentence(sun.tools.javadoc.doclets.String s)
protected void generateTagInfo(sun.tools.javadoc.doclets.Doc doc)
public sun.tools.javadoc.doclets.String today()
public static sun.tools.javadoc.doclets.String getText(sun.tools.javadoc.doclets.String key)
key
- selects message from resource
public static sun.tools.javadoc.doclets.String getText(sun.tools.javadoc.doclets.String key, sun.tools.javadoc.doclets.String a1)
key
- selects message from resource
a1
- first argument
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)
key
- selects message from resource
a1
- first argument
a2
- second argument
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)
key
- selects message from resource
a1
- first argument
a2
- second argument
a3
- third argument
public static void error(sun.tools.javadoc.doclets.String key)
key
- selects message from resource
public static void error(sun.tools.javadoc.doclets.String key, sun.tools.javadoc.doclets.String a1)
key
- selects message from resource
a1
- first argument
public static void error(sun.tools.javadoc.doclets.String key, sun.tools.javadoc.doclets.String a1, sun.tools.javadoc.doclets.String a2)
key
- selects message from resource
a1
- first argument
a2
- second argument
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)
key
- selects message from resource
a1
- first argument
a2
- second argument
a3
- third argument
public static void warning(sun.tools.javadoc.doclets.String key)
key
- selects message from resource
public static void warning(sun.tools.javadoc.doclets.String key, sun.tools.javadoc.doclets.String a1)
key
- selects message from resource
a1
- first argument
public static void warning(sun.tools.javadoc.doclets.String key, sun.tools.javadoc.doclets.String a1, sun.tools.javadoc.doclets.String a2)
key
- selects message from resource
a1
- first argument
a2
- second argument
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)
key
- selects message from resource
a1
- first argument
a2
- second argument
a3
- third argument
public static void notice(sun.tools.javadoc.doclets.String key)
key
- selects message from resource
public static void notice(sun.tools.javadoc.doclets.String key, sun.tools.javadoc.doclets.String a1)
key
- selects message from resource
a1
- first argument
public static void notice(sun.tools.javadoc.doclets.String key, sun.tools.javadoc.doclets.String a1, sun.tools.javadoc.doclets.String a2)
key
- selects message from resource
a1
- first argument
a2
- second argument
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)
key
- selects message from resource
a1
- first argument
a2
- second argument
a3
- third argument
public void td(boolean width)
public void table()
public void tableEnd()
public void tableIndexSummary()
public void tableIndexDetail()
public void tablePackageFrame()
public void tdIndex()
public void tableHeaderStart(sun.tools.javadoc.doclets.String color, int span)
public void tableInheritedHeaderStart()
public void tableHeaderStart(sun.tools.javadoc.doclets.String color)
public void tableHeaderStart(int span)
public void tableHeaderStart()
public void tableHeaderEnd()
public void summaryRow(int width)
public void summaryRowEnd()
public void printIndexHeading(sun.tools.javadoc.doclets.String str)
public void frameSet(sun.tools.javadoc.doclets.String arg)
public void frameSetEnd()
public void frame(sun.tools.javadoc.doclets.String arg)
public void frameEnd()
public void td(sun.tools.javadoc.doclets.String str)
Contents | Package | Class | Tree | Index | |||
PREV | NEXT | SHOW LISTS | HIDE LISTS |