| com.sun.tools.doclets.formats.html.HtmlDocletWriter com.sun.tools.doclets.formats.html.AbstractTreeWriter
All known Subclasses: com.sun.tools.doclets.formats.html.PackageTreeWriter, com.sun.tools.doclets.formats.html.TreeWriter,
AbstractTreeWriter | abstract public class AbstractTreeWriter extends HtmlDocletWriter (Code) | | Abstract class to print the class hierarchy page for all the Classes. This
is sub-classed by
PackageTreeWriter and
TreeWriter to
generate the Package Tree and global Tree(for all the classes and packages)
pages.
author: Atul M Dambalkar |
Method Summary | |
protected void | generateLevelInfo(ClassDoc parent, List list, boolean isEnum) Generate each level of the class tree. | protected void | generateTree(List list, String heading) Generate the heading for the tree depending upon tree type if it's a
Class Tree or Interface tree and also print the tree. | protected void | navLinkTree() Highlight "Tree" word in the navigation bar, since this is the tree page. | protected void | printExtendsImplements(ClassDoc parent, ClassDoc cd) Print the information regarding the classes which this class extends or
implements. | protected void | printPartialInfo(ClassDoc cd) Print information about the class kind, if it's a "class" or "interface". | protected void | printTreeHeading(String heading) Print the heading for the tree. |
AbstractTreeWriter | protected AbstractTreeWriter(ConfigurationImpl configuration, String path, String filename, ClassTree classtree, PackageDoc pkg) throws IOException(Code) | | Create appropriate directory for the package and also initilise the
relative path from this generated file to the current or
the destination directory. This constructor will be used while
generating "package tree" file.
Parameters: path - Directories in this path will be created if they are notalready there. Parameters: filename - Name of the package tree file to be generated. Parameters: classtree - The tree built using ClassTree.for the package pkg. Parameters: pkg - PackageDoc for which tree file will be generated. throws: IOException - throws: DocletAbortException - |
generateLevelInfo | protected void generateLevelInfo(ClassDoc parent, List list, boolean isEnum)(Code) | | Generate each level of the class tree. For each sub-class or
sub-interface indents the next level information.
Recurses itself to generate subclasses info.
To iterate is human, to recurse is divine - L. Peter Deutsch.
Parameters: parent - the superclass or superinterface of the list. Parameters: list - list of the sub-classes at this level. Parameters: isEnum - true if we are generating a tree for enums. |
generateTree | protected void generateTree(List list, String heading)(Code) | | Generate the heading for the tree depending upon tree type if it's a
Class Tree or Interface tree and also print the tree.
Parameters: list - List of classes which are at the most base level, all theother classes in this run will derive from these classes. Parameters: heading - Heading for the tree. |
navLinkTree | protected void navLinkTree()(Code) | | Highlight "Tree" word in the navigation bar, since this is the tree page.
|
printExtendsImplements | protected void printExtendsImplements(ClassDoc parent, ClassDoc cd)(Code) | | Print the information regarding the classes which this class extends or
implements.
Parameters: cd - The classdoc under consideration. |
printPartialInfo | protected void printPartialInfo(ClassDoc cd)(Code) | | Print information about the class kind, if it's a "class" or "interface".
Parameters: cd - classdoc. |
printTreeHeading | protected void printTreeHeading(String heading)(Code) | | Print the heading for the tree.
Parameters: heading - Heading for the tree. |
Methods inherited from com.sun.tools.doclets.formats.html.HtmlDocletWriter | public void anchor(ExecutableMemberDoc emd)(Code)(Java Doc) public void boldText(String key)(Code)(Java Doc) public void boldText(String key, String a1)(Code)(Java Doc) public void boldText(String key, String a1, String a2)(Code)(Java Doc) public String commentTagsToString(Tag holderTag, Doc doc, Tag[] tags, boolean isFirstSentence)(Code)(Java Doc) public Configuration configuration()(Code)(Java Doc) public void frame(String arg)(Code)(Java Doc) public void frameEnd()(Code)(Java Doc) public void frameSet(String arg)(Code)(Java Doc) public void frameSetEnd()(Code)(Java Doc) public String getAnchor(ExecutableMemberDoc emd)(Code)(Java Doc) public String getCrossClassLink(String qualifiedClassName, String refMemName, String label, boolean bold, String style, boolean code)(Code)(Java Doc) public String getCrossPackageLink(String pkgName)(Code)(Java Doc) public String getDocLink(int context, MemberDoc doc, String label, boolean bold)(Code)(Java Doc) public String getDocLink(int context, ClassDoc classDoc, MemberDoc doc, String label, boolean bold)(Code)(Java Doc) public String getLink(LinkInfoImpl linkInfo)(Code)(Java Doc) public String getPackageLink(PackageDoc pkg, String label, boolean isBold)(Code)(Java Doc) public String getPackageLink(PackageDoc pkg, String label, boolean isBold, String style)(Code)(Java Doc) public String getPreQualifiedClassLink(int context, ClassDoc cd, boolean isBold)(Code)(Java Doc) public TagletWriter getTagletWriterInstance(boolean isFirstSentence)(Code)(Java Doc) public String getTypeParameterLinks(LinkInfoImpl linkInfo)(Code)(Java Doc) public boolean isClassLinkable(ClassDoc cd)(Code)(Java Doc) public boolean isCoreClass(ClassDoc cd)(Code)(Java Doc) public String italicsClassName(ClassDoc cd, boolean qual)(Code)(Java Doc) protected void navCellEnd()(Code)(Java Doc) protected void navCellRevStart()(Code)(Java Doc) protected void navCellStart()(Code)(Java Doc) protected void navDetail()(Code)(Java Doc) protected void navHideLists(String link)(Code)(Java Doc) protected void navLinkClass()(Code)(Java Doc) protected void navLinkClassIndex()(Code)(Java Doc) protected void navLinkClassUse()(Code)(Java Doc) protected void navLinkContents()(Code)(Java Doc) protected void navLinkDeprecated()(Code)(Java Doc) protected void navLinkHelp()(Code)(Java Doc) protected void navLinkIndex()(Code)(Java Doc) protected void navLinkMainTree(String label)(Code)(Java Doc) protected void navLinkNext()(Code)(Java Doc) public void navLinkNext(String next)(Code)(Java Doc) protected void navLinkPackage(PackageDoc pkg)(Code)(Java Doc) protected void navLinkPackage()(Code)(Java Doc) protected void navLinkPrevious()(Code)(Java Doc) public void navLinkPrevious(String prev)(Code)(Java Doc) protected void navLinkTree()(Code)(Java Doc) protected void navLinks(boolean header)(Code)(Java Doc) protected void navShowLists(String link)(Code)(Java Doc) protected void navShowLists()(Code)(Java Doc) protected void navSummary()(Code)(Java Doc) protected String pathString(ClassDoc cd, String name)(Code)(Java Doc) protected String pathString(PackageDoc pd, String name)(Code)(Java Doc) protected String pathToClass(ClassDoc cd)(Code)(Java Doc) public void printBottom()(Code)(Java Doc) public void printDocLink(int context, MemberDoc doc, String label, boolean bold)(Code)(Java Doc) public void printDocLink(int context, ClassDoc classDoc, MemberDoc doc, String label, boolean bold)(Code)(Java Doc) public void printHtmlHeader(String title, String[] metakeywords, boolean includeScript)(Code)(Java Doc) public void printIndexHeading(String str)(Code)(Java Doc) public void printInlineComment(Doc doc, Tag tag)(Code)(Java Doc) public void printInlineComment(Doc doc)(Code)(Java Doc) public void printInlineDeprecatedComment(Doc doc, Tag tag)(Code)(Java Doc) public void printInlineDeprecatedComment(Doc doc)(Code)(Java Doc) public void printLink(LinkInfoImpl linkInfo)(Code)(Java Doc) public void printNoFramesTargetHyperLink(String link, String where, String target, String label, boolean bold)(Code)(Java Doc) public void printPackageLink(PackageDoc pkg, String label, boolean isBold)(Code)(Java Doc) public void printPackageLink(PackageDoc pkg, String label, boolean isBold, String style)(Code)(Java Doc) public void printPreQualifiedBoldClassLink(int context, ClassDoc cd)(Code)(Java Doc) public void printPreQualifiedClassLink(int context, ClassDoc cd)(Code)(Java Doc) public void printQualifiedClassLink(int context, ClassDoc cd)(Code)(Java Doc) public void printSrcLink(ProgramElementDoc d, String label)(Code)(Java Doc) public void printStyleSheetProperties()(Code)(Java Doc) public void printSummaryComment(Doc doc)(Code)(Java Doc) public void printSummaryComment(Doc doc, Tag[] firstSentenceTags)(Code)(Java Doc) public void printSummaryDeprecatedComment(Doc doc)(Code)(Java Doc) public void printSummaryDeprecatedComment(Doc doc, Tag tag)(Code)(Java Doc) protected void printSummaryDetailLinks()(Code)(Java Doc) protected void printTags(Doc doc)(Code)(Java Doc) protected void printTagsInfoFooter()(Code)(Java Doc) protected void printTagsInfoHeader()(Code)(Java Doc) public void printTargetPackageLink(PackageDoc pd, String target, String label)(Code)(Java Doc) public void printText(String key)(Code)(Java Doc) public void printText(String key, String a1)(Code)(Java Doc) public void printText(String key, String a1, String a2)(Code)(Java Doc) public void printTop()(Code)(Java Doc) public void printUserHeaderFooter(boolean header)(Code)(Java Doc) public String removeNonInlineHtmlTags(String text)(Code)(Java Doc) public String replace(String text, String tobe, String by)(Code)(Java Doc) public String replaceDocRootDir(String htmlstr)(Code)(Java Doc) public String seeTagToString(SeeTag see)(Code)(Java Doc) public void summaryRow(int width)(Code)(Java Doc) public void summaryRowEnd()(Code)(Java Doc) public void tableHeaderEnd()(Code)(Java Doc) public void tableHeaderStart(String color, int span)(Code)(Java Doc) public void tableHeaderStart(String color)(Code)(Java Doc) public void tableHeaderStart(int span)(Code)(Java Doc) public void tableHeaderStart()(Code)(Java Doc) public void tableIndexDetail()(Code)(Java Doc) public void tableIndexSummary()(Code)(Java Doc) public void tableInheritedHeaderEnd()(Code)(Java Doc) public void tableInheritedHeaderStart(String color)(Code)(Java Doc) public void tableUseInfoHeaderStart(String color)(Code)(Java Doc) public void tdIndex()(Code)(Java Doc) public void writeAnnotationInfo(PackageDoc packageDoc)(Code)(Java Doc) public void writeAnnotationInfo(ProgramElementDoc doc)(Code)(Java Doc) public boolean writeAnnotationInfo(int indent, Doc doc, Parameter param)(Code)(Java Doc)
|
|
|