org.freehep.tools.doclet
Class SingleIndexWriter

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
                                      |
                                      +--org.freehep.tools.doclet.SingleIndexWriter

public class SingleIndexWriter

extends AbstractIndexWriter

Generate only one index file for all the Member Names with Indexing in Unicode Order. The name of the generated file is "index-all.html" and it is generated in current or the destination directory.

Author:

Atul M Dambalkar

See Also:

Character

Field Summary

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

indexbuilder

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

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

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

SingleIndexWriter(ConfigurationStandard configuration, String filename, com.sun.tools.doclets.IndexBuilder indexbuilder)
Construct the SingleIndexWriter with filename "index-all.html" and the IndexBuilder

Method Summary

static void	generate(ConfigurationStandard configuration, com.sun.tools.doclets.IndexBuilder indexbuilder) Generate single index file, for all Unicode characters.
protected void	generateIndexFile() Generate the contents of each index file, with Header, Footer, Member Field, Method and Constructor Description.
protected void	printLinksForIndexes() Print Links for all the Index Files per unicode character.

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

generateContents, navLinkIndex, printClassInfo, printComment, printDescription, printDescription, printDescription, printMemberDesc

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, getNoFramesTargetHyperLink, getPackageLink, getPackageLink, getPackageLink, getPackageLink, getPreQualifiedClassLink, getPreQualifiedClassLink, getQualifiedClassLink, getSourcePath, getTargetHyperLink, 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, printClassLinkForSameDir, printDocLink, printDocLink, printHeader, printHeader, printIndexHeading, printInlineComment, printInlineComment, printInlineDeprecatedComment, printInlineDeprecatedComment, printNoFramesBoldTargetHyperLink, 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, getPkgName, printBodyHtmlEnd, printFooter, printFrameFooter, printHyperLink, printHyperLink, printHyperLink, printHyperLink, printNbsps, printPartialHeader, printPkgName, spaces, today

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

address, addressEnd, aEnd, aName, anchor, anchor, blockquote, blockquoteEnd, body, 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, getScriptCode, 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, 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

Constructor Detail

SingleIndexWriter

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

Construct the SingleIndexWriter with filename "index-all.html" and the IndexBuilder

Parameters:

filename - Name of the index file to be generated.

indexbuilder - Unicode based Index from IndexBuilder

Method Detail

generate

public static void generate(ConfigurationStandard configuration,
                            com.sun.tools.doclets.IndexBuilder indexbuilder)

Generate single index file, for all Unicode characters.

Parameters:

indexbuilder - IndexBuilder built by IndexBuilder

Throws:

com.sun.tools.doclets.DocletAbortException

generateIndexFile

protected void generateIndexFile()
                          throws IOException

Generate the contents of each index file, with Header, Footer, Member Field, Method and Constructor Description.

IOException

printLinksForIndexes

protected void printLinksForIndexes()

Print Links for all the Index Files per unicode character.