|
FreeHEP API Version current |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
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
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.
Character
Field Summary |
Fields inherited from class org.freehep.tools.doclet.AbstractIndexWriter |
indexbuilder |
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 | |
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 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 |
Constructor Detail |
public SingleIndexWriter(ConfigurationStandard configuration, String filename, com.sun.tools.doclets.IndexBuilder indexbuilder) throws IOException
IndexBuilder
filename
- Name of the index file to be generated.indexbuilder
- Unicode based Index from IndexBuilder
Method Detail |
public static void generate(ConfigurationStandard configuration, com.sun.tools.doclets.IndexBuilder indexbuilder)
indexbuilder
- IndexBuilder built by IndexBuilder
com.sun.tools.doclets.DocletAbortException
protected void generateIndexFile() throws IOException
IOException
protected void printLinksForIndexes()
|
FreeHEP API Version current |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |