| java.lang.Object
 java.io.Writer
java.io.PrintWriter
com.sun.tools.doclets.formats.html.markup.HtmlWriter
com.sun.tools.doclets.formats.html.markup.HtmlDocWriter
com.sun.tools.doclets.formats.html.HtmlDocletWriter
All known Subclasses: com.sun.tools.doclets.formats.html.AbstractIndexWriter, com.sun.tools.doclets.formats.html.AllClassesFrameWriter, com.sun.tools.doclets.formats.html.HelpWriter, com.sun.tools.doclets.formats.html.PackageWriterImpl, com.sun.tools.doclets.formats.html.AbstractPackageIndexWriter, com.sun.tools.doclets.formats.html.FrameOutputWriter, com.sun.tools.doclets.formats.html.AbstractTreeWriter, com.sun.tools.doclets.formats.html.PackageFrameWriter, com.sun.tools.doclets.formats.html.ConstantsSummaryWriterImpl, com.sun.tools.doclets.formats.html.SubWriterHolderWriter, com.sun.tools.doclets.formats.html.StylesheetWriter,
| HtmlDocletWriter | | public class HtmlDocletWriter extends HtmlDocWriter (Code) | | Class for the Html Format Code Generation specific to JavaDoc.
This Class contains methods related to the Html Code Generation which
are used extensively while generating the entire documentation.
since:
1.2
author:
Atul M Dambalkar
author:
Robert Field |
| Field Summary | |
| public ConfigurationImpl | configuration
The global configuration information for this run. | | public int | displayLength
The display length used for indentation while generating the class page. | | public String | filename
Name of the file getting generated. | | public String | path
Platform-dependent directory path from the current or the
destination directory to the file getting generated. | | public String | relativePath
Relative path from the file getting generated to the destination
directory. | | public String | relativepathNoSlash
Same as relativepath, but normalized to never be empty or
end with a slash. |
| Method Summary | |
| public void | anchor(ExecutableMemberDoc emd)
| | public void | boldText(String key)
| | public void | boldText(String key, String a1)
| | public void | boldText(String key, String a1, String a2)
| | public String | commentTagsToString(Tag holderTag, Doc doc, Tag[] tags, boolean isFirstSentence)
Converts inline tags and text to text strings, expanding the
inline tags along the way. | | public Configuration | configuration()
Return the configuation for this doclet. | | public void | frame(String arg)
Print Html tag <FRAME=arg>. | | public void | frameEnd()
Print Html closing tag </FRAME>. | | public void | frameSet(String arg)
Print Html tag <FRAMESET=arg>. | | public void | frameSetEnd()
Print Html closing tag </FRAMESET>. | | public String | getAnchor(ExecutableMemberDoc emd)
| | public String | getCrossClassLink(String qualifiedClassName, String refMemName, String label, boolean bold, String style, boolean code)
Return a class cross link to external class documentation.
The name must be fully qualified to determine which package
the class is in. | | public String | getCrossPackageLink(String pkgName)
| | public String | getDocLink(int context, MemberDoc doc, String label, boolean bold)
Return the link for the given member.
Parameters:
context - the id of the context where the link will be printed.
Parameters:
doc - the member being linked to.
Parameters:
label - the label for the link.
Parameters:
bold - true if the link should be bold. | | public String | getDocLink(int context, ClassDoc classDoc, MemberDoc doc, String label, boolean bold)
Return the link for the given member.
Parameters:
context - the id of the context where the link will be printed.
Parameters:
classDoc - the classDoc that we should link to. | | public String | getLink(LinkInfoImpl linkInfo)
Return the link to the given class.
Parameters:
linkInfo - the information about the link. | | public String | getPackageLink(PackageDoc pkg, String label, boolean isBold)
Return the link to the given package.
Parameters:
pkg - the package to link to.
Parameters:
label - the label for the link.
Parameters:
isBold - true if the label should be bold. | | public String | getPackageLink(PackageDoc pkg, String label, boolean isBold, String style)
Return the link to the given package.
Parameters:
pkg - the package to link to.
Parameters:
label - the label for the link.
Parameters:
isBold - true if the label should be bold.
Parameters:
style - the font of the package link label. | | public String | getPreQualifiedClassLink(int context, ClassDoc cd, boolean isBold)
Retrieve the class link with the package portion of the label in
plain text. | | public TagletWriter | getTagletWriterInstance(boolean isFirstSentence)
Returns a TagletWriter that knows how to write HTML. | | public String | getTypeParameterLinks(LinkInfoImpl linkInfo)
Return the type parameters for the given class.
Parameters:
linkInfo - the information about the link. | | public boolean | isClassLinkable(ClassDoc cd)
| | public boolean | isCoreClass(ClassDoc cd)
According to the Java Language Specifications, all the outer classes
and static nested classes are core classes. | | public String | italicsClassName(ClassDoc cd, boolean qual)
| | protected void | navCellEnd()
Closing tag for navigation bar cell. | | protected void | navCellRevStart()
Description for a cell in the navigation bar, but with reverse
high-light effect. | | protected void | navCellStart()
Description for a cell in the navigation bar. | | protected void | navDetail()
Print the word "Detail" in the navigation bar. | | protected void | navHideLists(String link)
Print "NO FRAMES" link, to switch to the non-frame version of the output. | | protected void | navLinkClass()
Print the word "Class" in the navigation bar cell, to indicate that
class link is not available. | | protected void | navLinkClassIndex()
Print link for generated index. | | protected void | navLinkClassUse()
Print the word "Use" in the navigation bar cell, to indicate that link
is not available. | | protected void | navLinkContents()
Print link to the "overview-summary.html" page. | | protected void | navLinkDeprecated()
Print "Deprecated" API link in the navigation bar. | | protected void | navLinkHelp()
Print help file link. | | protected void | navLinkIndex()
Print link for generated class index. | | protected void | navLinkMainTree(String label)
Print "Tree" link to the "overview-tree.html" file. | | protected void | navLinkNext()
Print the word "NEXT" to indicate that no link is available. | | public void | navLinkNext(String next)
Print link for next file. | | protected void | navLinkPackage(PackageDoc pkg)
Print link to the "package-summary.html" page for the package passed. | | protected void | navLinkPackage()
Print the word "Package" in the navigation bar cell, to indicate that
link is not available here. | | protected void | navLinkPrevious()
Print the word "PREV" to indicate that no link is available. | | public void | navLinkPrevious(String prev)
Print link for previous file. | | protected void | navLinkTree()
Print "Tree" link in the navigation bar. | | protected void | navLinks(boolean header)
Print the navigation bar for the Html page at the top and and the bottom. | | protected void | navShowLists(String link)
Print "FRAMES" link, to switch to the frame version of the output. | | protected void | navShowLists()
Print "FRAMES" link, to switch to the frame version of the output. | | protected void | navSummary()
Print the word "Summary" in the navigation bar. | | protected String | pathString(ClassDoc cd, String name)
Return the path to the class page for a classdoc. | | protected String | pathString(PackageDoc pd, String name)
Return path to the given file name in the given package. | | protected String | pathToClass(ClassDoc cd)
Return path to the class page for a classdoc. | | public void | printBottom()
Print the user specified bottom. | | public void | printDocLink(int context, MemberDoc doc, String label, boolean bold)
Print the link for the given member. | | public void | printDocLink(int context, ClassDoc classDoc, MemberDoc doc, String label, boolean bold)
Print the link for the given member.
Parameters:
context - the id of the context where the link will be printed.
Parameters:
classDoc - the classDoc that we should link to. | | public void | printHtmlHeader(String title, String[] metakeywords, boolean includeScript)
Print the html file header. | | public void | printIndexHeading(String str)
Print the heading in Html <H2> format. | | public void | printInlineComment(Doc doc, Tag tag)
| | public void | printInlineComment(Doc doc)
| | public void | printInlineDeprecatedComment(Doc doc, Tag tag)
| | public void | printInlineDeprecatedComment(Doc doc)
| | public void | printLink(LinkInfoImpl linkInfo)
Print the link to the given class. | | public void | printNoFramesTargetHyperLink(String link, String where, String target, String label, boolean bold)
Print Html Hyper Link, with target frame. | | public void | printPackageLink(PackageDoc pkg, String label, boolean isBold)
Print the link to the given package. | | public void | printPackageLink(PackageDoc pkg, String label, boolean isBold, String style)
Print the link to the given package. | | public void | printPreQualifiedBoldClassLink(int context, ClassDoc cd)
Print Class link, with only class name as the bold link and prefixing
plain package name. | | public void | printPreQualifiedClassLink(int context, ClassDoc cd)
Print Class link, with only class name as the link and prefixing
plain package name. | | public void | printQualifiedClassLink(int context, ClassDoc cd)
| | public void | printSrcLink(ProgramElementDoc d, String label)
| | public void | printStyleSheetProperties()
| | public void | printSummaryComment(Doc doc)
| | public void | printSummaryComment(Doc doc, Tag[] firstSentenceTags)
| | public void | printSummaryDeprecatedComment(Doc doc)
| | public void | printSummaryDeprecatedComment(Doc doc, Tag tag)
| | protected void | printSummaryDetailLinks()
Do nothing. | | protected void | printTags(Doc doc)
| | protected void | printTagsInfoFooter()
| | protected void | printTagsInfoHeader()
| | public void | printTargetPackageLink(PackageDoc pd, String target, String label)
Print Package link, with target frame. | | public void | printText(String key)
| | public void | printText(String key, String a1)
| | public void | printText(String key, String a1, String a2)
| | public void | printTop()
Print the user specified top. | | public void | printUserHeaderFooter(boolean header)
Print user specified header and the footer. | | public String | removeNonInlineHtmlTags(String text)
| | public String | replace(String text, String tobe, String by)
| | public String | replaceDocRootDir(String htmlstr)
Replace {@docRoot} tag used in options that accept HTML text, such
as -header, -footer, -top and -bottom, and when converting a relative
HREF where commentTagsToString inserts a {@docRoot} where one was
missing. | | public String | seeTagToString(SeeTag see)
| | public void | summaryRow(int width)
Print the summary table row cell attribute width. | | public void | summaryRowEnd()
Print the summary table row cell end tag. | | public void | tableHeaderEnd()
Print table header end tags for font, column and row. | | public void | tableHeaderStart(String color, int span)
Prine table header information about color, column span and the font. | | public void | tableHeaderStart(String color)
Print table header with the background color with default column span 2. | | public void | tableHeaderStart(int span)
Print table header with the column span, with the default color #CCCCFF. | | public void | tableHeaderStart()
Print table header with default column span 2 and default color #CCCCFF. | | public void | tableIndexDetail()
Same as
HtmlDocletWriter.tableIndexSummary() . | | public void | tableIndexSummary()
Print the Html table tag for the index summary tables. | | public void | tableInheritedHeaderEnd()
Print table header end tags in inherited tables for column and row. | | public void | tableInheritedHeaderStart(String color)
Print table header for the inherited members summary tables. | | public void | tableUseInfoHeaderStart(String color)
Print "Use" table header. | | public void | tdIndex()
Print Html tag for table elements. | | public void | writeAnnotationInfo(PackageDoc packageDoc)
Write the annotatation types for the given packageDoc. | | public void | writeAnnotationInfo(ProgramElementDoc doc)
Write the annotatation types for the given doc. | | public boolean | writeAnnotationInfo(int indent, Doc doc, Parameter param)
Write the annotatation types for the given doc and parameter. |
| displayLength | | public int displayLength(Code) | | The display length used for indentation while generating the class page.
|
| filename | | public String filename(Code) | | Name of the file getting generated. If the file getting generated is
"java/lang/Object.html", then the filename is "Object.html".
|
| path | | public String path(Code) | | Platform-dependent directory path from the current or the
destination directory to the file getting generated.
Used when creating the file.
For example, if the file getting generated is
"java/lang/Object.html", then the path string is "java/lang".
|
| relativePath | | public String relativePath(Code) | | Relative path from the file getting generated to the destination
directory. For example, if the file getting generated is
"java/lang/Object.html", then the relative path string is "../../".
This string can be empty if the file getting generated is in
the destination directory.
|
| relativepathNoSlash | | public String relativepathNoSlash(Code) | | Same as relativepath, but normalized to never be empty or
end with a slash.
|
| HtmlDocletWriter | | public HtmlDocletWriter(ConfigurationImpl configuration, String filename) throws IOException(Code) | | Constructor to construct the HtmlStandardWriter object.
Parameters:
filename - File to be generated. |
| anchor | | public void anchor(ExecutableMemberDoc emd)(Code) | | |
| commentTagsToString | | public String commentTagsToString(Tag holderTag, Doc doc, Tag[] tags, boolean isFirstSentence)(Code) | | Converts inline tags and text to text strings, expanding the
inline tags along the way. Called wherever text can contain
an inline tag, such as in comments or in free-form text arguments
to non-inline tags.
Parameters:
holderTag - specific tag where comment resides
Parameters:
doc - specific doc where comment resides
Parameters:
tags - array of text tags and inline tags (often alternating)present in the text of interest for this doc
Parameters:
isFirstSentence - true if text is first sentence |
| configuration | | public Configuration configuration()(Code) | | Return the configuation for this doclet.
the configuration for this doclet. |
| frame | | public void frame(String arg)(Code) | | Print Html tag <FRAME=arg>.
Parameters:
arg - Argument for the tag. |
| frameEnd | | public void frameEnd()(Code) | | Print Html closing tag </FRAME>.
|
| frameSet | | public void frameSet(String arg)(Code) | | Print Html tag <FRAMESET=arg>.
Parameters:
arg - Argument for the tag. |
| frameSetEnd | | public void frameSetEnd()(Code) | | Print Html closing tag </FRAMESET>.
|
| getAnchor | | public String getAnchor(ExecutableMemberDoc emd)(Code) | | |
| getCrossClassLink | | public String getCrossClassLink(String qualifiedClassName, String refMemName, String label, boolean bold, String style, boolean code)(Code) | | Return a class cross link to external class documentation.
The name must be fully qualified to determine which package
the class is in. The -link option does not allow users to
link to external classes in the "default" package.
Parameters:
qualifiedClassName - the qualified name of the external class.
Parameters:
refMemName - the name of the member being referenced. This shouldbe null or empty string if no member is being referenced.
Parameters:
label - the label for the external link.
Parameters:
bold - true if the link should be bold.
Parameters:
style - the style of the link.
Parameters:
code - true if the label should be code font. |
| getDocLink | | public String getDocLink(int context, MemberDoc doc, String label, boolean bold)(Code) | | Return the link for the given member.
Parameters:
context - the id of the context where the link will be printed.
Parameters:
doc - the member being linked to.
Parameters:
label - the label for the link.
Parameters:
bold - true if the link should be bold. the link for the given member. |
| getDocLink | | public String getDocLink(int context, ClassDoc classDoc, MemberDoc doc, String label, boolean bold)(Code) | | Return the link for the given member.
Parameters:
context - the id of the context where the link will be printed.
Parameters:
classDoc - the classDoc that we should link to. This is not necessarily equal to doc.containingClass(). We may beinheriting comments.
Parameters:
doc - the member being linked to.
Parameters:
label - the label for the link.
Parameters:
bold - true if the link should be bold. the link for the given member. |
| getLink | | public String getLink(LinkInfoImpl linkInfo)(Code) | | Return the link to the given class.
Parameters:
linkInfo - the information about the link. the link for the given class. |
| getPackageLink | | public String getPackageLink(PackageDoc pkg, String label, boolean isBold)(Code) | | Return the link to the given package.
Parameters:
pkg - the package to link to.
Parameters:
label - the label for the link.
Parameters:
isBold - true if the label should be bold. the link to the given package. |
| getPackageLink | | public String getPackageLink(PackageDoc pkg, String label, boolean isBold, String style)(Code) | | Return the link to the given package.
Parameters:
pkg - the package to link to.
Parameters:
label - the label for the link.
Parameters:
isBold - true if the label should be bold.
Parameters:
style - the font of the package link label. the link to the given package. |
| getPreQualifiedClassLink | | public String getPreQualifiedClassLink(int context, ClassDoc cd, boolean isBold)(Code) | | Retrieve the class link with the package portion of the label in
plain text. If the qualifier is excluded, it willnot be included in the
link label.
Parameters:
cd - the class to link to.
Parameters:
isBold - true if the link should be bold. the link with the package portion of the label in plain text. |
| getTagletWriterInstance | | public TagletWriter getTagletWriterInstance(boolean isFirstSentence)(Code) | | Returns a TagletWriter that knows how to write HTML.
a TagletWriter that knows how to write HTML. |
| getTypeParameterLinks | | public String getTypeParameterLinks(LinkInfoImpl linkInfo)(Code) | | Return the type parameters for the given class.
Parameters:
linkInfo - the information about the link. the type for the given class. |
| isClassLinkable | | public boolean isClassLinkable(ClassDoc cd)(Code) | | |
| isCoreClass | | public boolean isCoreClass(ClassDoc cd)(Code) | | According to the Java Language Specifications, all the outer classes
and static nested classes are core classes.
|
| italicsClassName | | public String italicsClassName(ClassDoc cd, boolean qual)(Code) | | |
| navCellEnd | | protected void navCellEnd()(Code) | | Closing tag for navigation bar cell.
|
| navCellRevStart | | protected void navCellRevStart()(Code) | | Description for a cell in the navigation bar, but with reverse
high-light effect.
|
| navCellStart | | protected void navCellStart()(Code) | | Description for a cell in the navigation bar.
|
| navDetail | | protected void navDetail()(Code) | | Print the word "Detail" in the navigation bar. No link is available.
|
| navHideLists | | protected void navHideLists(String link)(Code) | | Print "NO FRAMES" link, to switch to the non-frame version of the output.
Parameters:
link - File to be linked. |
| navLinkClass | | protected void navLinkClass()(Code) | | Print the word "Class" in the navigation bar cell, to indicate that
class link is not available.
|
| navLinkClassIndex | | protected void navLinkClassIndex()(Code) | | Print link for generated index. If the user has used "-splitindex"
command line option, then link to file "index-files/index-1.html" is
generated otherwise link to file "index-all.html" is generated.
|
| navLinkClassUse | | protected void navLinkClassUse()(Code) | | Print the word "Use" in the navigation bar cell, to indicate that link
is not available.
|
| navLinkContents | | protected void navLinkContents()(Code) | | Print link to the "overview-summary.html" page.
|
| navLinkDeprecated | | protected void navLinkDeprecated()(Code) | | Print "Deprecated" API link in the navigation bar.
|
| navLinkHelp | | protected void navLinkHelp()(Code) | | Print help file link. If user has provided a help file, then generate a
link to the user given file, which is already copied to current or
destination directory.
|
| navLinkIndex | | protected void navLinkIndex()(Code) | | Print link for generated class index.
|
| navLinkMainTree | | protected void navLinkMainTree(String label)(Code) | | Print "Tree" link to the "overview-tree.html" file.
|
| navLinkNext | | protected void navLinkNext()(Code) | | Print the word "NEXT" to indicate that no link is available. Override
this method to customize next link.
|
| navLinkNext | | public void navLinkNext(String next)(Code) | | Print link for next file. If next is null, just print the label
without linking it anywhere.
Parameters:
next - File name for the next link. |
| navLinkPackage | | protected void navLinkPackage(PackageDoc pkg)(Code) | | Print link to the "package-summary.html" page for the package passed.
Parameters:
pkg - Package to which link will be generated. |
| navLinkPackage | | protected void navLinkPackage()(Code) | | Print the word "Package" in the navigation bar cell, to indicate that
link is not available here.
|
| navLinkPrevious | | protected void navLinkPrevious()(Code) | | Print the word "PREV" to indicate that no link is available. Override
this method to customize prev link.
|
| navLinkPrevious | | public void navLinkPrevious(String prev)(Code) | | Print link for previous file.
Parameters:
prev - File name for the prev link. |
| navLinkTree | | protected void navLinkTree()(Code) | | Print "Tree" link in the navigation bar. If there is only one package
specified on the command line, then the "Tree" link will be to the
only "package-tree.html" file otherwise it will be to the
"overview-tree.html" file.
|
| navLinks | | protected void navLinks(boolean header)(Code) | | Print the navigation bar for the Html page at the top and and the bottom.
Parameters:
header - If true print navigation bar at the top of the page elseprint the nevigation bar at the bottom. |
| navShowLists | | protected void navShowLists(String link)(Code) | | Print "FRAMES" link, to switch to the frame version of the output.
Parameters:
link - File to be linked, "index.html". |
| navShowLists | | protected void navShowLists()(Code) | | Print "FRAMES" link, to switch to the frame version of the output.
|
| navSummary | | protected void navSummary()(Code) | | Print the word "Summary" in the navigation bar. No link is available.
|
| pathString | | protected String pathString(ClassDoc cd, String name)(Code) | | Return the path to the class page for a classdoc. Works same as
HtmlDocletWriter.pathToClass(ClassDoc) .
Parameters:
cd - Class to which the path is requested.
Parameters:
name - Name of the file(doesn't include path). |
| pathString | | protected String pathString(PackageDoc pd, String name)(Code) | | Return path to the given file name in the given package. So if the name
passed is "Object.html" and the name of the package is "java.lang", and
if the relative path is "../.." then returned string will be
"../../java/lang/Object.html"
Parameters:
pd - Package in which the file name is assumed to be.
Parameters:
name - File name, to which path string is. |
| pathToClass | | protected String pathToClass(ClassDoc cd)(Code) | | Return path to the class page for a classdoc. For example, the class
name is "java.lang.Object" and if the current file getting generated is
"java/io/File.html", then the path string to the class, returned is
"../../java/lang.Object.html".
Parameters:
cd - Class to which the path is requested. |
| printBottom | | public void printBottom()(Code) | | Print the user specified bottom.
|
| printDocLink | | public void printDocLink(int context, MemberDoc doc, String label, boolean bold)(Code) | | Print the link for the given member.
Parameters:
context - the id of the context where the link will be printed.
Parameters:
doc - the member being linked to.
Parameters:
label - the label for the link.
Parameters:
bold - true if the link should be bold. |
| printDocLink | | public void printDocLink(int context, ClassDoc classDoc, MemberDoc doc, String label, boolean bold)(Code) | | Print the link for the given member.
Parameters:
context - the id of the context where the link will be printed.
Parameters:
classDoc - the classDoc that we should link to. This is not necessarily equal to doc.containingClass(). We may beinheriting comments.
Parameters:
doc - the member being linked to.
Parameters:
label - the label for the link.
Parameters:
bold - true if the link should be bold. |
| printHtmlHeader | | public void printHtmlHeader(String title, String[] metakeywords, boolean includeScript)(Code) | | Print the html file header. Also print Html page title and stylesheet
default properties.
Parameters:
title - String window title to go in the <TITLE> tag
Parameters:
metakeywords - Array of String keywords for META tag. Each elementof the array is assigned to a separate META tag.Pass in null for no array.
Parameters:
includeScript - boolean true if printing windowtitle script.False for files that appear in the left-hand frames. |
| printIndexHeading | | public void printIndexHeading(String str)(Code) | | Print the heading in Html <H2> format.
Parameters:
str - The Header string. |
| printInlineComment | | public void printInlineComment(Doc doc, Tag tag)(Code) | | |
| printInlineComment | | public void printInlineComment(Doc doc)(Code) | | |
| printInlineDeprecatedComment | | public void printInlineDeprecatedComment(Doc doc, Tag tag)(Code) | | |
| printInlineDeprecatedComment | | public void printInlineDeprecatedComment(Doc doc)(Code) | | |
| printLink | | public void printLink(LinkInfoImpl linkInfo)(Code) | | Print the link to the given class.
|
| printNoFramesTargetHyperLink | | public void printNoFramesTargetHyperLink(String link, String where, String target, String label, boolean bold)(Code) | | Print Html Hyper Link, with target frame. This
link will only appear if page is not in a frame.
Parameters:
link - String name of the file.
Parameters:
where - Position in the file
Parameters:
target - Name of the target frame.
Parameters:
label - Tag for the link.
Parameters:
bold - Whether the label should be bold or not? |
| printPackageLink | | public void printPackageLink(PackageDoc pkg, String label, boolean isBold)(Code) | | Print the link to the given package.
Parameters:
pkg - the package to link to.
Parameters:
label - the label for the link.
Parameters:
isBold - true if the label should be bold. |
| printPackageLink | | public void printPackageLink(PackageDoc pkg, String label, boolean isBold, String style)(Code) | | Print the link to the given package.
Parameters:
pkg - the package to link to.
Parameters:
label - the label for the link.
Parameters:
isBold - true if the label should be bold.
Parameters:
style - the font of the package link label. |
| printPreQualifiedBoldClassLink | | public void printPreQualifiedBoldClassLink(int context, ClassDoc cd)(Code) | | Print Class link, with only class name as the bold link and prefixing
plain package name.
|
| printPreQualifiedClassLink | | public void printPreQualifiedClassLink(int context, ClassDoc cd)(Code) | | Print Class link, with only class name as the link and prefixing
plain package name.
|
| printQualifiedClassLink | | public void printQualifiedClassLink(int context, ClassDoc cd)(Code) | | |
| printSrcLink | | public void printSrcLink(ProgramElementDoc d, String label)(Code) | | |
| printStyleSheetProperties | | public void printStyleSheetProperties()(Code) | | |
| printSummaryComment | | public void printSummaryComment(Doc doc)(Code) | | |
| printSummaryComment | | public void printSummaryComment(Doc doc, Tag[] firstSentenceTags)(Code) | | |
| printSummaryDeprecatedComment | | public void printSummaryDeprecatedComment(Doc doc)(Code) | | |
| printSummaryDeprecatedComment | | public void printSummaryDeprecatedComment(Doc doc, Tag tag)(Code) | | |
| printSummaryDetailLinks | | protected void printSummaryDetailLinks()(Code) | | Do nothing. This is the default method.
|
| printTags | | protected void printTags(Doc doc)(Code) | | |
| printTagsInfoFooter | | protected void printTagsInfoFooter()(Code) | | |
| printTagsInfoHeader | | protected void printTagsInfoHeader()(Code) | | |
| printTargetPackageLink | | public void printTargetPackageLink(PackageDoc pd, String target, String label)(Code) | | Print Package link, with target frame.
Parameters:
pd - The link will be to the "package-summary.html" page for thispackage.
Parameters:
target - Name of the target frame.
Parameters:
label - Tag for the link. |
| printTop | | public void printTop()(Code) | | Print the user specified top.
|
| printUserHeaderFooter | | public void printUserHeaderFooter(boolean header)(Code) | | Print user specified header and the footer.
Parameters:
header - if true print the user provided header else print theuser provided footer. |
| replaceDocRootDir | | public String replaceDocRootDir(String htmlstr)(Code) | | Replace {@docRoot} tag used in options that accept HTML text, such
as -header, -footer, -top and -bottom, and when converting a relative
HREF where commentTagsToString inserts a {@docRoot} where one was
missing. (Also see DocRootTaglet for {@docRoot} tags in doc
comments.)
Replace {@docRoot} tag in htmlstr with the relative path to the
destination directory from the directory where the file is being
written, looping to handle all such tags in htmlstr.
For example, for "-d docs" and -header containing {@docRoot}, when
the HTML page for source file p/C1.java is being generated, the
{@docRoot} tag would be inserted into the header as "../",
the relative path from docs/p/ to docs/ (the document root).
Note: This doc comment was written with '@' representing '@'
to prevent the inline tag from being interpreted.
|
| seeTagToString | | public String seeTagToString(SeeTag see)(Code) | | |
| summaryRow | | public void summaryRow(int width)(Code) | | Print the summary table row cell attribute width.
Parameters:
width - Width of the table cell. |
| summaryRowEnd | | public void summaryRowEnd()(Code) | | Print the summary table row cell end tag.
|
| tableHeaderEnd | | public void tableHeaderEnd()(Code) | | Print table header end tags for font, column and row.
|
| tableHeaderStart | | public void tableHeaderStart(String color, int span)(Code) | | Prine table header information about color, column span and the font.
Parameters:
color - Background color.
Parameters:
span - Column span. |
| tableHeaderStart | | public void tableHeaderStart(String color)(Code) | | Print table header with the background color with default column span 2.
Parameters:
color - Background color. |
| tableHeaderStart | | public void tableHeaderStart(int span)(Code) | | Print table header with the column span, with the default color #CCCCFF.
Parameters:
span - Column span. |
| tableHeaderStart | | public void tableHeaderStart()(Code) | | Print table header with default column span 2 and default color #CCCCFF.
|
| tableIndexSummary | | public void tableIndexSummary()(Code) | | Print the Html table tag for the index summary tables. The table tag
printed is
<TABLE BORDER="1" CELLPADDING="3" CELLSPACING="0" WIDTH="100%">
|
| tableInheritedHeaderEnd | | public void tableInheritedHeaderEnd()(Code) | | Print table header end tags in inherited tables for column and row.
|
| tableInheritedHeaderStart | | public void tableInheritedHeaderStart(String color)(Code) | | Print table header for the inherited members summary tables. Print the
background color information.
Parameters:
color - Background color. |
| tableUseInfoHeaderStart | | public void tableUseInfoHeaderStart(String color)(Code) | | Print "Use" table header. Print the background color and the column span.
Parameters:
color - Background color. |
| tdIndex | | public void tdIndex()(Code) | | Print Html tag for table elements. The tag printed is
<TD ALIGN="right" VALIGN="top" WIDTH="1%">.
|
| writeAnnotationInfo | | public void writeAnnotationInfo(PackageDoc packageDoc)(Code) | | Write the annotatation types for the given packageDoc.
Parameters:
packageDoc - the package to write annotations for. |
| writeAnnotationInfo | | public void writeAnnotationInfo(ProgramElementDoc doc)(Code) | | Write the annotatation types for the given doc.
Parameters:
doc - the doc to write annotations for. |
| writeAnnotationInfo | | public boolean writeAnnotationInfo(int indent, Doc doc, Parameter param)(Code) | | Write the annotatation types for the given doc and parameter.
Parameters:
indent - the number of spaced to indent the parameters.
Parameters:
doc - the doc to write annotations for.
Parameters:
param - the parameter to write annotations for. |
| Methods inherited from com.sun.tools.doclets.formats.html.markup.HtmlDocWriter | abstract public Configuration configuration()(Code)(Java Doc)
public String getHyperLink(String link, String where, String label, boolean bold)(Code)(Java Doc)
public String getHyperLink(String link, String where, String label, boolean bold, String stylename)(Code)(Java Doc)
public String getHyperLink(String link, String where, String label, boolean bold, String stylename, String title, String target)(Code)(Java Doc)
public String getHyperLink(String link, String label)(Code)(Java Doc)
public String getPkgName(ClassDoc cd)(Code)(Java Doc)
public void printBodyHtmlEnd()(Code)(Java Doc)
public void printFooter()(Code)(Java Doc)
public void printFrameFooter()(Code)(Java Doc)
public void printFramesetHeader(String title)(Code)(Java Doc)
public void printFramesetHeader(String title, boolean noTimeStamp)(Code)(Java Doc)
public void printHyperLink(String link, String where, String label, boolean bold)(Code)(Java Doc)
public void printHyperLink(String link, String where, String label)(Code)(Java Doc)
public void printHyperLink(String link, String where, String label, boolean bold, String stylename)(Code)(Java Doc)
public void printHyperLink(String link, String label)(Code)(Java Doc)
public void printNbsps()(Code)(Java Doc)
public void printPkgName(ClassDoc cd)(Code)(Java Doc)
public String spaces(int len)(Code)(Java Doc)
public String today()(Code)(Java Doc)
|
| Methods inherited from com.sun.tools.doclets.formats.html.markup.HtmlWriter | public void aEnd()(Code)(Java Doc)
public void aName(String name)(Code)(Java Doc)
public void address()(Code)(Java Doc)
public void addressEnd()(Code)(Java Doc)
public void anchor(String name, String content)(Code)(Java Doc)
public void anchor(String name)(Code)(Java Doc)
public void blockquote()(Code)(Java Doc)
public void blockquoteEnd()(Code)(Java Doc)
public void body(String bgcolor, boolean includeScript)(Code)(Java Doc)
public void bodyEnd()(Code)(Java Doc)
public void bold()(Code)(Java Doc)
public void bold(String text)(Code)(Java Doc)
public void boldEnd()(Code)(Java Doc)
public void br()(Code)(Java Doc)
public void center()(Code)(Java Doc)
public void centerEnd()(Code)(Java Doc)
public void code()(Code)(Java Doc)
public void codeEnd()(Code)(Java Doc)
public String codeText(String text)(Code)(Java Doc)
public void commentEnd()(Code)(Java Doc)
public void commentStart()(Code)(Java Doc)
public void dd()(Code)(Java Doc)
public void ddEnd()(Code)(Java Doc)
public void dl()(Code)(Java Doc)
public void dlEnd()(Code)(Java Doc)
public void dt()(Code)(Java Doc)
public void em()(Code)(Java Doc)
public void emEnd()(Code)(Java Doc)
public void font(String size)(Code)(Java Doc)
public void fontEnd()(Code)(Java Doc)
public void fontNoNewLine(String size)(Code)(Java Doc)
public void fontSizeStyle(String size, String stylename)(Code)(Java Doc)
public void fontStyle(String stylename)(Code)(Java Doc)
public String getBold()(Code)(Java Doc)
public String getBoldEnd()(Code)(Java Doc)
public String getCode()(Code)(Java Doc)
public String getCodeEnd()(Code)(Java Doc)
public String getFontColor(String color)(Code)(Java Doc)
public String getFontEnd()(Code)(Java Doc)
protected String getWindowTitleOnload()(Code)(Java Doc)
public void h1()(Code)(Java Doc)
public void h1(String text)(Code)(Java Doc)
public void h1End()(Code)(Java Doc)
public void h2()(Code)(Java Doc)
public void h2(String text)(Code)(Java Doc)
public void h2End()(Code)(Java Doc)
public void h3()(Code)(Java Doc)
public void h3(String text)(Code)(Java Doc)
public void h3End()(Code)(Java Doc)
public void h4()(Code)(Java Doc)
public void h4(String text)(Code)(Java Doc)
public void h4End()(Code)(Java Doc)
public void h5()(Code)(Java Doc)
public void h5End()(Code)(Java Doc)
public void head()(Code)(Java Doc)
public void headEnd()(Code)(Java Doc)
public void hr()(Code)(Java Doc)
public void hr(int size, int widthPercent)(Code)(Java Doc)
public void hr(int size, String noshade)(Code)(Java Doc)
public void html()(Code)(Java Doc)
public void htmlEnd()(Code)(Java Doc)
public void img(String imggif, String imgname, int width, int height)(Code)(Java Doc)
public void italic()(Code)(Java Doc)
public void italicEnd()(Code)(Java Doc)
public void italics(String text)(Code)(Java Doc)
public String italicsText(String text)(Code)(Java Doc)
public void li()(Code)(Java Doc)
public void li(String type)(Code)(Java Doc)
public void link(String str)(Code)(Java Doc)
public void menu()(Code)(Java Doc)
public void menuEnd()(Code)(Java Doc)
public void noFrames()(Code)(Java Doc)
public void noFramesEnd()(Code)(Java Doc)
public void noScript()(Code)(Java Doc)
public void noScriptEnd()(Code)(Java Doc)
public void p()(Code)(Java Doc)
public void pEnd()(Code)(Java Doc)
public void pre()(Code)(Java Doc)
public void preEnd()(Code)(Java Doc)
public void preNoNewLine()(Code)(Java Doc)
protected void printWinTitleScript(String winTitle)(Code)(Java Doc)
public void script()(Code)(Java Doc)
public void scriptEnd()(Code)(Java Doc)
public void space()(Code)(Java Doc)
public void sup()(Code)(Java Doc)
public void supEnd()(Code)(Java Doc)
public void table(int border, String width, int cellpadding, int cellspacing)(Code)(Java Doc)
public void table(int border, int cellpadding, int cellspacing)(Code)(Java Doc)
public void table(int border, String width)(Code)(Java Doc)
public void table()(Code)(Java Doc)
public void tableEnd()(Code)(Java Doc)
public void td()(Code)(Java Doc)
public void tdAlign(String align)(Code)(Java Doc)
public void tdAlignRowspan(String align, int rowspan)(Code)(Java Doc)
public void tdAlignVAlign(String align, String valign)(Code)(Java Doc)
public void tdAlignVAlignRowspan(String align, String valign, int rowspan)(Code)(Java Doc)
public void tdBgcolorStyle(String color, String stylename)(Code)(Java Doc)
public void tdColspan(int i)(Code)(Java Doc)
public void tdColspanBgcolorStyle(int i, String color, String stylename)(Code)(Java Doc)
public void tdEnd()(Code)(Java Doc)
public void tdNowrap()(Code)(Java Doc)
public void tdVAlign(String valign)(Code)(Java Doc)
public void tdVAlignClass(String align, String stylename)(Code)(Java Doc)
public void tdWidth(String width)(Code)(Java Doc)
public void thAlign(String align)(Code)(Java Doc)
public void thAlignColspan(String align, int i)(Code)(Java Doc)
public void thAlignNowrap(String align)(Code)(Java Doc)
public void thEnd()(Code)(Java Doc)
public void title()(Code)(Java Doc)
public void title(String winTitle)(Code)(Java Doc)
public void titleEnd()(Code)(Java Doc)
public void tr()(Code)(Java Doc)
public void trAlignVAlign(String align, String valign)(Code)(Java Doc)
public void trBgcolor(String color)(Code)(Java Doc)
public void trBgcolorStyle(String color, String stylename)(Code)(Java Doc)
public void trEnd()(Code)(Java Doc)
public void ul()(Code)(Java Doc)
public void ulEnd()(Code)(Java Doc)
|
| Methods inherited from java.io.PrintWriter | public PrintWriter append(CharSequence csq)(Code)(Java Doc)
public PrintWriter append(CharSequence csq, int start, int end)(Code)(Java Doc)
public PrintWriter append(char c)(Code)(Java Doc)
public boolean checkError()(Code)(Java Doc)
protected void clearError()(Code)(Java Doc)
public void close()(Code)(Java Doc)
public void flush()(Code)(Java Doc)
public PrintWriter format(String format, Object... args)(Code)(Java Doc)
public PrintWriter format(Locale l, String format, Object... args)(Code)(Java Doc)
public void print(boolean b)(Code)(Java Doc)
public void print(char c)(Code)(Java Doc)
public void print(int i)(Code)(Java Doc)
public void print(long l)(Code)(Java Doc)
public void print(float f)(Code)(Java Doc)
public void print(double d)(Code)(Java Doc)
public void print(char s)(Code)(Java Doc)
public void print(String s)(Code)(Java Doc)
public void print(Object obj)(Code)(Java Doc)
public PrintWriter printf(String format, Object... args)(Code)(Java Doc)
public PrintWriter printf(Locale l, String format, Object... args)(Code)(Java Doc)
public void println()(Code)(Java Doc)
public void println(boolean x)(Code)(Java Doc)
public void println(char x)(Code)(Java Doc)
public void println(int x)(Code)(Java Doc)
public void println(long x)(Code)(Java Doc)
public void println(float x)(Code)(Java Doc)
public void println(double x)(Code)(Java Doc)
public void println(char x)(Code)(Java Doc)
public void println(String x)(Code)(Java Doc)
public void println(Object x)(Code)(Java Doc)
protected void setError()(Code)(Java Doc)
public void write(int c)(Code)(Java Doc)
public void write(char buf, int off, int len)(Code)(Java Doc)
public void write(char buf)(Code)(Java Doc)
public void write(String s, int off, int len)(Code)(Java Doc)
public void write(String s)(Code)(Java Doc)
|
|
|