Java Doc for AllClassesFrameWriter.java in  » 6.0-JDK-Modules-com.sun » tools » com » sun » tools » doclets » formats » html » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation
1. 6.0 JDK Core
2. 6.0 JDK Modules
3. 6.0 JDK Modules com.sun
4. 6.0 JDK Modules com.sun.java
5. 6.0 JDK Modules sun
6. 6.0 JDK Platform
7. Ajax
8. Apache Harmony Java SE
9. Aspect oriented
10. Authentication Authorization
11. Blogger System
12. Build
13. Byte Code
14. Cache
15. Chart
16. Chat
17. Code Analyzer
18. Collaboration
19. Content Management System
20. Database Client
21. Database DBMS
22. Database JDBC Connection Pool
23. Database ORM
24. Development
25. EJB Server geronimo
26. EJB Server GlassFish
27. EJB Server JBoss 4.2.1
28. EJB Server resin 3.1.5
29. ERP CRM Financial
30. ESB
31. Forum
32. GIS
33. Graphic Library
34. Groupware
35. HTML Parser
36. IDE
37. IDE Eclipse
38. IDE Netbeans
39. Installer
40. Internationalization Localization
41. Inversion of Control
42. Issue Tracking
43. J2EE
44. JBoss
45. JMS
46. JMX
47. Library
48. Mail Clients
49. Net
50. Parser
51. PDF
52. Portal
53. Profiler
54. Project Management
55. Report
56. RSS RDF
57. Rule Engine
58. Science
59. Scripting
60. Search Engine
61. Security
62. Sevlet Container
63. Source Control
64. Swing Library
65. Template Engine
66. Test Coverage
67. Testing
68. UML
69. Web Crawler
70. Web Framework
71. Web Mail
72. Web Server
73. Web Services
74. Web Services apache cxf 2.0.1
75. Web Services AXIS2
76. Wiki Engine
77. Workflow Engines
78. XML
79. XML UI
Java
Java Tutorial
Java Open Source
Jar File Download
Java Articles
Java Products
Java by API
Photoshop Tutorials
Maya Tutorials
Flash Tutorials
3ds-Max Tutorials
Illustrator Tutorials
GIMP Tutorials
C# / C Sharp
C# / CSharp Tutorial
C# / CSharp Open Source
ASP.Net
ASP.NET Tutorial
JavaScript DHTML
JavaScript Tutorial
JavaScript Reference
HTML / CSS
HTML CSS Reference
C / ANSI-C
C Tutorial
C++
C++ Tutorial
Ruby
PHP
Python
Python Tutorial
Python Open Source
SQL Server / T-SQL
SQL Server / T-SQL Tutorial
Oracle PL / SQL
Oracle PL/SQL Tutorial
PostgreSQL
SQL / MySQL
MySQL Tutorial
VB.Net
VB.Net Tutorial
Flash / Flex / ActionScript
VBA / Excel / Access / Word
XML
XML Tutorial
Microsoft Office PowerPoint 2007 Tutorial
Microsoft Office Excel 2007 Tutorial
Microsoft Office Word 2007 Tutorial
Java Source Code / Java Documentation » 6.0 JDK Modules com.sun » tools » com.sun.tools.doclets.formats.html 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


com.sun.tools.doclets.formats.html.HtmlDocletWriter
   com.sun.tools.doclets.formats.html.AllClassesFrameWriter

AllClassesFrameWriter
public class AllClassesFrameWriter extends HtmlDocletWriter (Code)
Generate the file with list of all the classes in this run. This page will be used in the left-hand bottom frame, when "All Classes" link is clicked in the left-hand top frame. The name of the generated file is "allclasses-frame.html".
author:
   Atul M Dambalkar
author:
   Doug Kramer


Field Summary
final public static  StringOUTPUT_FILE_NAME_FRAMES
    
final public static  StringOUTPUT_FILE_NAME_NOFRAMES
    
protected  IndexBuilderindexbuilder
     Index of all the classes.

Constructor Summary
public  AllClassesFrameWriter(ConfigurationImpl configuration, String filename, IndexBuilder indexbuilder)
     Construct AllClassesFrameWriter object.

Method Summary
public static  voidgenerate(ConfigurationImpl configuration, IndexBuilder indexbuilder)
     Create AllClassesFrameWriter object.
protected  voidgenerateAllClassesFile(boolean wantFrames)
     Print all the classes in table format in the file.
protected  voidgenerateContents(List classlist, boolean wantFrames)
     Given a list of classes, generate links for each class or interface. If the class kind is interface, print it in the italics font.
protected  voidprintAllClasses(boolean wantFrames)
     Use the sorted index of all the classes and print all the classes.
protected  voidprintAllClassesTableFooter()
     Print Html closing table tag.
protected  voidprintAllClassesTableHeader()
     Print the heading "All Classes" and also print Html table tag.

Field Detail
OUTPUT_FILE_NAME_FRAMES
final public static String OUTPUT_FILE_NAME_FRAMES(Code)
The name of the output file with frames



OUTPUT_FILE_NAME_NOFRAMES
final public static String OUTPUT_FILE_NAME_NOFRAMES(Code)
The name of the output file without frames



indexbuilder
protected IndexBuilder indexbuilder(Code)
Index of all the classes.




Constructor Detail
AllClassesFrameWriter
public AllClassesFrameWriter(ConfigurationImpl configuration, String filename, IndexBuilder indexbuilder) throws IOException(Code)
Construct AllClassesFrameWriter object. Also initilises the indexbuilder variable in this class.
throws:
  IOException -
throws:
  DocletAbortException -




Method Detail
generate
public static void generate(ConfigurationImpl configuration, IndexBuilder indexbuilder)(Code)
Create AllClassesFrameWriter object. Then use it to generate the "allclasses-frame.html" file. Generate the file in the current or the destination directory.
Parameters:
  indexbuilder - IndexBuilder object for all classes index.
throws:
  DocletAbortException -



generateAllClassesFile
protected void generateAllClassesFile(boolean wantFrames) throws IOException(Code)
Print all the classes in table format in the file.
Parameters:
  wantFrames - True if we want frames.



generateContents
protected void generateContents(List classlist, boolean wantFrames)(Code)
Given a list of classes, generate links for each class or interface. If the class kind is interface, print it in the italics font. Also all links should target the right-hand frame. If clicked on any class name in this page, appropriate class page should get opened in the right-hand frame.
Parameters:
  classlist - Sorted list of classes.
Parameters:
  wantFrames - True if we want frames.



printAllClasses
protected void printAllClasses(boolean wantFrames)(Code)
Use the sorted index of all the classes and print all the classes.
Parameters:
  wantFrames - True if we want frames.



printAllClassesTableFooter
protected void printAllClassesTableFooter()(Code)
Print Html closing table tag.



printAllClassesTableHeader
protected void printAllClassesTableHeader()(Code)
Print the heading "All Classes" and also print Html table tag.



Fields inherited from com.sun.tools.doclets.formats.html.HtmlDocletWriter
public ConfigurationImpl configuration(Code)(Java Doc)
public int displayLength(Code)(Java Doc)
public String filename(Code)(Java Doc)
public String path(Code)(Java Doc)
public String relativePath(Code)(Java Doc)
public String relativepathNoSlash(Code)(Java Doc)

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)

www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.