wt.tools.xref
Class WhereUsedHtmlGen

java.lang.Object
  wt.tools.xref.HtmlGen
      wt.tools.xref.WhereUsedHtmlGen

public class WhereUsedHtmlGen

extends HtmlGen

This class is used to write 'where used' information in HTML format. The following is an attempt to illustrate the output format that that this class produces. +-----------+------------------------------------------------------------+ | Package | Field/Method Detail Frame | | List | | | Frame | | | | | | | | | | | +-----------+ | | Class/ | | | Interface | | | List | | | Frame | | | | | | | | | | | +-----------+ | | Class/ | | | Interface | | | Menu | | | Frame | | | | | | | | | | | | | | | | | | | | | | | +-----------+------------------------------------------------------------+ Package List Frame: This frame contains a list of all Java packages in the codebase. Class/Interface List Frame: This frame contains a list of all Classes and Interfaces found in the package selected in the above frame. Class/Interface Menu Frame: This frame contains a list of all Fields and Methods found in the Class/Interface selected in the above frame. Field/Method Detail Frame: This frame contains a detailed list of cross reference information for the selected Field/Method in the lower left frame.

Field Summary

Fields inherited from class wt.tools.xref.HtmlGen

d_CrLf, d_outputDirectory

Constructor Summary

WhereUsedHtmlGen(String outputDirectory)
This constructor requires accepts the name of the output directory to write all HTML files to.

Method Summary

(package private) void	writeClassInterfaceMenuFrame(PackageSpec packageSpec)
(package private) void	writeDescendents(OutputHelper oh, ReferencesContainer rc, Hashtable classInterfaceList)
(package private) void	writeDetailFiles(PackageSpec packageSpec, ClassInterfaceSpec theClassInterfaceSpec)
(package private) void	writeIndexHtml(String firstHtmlFileName)
(package private) void	writeInitialClassInterfaceListHtml()
(package private) void	writeInitialClassInterfaceMenuHtml()
(package private) void	writeInitialFieldMethodDetailHtml()
(package private) String	writeTableCell(String cellContents)
(package private) void	writeUnusedFields(PackageSpec pkgSpec)
(package private) void	writeUnusedMethods(PackageSpec pkgSpec)

Methods inherited from class wt.tools.xref.HtmlGen

directoryCheck, getVector, hrefPrefix, openPrintWriter, openPrintWriter, outputStringArray, writeClassInterfaceListFrame, writeClassInterfaceUnknownList_OLD, writeClassInterfaceUnknownList, writeEndOfLeftFrame, writeEndOfRightFrame, writePackageListFrame, writeStartOfLeftFrame, writeStartOfRightFrame

Methods inherited from class java.lang.Object

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

Constructor Detail

WhereUsedHtmlGen

public WhereUsedHtmlGen(String outputDirectory)

This constructor requires accepts the name of the output directory to write all HTML files to.

Method Detail

writeInitialClassInterfaceListHtml

void writeInitialClassInterfaceListHtml()

writeInitialClassInterfaceMenuHtml

void writeInitialClassInterfaceMenuHtml()

writeInitialFieldMethodDetailHtml

void writeInitialFieldMethodDetailHtml()

writeIndexHtml

void writeIndexHtml(String firstHtmlFileName)

Overrides:

writeIndexHtml in class HtmlGen

writeClassInterfaceMenuFrame

void writeClassInterfaceMenuFrame(PackageSpec packageSpec)

writeTableCell

String writeTableCell(String cellContents)

writeDescendents

void writeDescendents(OutputHelper oh,
                      ReferencesContainer rc,
                      Hashtable classInterfaceList)

writeUnusedMethods

void writeUnusedMethods(PackageSpec pkgSpec)

writeUnusedFields

void writeUnusedFields(PackageSpec pkgSpec)

writeDetailFiles

void writeDetailFiles(PackageSpec packageSpec,
                      ClassInterfaceSpec theClassInterfaceSpec)