| Methods Summary |
|---|
| public static void | generate()Construct FrameOutputWriter object and then use it to generate the Html
file which will have the description of all the frames in the
documentation. The name of the generated file is "index.html" which is
the default first file for Html documents.
FrameOutputWriter framegen;
String filename = "";
try {
filename = "index.html";
framegen = new FrameOutputWriter(filename);
framegen.generateFrameFile();
framegen.close();
} catch (IOException exc) {
Standard.configuration().standardmessage.error(
"doclet.exception_encountered",
exc.toString(), filename);
throw new DocletAbortException();
}
|
| protected void | generateFrameFile()Generate the contants in the "index.html" file. Print the frame details
as well as warning if browser is not supporting the Html frames.
if (Standard.configuration().windowtitle.length() > 0) {
printPartialHeader(Standard.configuration().windowtitle);
} else {
printPartialHeader(getText("doclet.Generated_Docs_Untitled"));
}
printFrameDetails();
printFrameWarning();
printFrameFooter();
|
| protected void | printFrameDetails()Print the frame sizes and their contents.
frameSet("cols=\"20%,80%\"");
if (noOfPackages <= 1) {
frame("src=\"" + "allclasses-frame.html"
+ "\" name=\"packageFrame\"");
frame("src=\"" + Standard.configuration().topFile +
"\" name=\"classFrame\"");
} else if (noOfPackages > 1) {
frameSet("rows=\"30%,70%\"");
frame("src=\"overview-frame.html\" name=\"packageListFrame\"");
frame("src=\"" + "allclasses-frame.html"
+ "\" name=\"packageFrame\"");
frameSetEnd();
frame("src=\"" + Standard.configuration().topFile +
"\" name=\"classFrame\"");
}
frameSetEnd();
|
| protected void | printFrameWarning()Generate the code for issueing the warning for a non-frame capable web
client. Also provide links to the non-frame version documentation.
noFrames();
h2();
printText("doclet.Frame_Alert");
h2End();
p();
printText("doclet.Frame_Warning_Message");
br();
printText("doclet.Link_To");
printHyperLink(Standard.configuration().topFile,
getText("doclet.Non_Frame_Version"));
noFramesEnd();
|
