|
FreeHEP API Version v1.2.2 |
|||||||||
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.AbstractPackageIndexWriter
Abstract class to generate the package index. The package index needs to be generated in Frame and Non-Frame format. This will be sub-classed by to generate frame-index as well as overview-index.
Field Summary | |
protected com.sun.javadoc.PackageDoc[] |
packages
Array of Packages to be documented. |
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 | |
AbstractPackageIndexWriter(ConfigurationStandard configuration,
String filename)
Constructor. |
Method Summary | |
protected void |
generateIndex()
Generate the frame or non-frame package index. |
protected void |
generatePackageIndexFile()
Generate the contants in the package index file. |
protected void |
navLinkContents()
Highlight "Overview" in the bold format, in the navigation bar as this is the overview page. |
protected void |
printAllClassesPackagesLink()
Do nothing. |
protected void |
printConfigurationTitle()
Print the doctitle, if it is specified on the command line. |
protected void |
printIndexContents(com.sun.javadoc.PackageDoc[] packages,
String text)
Generate code for package index contents. |
protected abstract void |
printIndexFooter()
|
protected abstract void |
printIndexHeader(String text)
|
protected abstract void |
printIndexRow(com.sun.javadoc.PackageDoc pkg)
|
protected abstract void |
printNavigationBarFooter()
|
protected abstract void |
printNavigationBarHeader()
|
protected void |
printOverview()
Default to no overview, overwrite to add overview. |
protected abstract void |
printOverviewHeader()
|
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 |
Field Detail |
protected com.sun.javadoc.PackageDoc[] packages
Constructor Detail |
public AbstractPackageIndexWriter(ConfigurationStandard configuration, String filename) throws IOException
filename
- Name of the package index file to be generated.Method Detail |
protected abstract void printNavigationBarHeader()
protected abstract void printNavigationBarFooter()
protected abstract void printOverviewHeader()
protected abstract void printIndexHeader(String text)
protected abstract void printIndexRow(com.sun.javadoc.PackageDoc pkg)
protected abstract void printIndexFooter()
protected void generatePackageIndexFile() throws IOException
IOException
protected void printOverview() throws IOException
IOException
protected void generateIndex()
protected void printIndexContents(com.sun.javadoc.PackageDoc[] packages, String text)
text
- String which will be used as the heading.protected void printConfigurationTitle()
protected void navLinkContents()
navLinkContents
in class HtmlStandardWriter
protected void printAllClassesPackagesLink()
|
FreeHEP API Version v1.2.2 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |