org.freehep.tools.doclet
Class AbstractIndexWriter

java.lang.Object
  java.io.Writer
      java.io.PrintWriter
          com.sun.tools.doclets.HtmlWriter
              com.sun.tools.doclets.HtmlDocWriter
                  org.freehep.tools.doclet.HtmlStandardWriter
                      org.freehep.tools.doclet.AbstractIndexWriter

Direct Known Subclasses:

SingleIndexWriter, SplitIndexWriter

public class AbstractIndexWriter

extends HtmlStandardWriter

Generate Index for all the Member Names with Indexing in Unicode Order. This class is a base class for SingleIndexWriter and SplitIndexWriter. It uses the functionality from HtmlStandardWriter and HtmlWriter to generate the Index Contents.

Author:

Atul M Dambalkar

See Also:

IndexBuilder

Source Code:

AbstractIndexWriter.java

Field Summary

protected com.sun.tools.doclets.IndexBuilder

indexbuilder The index of all the members with unicode character.

Fields inherited from class org.freehep.tools.doclet.HtmlStandardWriter

backpath, configuration, displayLength, DOC_FILES_DIR_NAME, filename, path, relativepath, relativepathNoSlash

Fields inherited from class com.sun.tools.doclets.HtmlWriter

fileseparator, htmlFilename, winTitle

Fields inherited from class java.io.PrintWriter

out

Fields inherited from class java.io.Writer

lock

Constructor Summary

protected	AbstractIndexWriter(ConfigurationStandard configuration, String filename, com.sun.tools.doclets.IndexBuilder indexbuilder) This Constructor will be used by SingleIndexWriter.
protected	AbstractIndexWriter(ConfigurationStandard configuration, String path, String filename, String relpath, com.sun.tools.doclets.IndexBuilder indexbuilder) This constructor will be used by SplitIndexWriter.

Method Summary

protected void	generateContents(Character unicode, List memberlist) Generate the member information for the unicode character along with the list of the members.
protected void	navLinkIndex() Print the text "Index" in bold format in the navigation bar.
protected void	printClassInfo(com.sun.javadoc.ClassDoc cd) What is the classkind?
protected void	printComment(com.sun.javadoc.ProgramElementDoc element) Print comment for each element in the index.
protected void	printDescription(com.sun.javadoc.ClassDoc cd) Print one line summary comment for the class.
protected void	printDescription(com.sun.javadoc.MemberDoc element) Generate Description for Class, Field, Method or Constructor.
protected void	printDescription(com.sun.javadoc.PackageDoc pd) Print one line summary comment for the package.
protected void	printMemberDesc(com.sun.javadoc.MemberDoc member) Print description about the Static Varible/Method/Constructor for a member.

Methods inherited from class org.freehep.tools.doclet.HtmlStandardWriter

boldText, boldText, boldText, commentTagsToString, configuration, copyDocFiles, error, error, frame, frameEnd, frameSet, frameSetEnd, generateTagInfo, generateTagInfo, getClassLink, getClassLink, getClassLink, getClassLink, getClassLink, getClassLink, getCrossClassLink, getCrossPackageLink, getDocLink, getDocLink, getPackageLink, getPackageLink, getPackageLink, getPackageLink, getPreQualifiedClassLink, getPreQualifiedClassLink, getQualifiedClassLink, getSourcePath, getText, getText, getText, getText, isCoreClass, isCrossClassIncluded, isGeneratedDoc, italicsClassName, msg, navCellEnd, navCellRevStart, navCellStart, navDetail, navHideLists, navHideLists, navLinkClass, navLinkClassIndex, navLinkClassUse, navLinkContents, navLinkDeprecated, navLinkHelp, navLinkMainTree, navLinkNext, navLinkNext, navLinkPackage, navLinkPackage, navLinkPrevious, navLinkPrevious, navLinks, navLinkTree, navShowLists, navShowLists, navSummary, notice, notice, pathString, pathString, pathToClass, printBoldTargetHyperLink, printBottom, printClassLink, printClassLink, printClassLink, printClassLink, printClassLink, printClassLink, printClassLink, printDocLink, printDocLink, printHtmlHeader, printHtmlHeader, printHtmlHeader, printIndexHeading, printInlineComment, printInlineComment, printInlineDeprecatedComment, printInlineDeprecatedComment, printNoFramesBoldTargetHyperLink, printNoFramesTargetHyperLink, printPackageLink, printPackageLink, printPackageLink, printPreQualifiedBoldClassLink, printPreQualifiedClassLink, printQualifiedClassLink, printSinceTag, printSrcLink, printStyleSheetProperties, printSummaryComment, printSummaryDeprecatedComment, printSummaryDeprecatedComment, printSummaryDetailLinks, printTargetClassLink, printTargetHyperLink, printTargetHyperLink, printTargetHyperLink, printTargetPackageLink, printText, printText, printText, printUserHeaderFooter, removeNonInlineHtmlTags, replace, replaceDocRootDir, replaceInheritDoc, seeTagToString, serialClassInclude, serialDocInclude, serialInclude, summaryRow, summaryRowEnd, tableHeaderEnd, tableHeaderStart, tableHeaderStart, tableHeaderStart, tableHeaderStart, tableIndexDetail, tableIndexSummary, tableInheritedHeaderEnd, tableInheritedHeaderStart, tableUseInfoHeaderStart, tdIndex, warning, warning, warning

