|
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.AbstractPackageWriter
Abstract class to generate file for each package contents. Sub-classed to
generate specific formats Frame and Non-Frame Output by
PackageIndexFrameWriter
and PackageIndexFrameWriter
respectively.
Field Summary | |
protected Set |
documentedClasses
The classes to be documented. |
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 | |
AbstractPackageWriter(ConfigurationStandard configuration,
String path,
String filename,
com.sun.javadoc.PackageDoc packagedoc)
Create appropriate directory for the package and also initilise the relative path from this generated file to the current or the destination directory. |
Method Summary | |
protected abstract void |
generateClassListing()
|
protected void |
generatePackageFile(boolean includeScript)
Generate Individual Package File with Class/Interface/Exceptions and Error Listing with the appropriate links. |
protected void |
navLinkPackage()
Highlight "Package" in the navigation bar, as this is the package page. |
protected abstract void |
printPackageDescription()
|
protected abstract void |
printPackageFooter()
|
protected abstract void |
printPackageHeader(String head)
|
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 |
protected Set documentedClasses
Constructor Detail |
public AbstractPackageWriter(ConfigurationStandard configuration, String path, String filename, com.sun.javadoc.PackageDoc packagedoc) throws IOException
path
- Directories in this path will be created if they are not
already there.filename
- Name of the package summary file to be generated.packagedoc
- PackageDoc under consideration.
com.sun.tools.doclets.DocletAbortException
IOException
Method Detail |
protected abstract void generateClassListing()
protected abstract void printPackageDescription() throws IOException
IOException
protected abstract void printPackageHeader(String head)
protected abstract void printPackageFooter()
protected void generatePackageFile(boolean includeScript) throws IOException
includeScript
- boolean true when including windowtitle script
IOException
protected void navLinkPackage()
navLinkPackage
in class HtmlStandardWriter
|
FreeHEP API Version current |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |