AllClassesFrameWriter.java revision 181
/*
* Copyright 1998-2003 Sun Microsystems, Inc. All Rights Reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Sun designates this
* particular file as subject to the "Classpath" exception as provided
* by Sun in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
* CA 95054 USA or visit www.sun.com if you need additional information or
* have any questions.
*/
/**
* 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
*
* @author Atul M Dambalkar
* @author Doug Kramer
*/
public class AllClassesFrameWriter extends HtmlDocletWriter {
/**
* The name of the output file with frames
*/
/**
* The name of the output file without frames
*/
/**
* Index of all the classes.
*/
protected IndexBuilder indexbuilder;
/**
* Construct AllClassesFrameWriter object. Also initilises the indexbuilder
* variable in this class.
* @throws IOException
* @throws DocletAbortException
*/
throws IOException {
super(configuration, filename);
this.indexbuilder = indexbuilder;
}
/**
* Create AllClassesFrameWriter object. Then use it to generate the
* "allclasses-frame.html" file. Generate the file in the current or the
* destination directory.
*
* @param indexbuilder IndexBuilder object for all classes index.
* @throws DocletAbortException
*/
try {
allclassgen.close();
allclassgen.generateAllClassesFile(false);
allclassgen.close();
} catch (IOException exc) {
error("doclet.exception_encountered",
throw new DocletAbortException();
}
}
/**
* Print all the classes in table format in the file.
* @param wantFrames True if we want frames.
*/
}
/**
* Use the sorted index of all the classes and print all the classes.
*
* @param wantFrames True if we want frames.
*/
protected void printAllClasses(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. 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.
*
* @param classlist Sorted list of classes.
* @param wantFrames True if we want frames.
*/
continue;
}
if(wantFrames){
label, "classFrame")
);
} else {
}
br();
}
}
/**
* Print the heading "All Classes" and also print Html table tag.
*/
protected void printAllClassesTableHeader() {
strongText("doclet.All_Classes");
fontEnd();
br();
table();
tr();
tdNowrap();
fontStyle("FrameItemFont");
}
/**
* Print Html closing table tag.
*/
protected void printAllClassesTableFooter() {
fontEnd();
tdEnd();
trEnd();
tableEnd();
}
}