| Methods Summary |
|---|
| public static void | generate(com.sun.javadoc.RootDoc root)Generate the package index page for the right-hand frame.
PackageIndexWriter packgen;
String filename = "overview-summary.html";
try {
packgen = new PackageIndexWriter(filename, root);
packgen.generatePackageIndexFile();
packgen.close();
} catch (IOException exc) {
Standard.configuration().standardmessage.error("doclet.exception_encountered",
exc.toString(), filename);
throw new DocletAbortException();
}
|
| protected void | generateIndex()Depending upon the grouping information and their titles, generate
separate table indices for each package group.
for (int i = 0; i < groupList.size(); i++) {
String groupname = (String)groupList.get(i);
List list = (List)groupPackageMap.get(groupname);
if (list != null && list.size() > 0) {
printIndexContents((PackageDoc[])list.
toArray(new PackageDoc[list.size()]),
groupname);
}
}
|
| protected void | printIndexFooter()Print Html closing tags for the table for this package index.
tableEnd();
p();
space();
|
| protected void | printIndexHeader(java.lang.String text)Print Html tags for the table for this package index.
tableIndexSummary();
tableHeaderStart("#CCCCFF");
bold(text);
tableHeaderEnd();
|
| protected void | printIndexRow(com.sun.javadoc.PackageDoc packagedoc)Print each package in separate rows in the index table. Generate link
to each package.
trBgcolorStyle("white", "TableRowColor");
summaryRow(20);
bold();
printPackageLink(packagedoc);
boldEnd();
summaryRowEnd();
summaryRow(0);
printSummaryComment(packagedoc);
summaryRowEnd();
trEnd();
|
| protected void | printNavigationBarFooter()Print the footer fornavigation bar. Also print the "-bottom" specified
on command line, at the top of page.
hr();
navLinks(false);
printBottom();
|
| protected void | printNavigationBarHeader()Print the header for navigation bar. Also print the "-title" specified
on command line, at the top of page.
navLinks(true);
hr();
printConfigurationTitle();
|
| protected void | printOverview()Call {@link #printOverviewComment()} and then genrate the tag information
as provided in the file specified by the "-overview" option on the
command line.
printOverviewComment();
generateTagInfo(root);
|
| protected void | printOverviewComment()Print the overview comment as provided in the file specified by the
"-overview" option on the command line.
if (root.inlineTags().length > 0) {
anchor("overview_description");
p();
printInlineComment(root);
p();
}
|
| protected void | printOverviewHeader()Print the overview summary comment for this documentation. Print one line
summary at the top of the page and generate a link to the description,
which is generated at the end of this page.
if (root.inlineTags().length > 0) {
printSummaryComment(root);
p();
bold(getText("doclet.See"));
br();
printNbsps();
printHyperLink("", "overview_description",
getText("doclet.Description"), true);
p();
}
|
