");
}
public void tdIndex() {
print("| ");
}
public void tableHeaderStart(String color, int span) {
trBgcolorClass(color, "TableSummaryHeadingColor");
tdColspan(span);
font("+2");
}
public void tableInheritedHeaderStart(String color) {
trBgcolorClass(color, "TableInheritedHeadingColor");
tdColspan(2);
}
public void tableHeaderStart(String color) {
tableHeaderStart(color, 2);
}
public void tableHeaderStart(int span) {
tableHeaderStart("#CCCCFF", span);
}
public void tableHeaderStart() {
tableHeaderStart(2);
}
public void tableHeaderEnd() {
fontEnd();
tdEnd();
trEnd();
}
public void tableInheritedHeaderEnd() {
tdEnd();
trEnd();
}
public void summaryRow(int width) {
if (width != 0) {
tdWidth("" + width + "%");
} else {
td();
}
}
public void summaryRowEnd() {
tdEnd();
}
public void printIndexHeading(String str) {
h2();
print(str);
h2End();
}
public void frameSet(String arg) {
println("");
}
public void frame(String arg) {
println("");
}
public void frameEnd() {
println("");
}
/**
* Print link for individual package file.
*/
public void printPackageLink(PackageDoc pkg, String linklabel) {
String pathstr = DirectoryManager.createPathString(pkg);
String filename = relativepath + ((pathstr.length() > 0)?
pathstr + fileseparator: "") +
"package-summary.html";
printHyperLink(filename, linklabel);
}
/**
* Print link for individual package file.
*/
public void printPackageLink(PackageDoc pkg) {
printPackageLink(pkg, pkg.name());
}
public String italicsClassName(ClassDoc cd, boolean qual) {
String name = (qual)? cd.qualifiedName(): cd.name();
return (cd.isInterface())? italicsText(name): name;
}
public void printClassLinkForSameDir(ClassDoc cd) {
if (Standard.configuration().linkall || cd.isIncluded()) {
printHyperLink(cd.name() + ".html", "", italicsClassName(cd,
false));
} else {
print(italicsClassName(cd, true));
}
}
public void printClassLink(ClassDoc cd) {
printClassLink(cd, false);
}
public void printClassLink(ClassDoc cd, String label) {
printClassLink(cd, "", label, false);
}
public void printClassLink(ClassDoc cd, String where, String label) {
printClassLink(cd, where, label, false);
}
public void printClassLink(ClassDoc cd, boolean bold) {
if (Standard.configuration().linkall || cd.isIncluded()) {
printClassLink(cd, "", cd.name(), bold);
} else {
printClassLink(cd, "", cd.qualifiedName(), bold);
}
}
public void printClassLink(ClassDoc cd, String where,
String label, boolean bold) {
if (Standard.configuration().linkall || cd.isIncluded()) {
String pathstr = DirectoryManager.createPathString(cd.
containingPackage());
String filename = relativepath + ((pathstr.length() > 0)?
pathstr + fileseparator: "") +
cd.name() + ".html";
printHyperLink(filename, where, label, bold);
} else {
print(label);
}
}
public void printQualifiedClassLink(ClassDoc cd) {
printClassLink(cd, "", cd.qualifiedName());
}
/**
* Print Class link, with only class name as the link and prefixing
* plain package name.
*/
public void printPreQualifiedClassLink(ClassDoc cd) {
printPkgName(cd);
if (Standard.configuration().linkall || cd.isIncluded()) {
printClassLink(cd);
} else {
print(cd.name());
}
}
/**
* Print Class link, with only class name as the bold link and prefixing
* plain package name.
*/
public void printPreQualifiedBoldClassLink(ClassDoc cd) {
printPkgName(cd);
if (Standard.configuration().linkall || cd.isIncluded()) {
printClassLink(cd, true);
} else {
print(cd.name());
}
}
public void printText(String key) {
print(Standard.configuration().standardmessage.getText(key));
}
public void printText(String key, String a1) {
print(Standard.configuration().standardmessage.getText(key, a1));
}
public void boldText(String key) {
bold(Standard.configuration().standardmessage.getText(key));
}
public void boldText(String key, String a1) {
bold(Standard.configuration().standardmessage.getText(key, a1));
}
public String getText(String key) {
return Standard.configuration().standardmessage.getText(key);
}
public void notice(String key, String a1) {
Standard.configuration().standardmessage.notice(key, a1);
}
public void notice(String key, String a1, String a2) {
Standard.configuration().standardmessage.notice(key, a1, a2);
}
public void error(String key, String a1) {
Standard.configuration().standardmessage.notice(key, a1);
}
public void error(String key, String a1, String a2) {
Standard.configuration().standardmessage.notice(key, a1, a2);
}
/**
* Print link for any doc element.
*/
public void printDocLink(Doc doc, String label, boolean bold) {
if (doc instanceof PackageDoc) {
printPackageLink((PackageDoc)doc, label);
} else if (doc instanceof ClassDoc) {
printClassLink((ClassDoc)doc, "", label, bold);
} else if (doc instanceof ExecutableMemberDoc) {
ExecutableMemberDoc emd = (ExecutableMemberDoc)doc;
printClassLink(emd.containingClass(),
emd.name()+emd.signature(), label, bold);
} else if (doc instanceof MemberDoc) {
MemberDoc md = (MemberDoc)doc;
printClassLink(md.containingClass(), md.name(), label, bold);
} else if (doc instanceof RootDoc) {
printHyperLink("overview-summary.html", label);
} else {
print(label);
}
}
public void printDocLink(Doc doc, String label) {
printDocLink(doc, label, false);
}
/**
* Print the see tags information given the doc comment.
*
* @param doc Doc doc
* @see com.sun.javadoc.Doc
*/
public void printSeeTags(Doc doc) {
SeeTag[] sees = doc.seeTags();
if (sees.length > 0) {
dt();
boldText("doclet.See_Also");
dd();
for (int i = 0; i < sees.length; ++i) {
if (i > 0) {
print(", ");
}
printSeeTag(sees[i]);
}
}
if (doc.isClass() && ((ClassDoc)doc).isSerializable()) {
if (sees.length > 0) {
print(", ");
} else {
dt();
boldText("doclet.See_Also");
dd();
}
printHyperLink(relativepath + "serializedform.html",
((ClassDoc)(doc)).qualifiedName(),
getText("doclet.Serialized_Form"));
}
}
public void printSeeTag(SeeTag see) {
ClassDoc refClass = see.referencedClass();
MemberDoc refMem = see.referencedMember();
String refMemName = see.referencedMemberName();
String label = see.label();
String text = see.text();
if (refClass == null) {
// nothing to link to, just use text
print((label.length() == 0)? text: label);
} else if (refMemName == null) {
// class reference
if (label.length() == 0) {
printClassLink(refClass);
} else {
printClassLink(refClass, (label.length() == 0)? text: label);
}
} else if (refMem == null) {
// can't find the member reference
print((label.length() == 0)? text: label);
} else {
// member reference
printDocLink(refMem, (label.length() == 0)? refMemName: label);
}
}
/**
* Print tag information
*/
public void generateTagInfo(Doc doc) {
Tag[] sinces = doc.tags("since");
Tag[] sees = doc.seeTags();
Tag[] authors;
Tag[] versions;
if (configuration.showauthor) {
authors = doc.tags("author");
} else {
authors = new Tag[0];
}
if (configuration.showversion) {
versions = doc.tags("version");
} else {
versions = new Tag[0];
}
if (sinces.length > 0
|| sees.length > 0
|| authors.length > 0
|| versions.length > 0
|| (doc.isClass() && ((ClassDoc)doc).isSerializable())) {
dl();
if (sinces.length > 0) {
// There is going to be only one Since tag.
dt();
boldText("doclet.Since");
print(' ');
dd();
printCommentTags(sinces[0].inlineTags());
ddEnd();
}
if (versions.length > 0) {
// There is going to be only one Version tag.
dt();
boldText("doclet.Version");
print(' ');
dd();
printCommentTags(versions[0].inlineTags());
ddEnd();
}
for (int i = 0; i < authors.length; ++i) {
dt();
boldText("doclet.Author");
print(' ');
dd();
printCommentTags(authors[0].inlineTags());
ddEnd();
}
printSeeTags(doc);
dlEnd();
}
}
public void printCommentTags(Tag[] commenttags, boolean deprecated) {
if (deprecated) {
italic();
}
for (int i = 0; i < commenttags.length; i++) {
Tag tagelem = commenttags[i];
if (tagelem instanceof SeeTag) {
printSeeTag((SeeTag)tagelem);
} else {
print(tagelem.text());
}
}
if (deprecated) {
italicEnd();
}
if (commenttags.length == 0) {
space();
}
}
public void printCommentTags(Tag[] commenttags) {
printCommentTags(commenttags, false);
}
public void printStyleSheetProperties() {
String filename = Standard.configuration().stylesheetfile;
if (filename.length() > 0) {
File stylefile = new File(filename);
String parent = stylefile.getParent();
filename = (parent == null)?
filename:
filename.substring(parent.length() + 1);
} else {
filename = "stylesheet.css";
}
filename = relativepath + filename;
link("rel =\"stylesheet\" type=\"text/css\" href=\"" +
filename + "\" " + "title=\"Style\"");
}
}
|