Methods inherited from class com.sun.tools.doclets.HtmlDocWriter

getHyperLink, getHyperLink, getHyperLink, getHyperLink, getPkgName, printBodyHtmlEnd, printFooter, printFrameFooter, printFramesetHeader, printFramesetHeader, printHyperLink, printHyperLink, printHyperLink, printHyperLink, printNbsps, printPkgName, spaces, today

Methods inherited from class com.sun.tools.doclets.HtmlWriter

address, addressEnd, aEnd, aName, anchor, anchor, blockquote, blockquoteEnd, body, bodyEnd, bold, bold, boldEnd, br, center, centerEnd, code, codeEnd, codeText, commentEnd, commentStart, dd, ddEnd, dl, dlEnd, dt, em, emEnd, font, fontEnd, fontSizeStyle, fontStyle, genWriter, getBold, getBoldEnd, getCode, getCodeEnd, getFontColor, getFontEnd, getWindowTitleOnload, h1, h1, h1End, h2, h2, h2End, h3, h3, h3End, h4, h4, h4End, h5, h5End, head, headEnd, hr, hr, hr, html, htmlEnd, img, italic, italicEnd, italics, italicsText, li, li, link, menu, menuEnd, noFrames, noFramesEnd, p, pEnd, pre, preEnd, printWinTitleScript, script, scriptEnd, space, sup, supEnd, table, table, table, table, tableEnd, td, tdAlign, tdAlignRowspan, tdAlignVAlign, tdAlignVAlignRowspan, tdBgcolorStyle, tdColspan, tdColspanBgcolorStyle, tdEnd, tdNowrap, tdVAlign, tdVAlignClass, tdWidth, title, title, titleEnd, tr, trAlignVAlign, trBgcolor, trBgcolorStyle, trEnd, ul, ulEnd

Methods inherited from class java.io.PrintWriter

checkError, close, flush, print, print, print, print, print, print, print, print, print, println, println, println, println, println, println, println, println, println, println, setError, write, write, write, write, write

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

indexbuilder

protected com.sun.tools.doclets.IndexBuilder indexbuilder

The index of all the members with unicode character.

Constructor Detail

AbstractIndexWriter

protected AbstractIndexWriter(ConfigurationStandard configuration,
                              String path,
                              String filename,
                              String relpath,
                              com.sun.tools.doclets.IndexBuilder indexbuilder)
                       throws IOException

This constructor will be used by SplitIndexWriter. Initialises path to this file and relative path from this file.

Parameters:

path - Path to the file which is getting generated.

filename - Name of the file which is getting genrated.

relpath - Relative path from this file to the current directory.

indexbuilder - Unicode based Index from IndexBuilder

AbstractIndexWriter

protected AbstractIndexWriter(ConfigurationStandard configuration,
                              String filename,
                              com.sun.tools.doclets.IndexBuilder indexbuilder)
                       throws IOException

This Constructor will be used by SingleIndexWriter.

Parameters:

filename - Name of the file which is getting genrated.

indexbuilder - Unicode based Index form IndexBuilder

Method Detail

navLinkIndex

protected void navLinkIndex()

Print the text "Index" in bold format in the navigation bar.

Overrides:

navLinkIndex in class HtmlStandardWriter

generateContents

protected void generateContents(Character unicode,
                                List memberlist)

Generate the member information for the unicode character along with the list of the members.

Parameters:

unicode - Unicode for which member list information to be generated.

memberlist - List of members for the unicode character.

printDescription

protected void printDescription(com.sun.javadoc.PackageDoc pd)

Print one line summary comment for the package.

Parameters:

pd - PackageDoc passed.

printDescription

protected void printDescription(com.sun.javadoc.ClassDoc cd)

Print one line summary comment for the class.

Parameters:

cd - ClassDoc passed.

printClassInfo

protected void printClassInfo(com.sun.javadoc.ClassDoc cd)

What is the classkind? Print the classkind(class, interface, exception, error of the class passed.

Parameters:

cd - ClassDoc.

printDescription

protected void printDescription(com.sun.javadoc.MemberDoc element)

Generate Description for Class, Field, Method or Constructor. for Java.* Packages Class Members.

Parameters:

element - MemberDoc for the member of the Class Kind.

See Also:

MemberDoc

printComment

protected void printComment(com.sun.javadoc.ProgramElementDoc element)

Print comment for each element in the index. If the element is deprecated and it has a @deprecated tag, use that comment. Else if the containing class for this element is deprecated, then add the word "Deprecated." at the start and then print the normal comment.

Parameters:

element - Index element.

printMemberDesc

protected void printMemberDesc(com.sun.javadoc.MemberDoc member)

Print description about the Static Varible/Method/Constructor for a member.

Parameters:

member - MemberDoc for the member within the Class Kind.

See Also:

MemberDoc