langtools/src/share/classes/com/sun/tools/doclets/formats/html/markup/HtmlWriter.java
6794582: javadoc should read files using a FileManager
Reviewed-by: darcy, bpatel
/*
* Copyright 1997-2006 Sun Microsystems, Inc. All Rights Reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* 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.
*/
package com.sun.tools.doclets.formats.html.markup;
import com.sun.tools.doclets.internal.toolkit.*;
import com.sun.tools.doclets.internal.toolkit.util.*;
import java.io.*;
/**
* Class for the Html format code generation.
* Initilizes PrintWriter with FileWriter, to enable print
* related methods to generate the code to the named File through FileWriter.
*
* @since 1.2
* @author Atul M Dambalkar
*/
public class HtmlWriter extends PrintWriter {
/**
* Name of the file, to which this writer is writing to.
*/
protected final String htmlFilename;
/**
* The window title of this file
*/
protected String winTitle;
/**
* URL file separator string("/").
*/
public static final String fileseparator =
DirectoryManager.URL_FILE_SEPERATOR;
/**
* The configuration
*/
protected Configuration configuration;
/**
* Constructor.
*
* @param path The directory path to be created for this file
* or null if none to be created.
* @param filename File Name to which the PrintWriter will
* do the Output.
* @param docencoding Encoding to be used for this file.
* @exception IOException Exception raised by the FileWriter is passed on
* to next level.
* @exception UnSupportedEncodingException Exception raised by the
* OutputStreamWriter is passed on to next level.
*/
public HtmlWriter(Configuration configuration,
String path, String filename, String docencoding)
throws IOException, UnsupportedEncodingException {
super(Util.genWriter(configuration, path, filename, docencoding));
this.configuration = configuration;
htmlFilename = filename;
}
/**
* Print <HTML> tag. Add a newline character at the end.
*/
public void html() {
println("<HTML lang=\"" + configuration.getLocale().getLanguage() + "\">");
}
/**
* Print </HTML> tag. Add a newline character at the end.
*/
public void htmlEnd() {
println("</HTML>");
}
/**
* Print the script code to be embeded before the </HEAD> tag.
*/
protected void printWinTitleScript(String winTitle){
if(winTitle != null && winTitle.length() > 0) {
script();
println("function windowTitle()");
println("{");
println(" if (location.href.indexOf('is-external=true') == -1) {");
println(" parent.document.title=\"" + winTitle + "\";");
println(" }");
println("}");
scriptEnd();
noScript();
noScriptEnd();
}
}
/**
* Print the Javascript <SCRIPT> start tag with its type
* attribute.
*/
public void script() {
println("<SCRIPT type=\"text/javascript\">");
}
/**
* Print the Javascript </SCRIPT> end tag.
*/
public void scriptEnd() {
println("</SCRIPT>");
}
/**
* Print the Javascript <NOSCRIPT> start tag.
*/
public void noScript() {
println("<NOSCRIPT>");
}
/**
* Print the Javascript </NOSCRIPT> end tag.
*/
public void noScriptEnd() {
println("</NOSCRIPT>");
}
/**
* Return the Javascript call to be embedded in the <BODY> tag.
* Return nothing if winTitle is empty.
* @return the Javascript call to be embedded in the <BODY> tag.
*/
protected String getWindowTitleOnload(){
if(winTitle != null && winTitle.length() > 0) {
return " onload=\"windowTitle();\"";
} else {
return "";
}
}
/**
* Print <BODY BGCOLOR="bgcolor">, including JavaScript
* "onload" call to load windowtitle script. This script shows the name
* of the document in the window title bar when frames are on.
*
* @param bgcolor Background color.
* @param includeScript boolean set true if printing windowtitle script
*/
public void body(String bgcolor, boolean includeScript) {
print("<BODY BGCOLOR=\"" + bgcolor + "\"");
if (includeScript) {
print(getWindowTitleOnload());
}
println(">");
}
/**
* Print </BODY> tag. Add a newline character at the end.
*/
public void bodyEnd() {
println("</BODY>");
}
/**
* Print <TITLE> tag. Add a newline character at the end.
*/
public void title() {
println("<TITLE>");
}
/**
* Print <TITLE> tag. Add a newline character at the end.
*
* @param winTitle The title of this document.
*/
public void title(String winTitle) {
// Set window title string which is later printed
this.winTitle = winTitle;
title();
}
/**
* Print </TITLE> tag. Add a newline character at the end.
*/
public void titleEnd() {
println("</TITLE>");
}
/**
* Print <UL> tag. Add a newline character at the end.
*/
public void ul() {
println("<UL>");
}
/**
* Print </UL> tag. Add a newline character at the end.
*/
public void ulEnd() {
println("</UL>");
}
/**
* Print <LI> tag.
*/
public void li() {
print("<LI>");
}
/**
* Print <LI TYPE="type"> tag.
*
* @param type Type string.
*/
public void li(String type) {
print("<LI TYPE=\"" + type + "\">");
}
/**
* Print <H1> tag. Add a newline character at the end.
*/
public void h1() {
println("<H1>");
}
/**
* Print </H1> tag. Add a newline character at the end.
*/
public void h1End() {
println("</H1>");
}
/**
* Print text with <H1> tag. Also adds </H1> tag. Add a newline character
* at the end of the text.
*
* @param text Text to be printed with <H1> format.
*/
public void h1(String text) {
h1();
println(text);
h1End();
}
/**
* Print <H2> tag. Add a newline character at the end.
*/
public void h2() {
println("<H2>");
}
/**
* Print text with <H2> tag. Also adds </H2> tag. Add a newline character
* at the end of the text.
*
* @param text Text to be printed with <H2> format.
*/
public void h2(String text) {
h2();
println(text);
h2End();
}
/**
* Print </H2> tag. Add a newline character at the end.
*/
public void h2End() {
println("</H2>");
}
/**
* Print <H3> tag. Add a newline character at the end.
*/
public void h3() {
println("<H3>");
}
/**
* Print text with <H3> tag. Also adds </H3> tag. Add a newline character
* at the end of the text.
*
* @param text Text to be printed with <H3> format.
*/
public void h3(String text) {
h3();
println(text);
h3End();
}
/**
* Print </H3> tag. Add a newline character at the end.
*/
public void h3End() {
println("</H3>");
}
/**
* Print <H4> tag. Add a newline character at the end.
*/
public void h4() {
println("<H4>");
}
/**
* Print </H4> tag. Add a newline character at the end.
*/
public void h4End() {
println("</H4>");
}
/**
* Print text with <H4> tag. Also adds </H4> tag. Add a newline character
* at the end of the text.
*
* @param text Text to be printed with <H4> format.
*/
public void h4(String text) {
h4();
println(text);
h4End();
}
/**
* Print <H5> tag. Add a newline character at the end.
*/
public void h5() {
println("<H5>");
}
/**
* Print </H5> tag. Add a newline character at the end.
*/
public void h5End() {
println("</H5>");
}
/**
* Print HTML <IMG SRC="imggif" WIDTH="width" HEIGHT="height" ALT="imgname>
* tag. It prepends the "images" directory name to the "imggif". This
* method is used for oneone format generation. Add a newline character
* at the end.
*
* @param imggif Image GIF file.
* @param imgname Image name.
* @param width Width of the image.
* @param height Height of the image.
*/
public void img(String imggif, String imgname, int width, int height) {
println("<IMG SRC=\"images/" + imggif + ".gif\""
+ " WIDTH=\"" + width + "\" HEIGHT=\"" + height
+ "\" ALT=\"" + imgname + "\">");
}
/**
* Print <MENU> tag. Add a newline character at the end.
*/
public void menu() {
println("<MENU>");
}
/**
* Print </MENU> tag. Add a newline character at the end.
*/
public void menuEnd() {
println("</MENU>");
}
/**
* Print <PRE> tag. Add a newline character at the end.
*/
public void pre() {
println("<PRE>");
}
/**
* Print <PRE> tag without adding new line character at th eend.
*/
public void preNoNewLine() {
print("<PRE>");
}
/**
* Print </PRE> tag. Add a newline character at the end.
*/
public void preEnd() {
println("</PRE>");
}
/**
* Print <HR> tag. Add a newline character at the end.
*/
public void hr() {
println("<HR>");
}
/**
* Print <HR SIZE="size" WIDTH="widthpercent%"> tag. Add a newline
* character at the end.
*
* @param size Size of the ruler.
* @param widthPercent Percentage Width of the ruler
*/
public void hr(int size, int widthPercent) {
println("<HR SIZE=\"" + size + "\" WIDTH=\"" + widthPercent + "%\">");
}
/**
* Print <HR SIZE="size" NOSHADE> tag. Add a newline character at the end.
*
* @param size Size of the ruler.
* @param noshade noshade string.
*/
public void hr(int size, String noshade) {
println("<HR SIZE=\"" + size + "\" NOSHADE>");
}
/**
* Get the "<STRONG>" string.
*
* @return String Return String "<STRONG>";
*/
public String getStrong() {
return "<STRONG>";
}
/**
* Get the "</STRONG>" string.
*
* @return String Return String "</STRONG>";
*/
public String getStrongEnd() {
return "</STRONG>";
}
/**
* Print <STRONG> tag.
*/
public void strong() {
print("<STRONG>");
}
/**
* Print </STRONG> tag.
*/
public void strongEnd() {
print("</STRONG>");
}
/**
* Print text passed, in strong format using <STRONG> and </STRONG> tags.
*
* @param text String to be printed in between <STRONG> and </STRONG> tags.
*/
public void strong(String text) {
strong();
print(text);
strongEnd();
}
/**
* Print text passed, in Italics using <I> and </I> tags.
*
* @param text String to be printed in between <I> and </I> tags.
*/
public void italics(String text) {
print("<I>");
print(text);
println("</I>");
}
/**
* Return, text passed, with Italics <I> and </I> tags, surrounding it.
* So if the text passed is "Hi", then string returned will be "<I>Hi</I>".
*
* @param text String to be printed in between <I> and </I> tags.
*/
public String italicsText(String text) {
return "<I>" + text + "</I>";
}
public String codeText(String text) {
return "<CODE>" + text + "</CODE>";
}
/**
* Print "&nbsp;", non-breaking space.
*/
public void space() {
print(" ");
}
/**
* Print <DL> tag. Add a newline character at the end.
*/
public void dl() {
println("<DL>");
}
/**
* Print </DL> tag. Add a newline character at the end.
*/
public void dlEnd() {
println("</DL>");
}
/**
* Print <DT> tag.
*/
public void dt() {
print("<DT>");
}
/**
* Print <DT> tag.
*/
public void dd() {
print("<DD>");
}
/**
* Print </DD> tag. Add a newline character at the end.
*/
public void ddEnd() {
println("</DD>");
}
/**
* Print <SUP> tag. Add a newline character at the end.
*/
public void sup() {
println("<SUP>");
}
/**
* Print </SUP> tag. Add a newline character at the end.
*/
public void supEnd() {
println("</SUP>");
}
/**
* Print <FONT SIZE="size"> tag. Add a newline character at the end.
*
* @param size String size.
*/
public void font(String size) {
println("<FONT SIZE=\"" + size + "\">");
}
/**
* Print <FONT SIZE="size"> tag.
*
* @param size String size.
*/
public void fontNoNewLine(String size) {
print("<FONT SIZE=\"" + size + "\">");
}
/**
* Print <FONT CLASS="stylename"> tag. Add a newline character at the end.
*
* @param stylename String stylename.
*/
public void fontStyle(String stylename) {
print("<FONT CLASS=\"" + stylename + "\">");
}
/**
* Print <FONT SIZE="size" CLASS="stylename"> tag. Add a newline character
* at the end.
*
* @param size String size.
* @param stylename String stylename.
*/
public void fontSizeStyle(String size, String stylename) {
println("<FONT size=\"" + size + "\" CLASS=\"" + stylename + "\">");
}
/**
* Print </FONT> tag.
*/
public void fontEnd() {
print("</FONT>");
}
/**
* Get the "<FONT COLOR="color">" string.
*
* @param color String color.
* @return String Return String "<FONT COLOR="color">".
*/
public String getFontColor(String color) {
return "<FONT COLOR=\"" + color + "\">";
}
/**
* Get the "</FONT>" string.
*
* @return String Return String "</FONT>";
*/
public String getFontEnd() {
return "</FONT>";
}
/**
* Print <CENTER> tag. Add a newline character at the end.
*/
public void center() {
println("<CENTER>");
}
/**
* Print </CENTER> tag. Add a newline character at the end.
*/
public void centerEnd() {
println("</CENTER>");
}
/**
* Print anchor <A NAME="name"> tag.
*
* @param name Name String.
*/
public void aName(String name) {
print("<A NAME=\"" + name + "\">");
}
/**
* Print </A> tag.
*/
public void aEnd() {
print("</A>");
}
/**
* Print <I> tag.
*/
public void italic() {
print("<I>");
}
/**
* Print </I> tag.
*/
public void italicEnd() {
print("</I>");
}
/**
* Print contents within anchor <A NAME="name"> tags.
*
* @param name String name.
* @param content String contents.
*/
public void anchor(String name, String content) {
aName(name);
print(content);
aEnd();
}
/**
* Print anchor <A NAME="name"> and </A>tags. Print comment string
* "<!-- -->" within those tags.
*
* @param name String name.
*/
public void anchor(String name) {
anchor(name, "<!-- -->");
}
/**
* Print newline and then print <P> tag. Add a newline character at the
* end.
*/
public void p() {
println();
println("<P>");
}
/**
* Print newline and then print </P> tag. Add a newline character at the
* end.
*/
public void pEnd() {
println();
println("</P>");
}
/**
* Print newline and then print <BR> tag. Add a newline character at the
* end.
*/
public void br() {
println();
println("<BR>");
}
/**
* Print <ADDRESS> tag. Add a newline character at the end.
*/
public void address() {
println("<ADDRESS>");
}
/**
* Print </ADDRESS> tag. Add a newline character at the end.
*/
public void addressEnd() {
println("</ADDRESS>");
}
/**
* Print <HEAD> tag. Add a newline character at the end.
*/
public void head() {
println("<HEAD>");
}
/**
* Print </HEAD> tag. Add a newline character at the end.
*/
public void headEnd() {
println("</HEAD>");
}
/**
* Print <CODE> tag.
*/
public void code() {
print("<CODE>");
}
/**
* Print </CODE> tag.
*/
public void codeEnd() {
print("</CODE>");
}
/**
* Print <EM> tag. Add a newline character at the end.
*/
public void em() {
println("<EM>");
}
/**
* Print </EM> tag. Add a newline character at the end.
*/
public void emEnd() {
println("</EM>");
}
/**
* Print HTML <TABLE BORDER="border" WIDTH="width"
* CELLPADDING="cellpadding" CELLSPACING="cellspacing"> tag.
*
* @param border Border size.
* @param width Width of the table.
* @param cellpadding Cellpadding for the table cells.
* @param cellspacing Cellspacing for the table cells.
*/
public void table(int border, String width, int cellpadding,
int cellspacing) {
println(DocletConstants.NL +
"<TABLE BORDER=\"" + border +
"\" WIDTH=\"" + width +
"\" CELLPADDING=\"" + cellpadding +
"\" CELLSPACING=\"" + cellspacing +
"\" SUMMARY=\"\">");
}
/**
* Print HTML <TABLE BORDER="border" CELLPADDING="cellpadding"
* CELLSPACING="cellspacing"> tag.
*
* @param border Border size.
* @param cellpadding Cellpadding for the table cells.
* @param cellspacing Cellspacing for the table cells.
*/
public void table(int border, int cellpadding, int cellspacing) {
println(DocletConstants.NL +
"<TABLE BORDER=\"" + border +
"\" CELLPADDING=\"" + cellpadding +
"\" CELLSPACING=\"" + cellspacing +
"\" SUMMARY=\"\">");
}
/**
* Print HTML <TABLE BORDER="border" WIDTH="width">
*
* @param border Border size.
* @param width Width of the table.
*/
public void table(int border, String width) {
println(DocletConstants.NL +
"<TABLE BORDER=\"" + border +
"\" WIDTH=\"" + width +
"\" SUMMARY=\"\">");
}
/**
* Print the HTML table tag with border size 0 and width 100%.
*/
public void table() {
table(0, "100%");
}
/**
* Print </TABLE> tag. Add a newline character at the end.
*/
public void tableEnd() {
println("</TABLE>");
}
/**
* Print <TR> tag. Add a newline character at the end.
*/
public void tr() {
println("<TR>");
}
/**
* Print </TR> tag. Add a newline character at the end.
*/
public void trEnd() {
println("</TR>");
}
/**
* Print <TD> tag.
*/
public void td() {
print("<TD>");
}
/**
* Print <TD NOWRAP> tag.
*/
public void tdNowrap() {
print("<TD NOWRAP>");
}
/**
* Print <TD WIDTH="width"> tag.
*
* @param width String width.
*/
public void tdWidth(String width) {
print("<TD WIDTH=\"" + width + "\">");
}
/**
* Print </TD> tag. Add a newline character at the end.
*/
public void tdEnd() {
println("</TD>");
}
/**
* Print <LINK str> tag.
*
* @param str String.
*/
public void link(String str) {
println("<LINK " + str + ">");
}
/**
* Print "<!-- " comment start string.
*/
public void commentStart() {
print("<!-- ");
}
/**
* Print "-->" comment end string. Add a newline character at the end.
*/
public void commentEnd() {
println("-->");
}
/**
* Print <TR BGCOLOR="color" CLASS="stylename"> tag. Adds a newline character
* at the end.
*
* @param color String color.
* @param stylename String stylename.
*/
public void trBgcolorStyle(String color, String stylename) {
println("<TR BGCOLOR=\"" + color + "\" CLASS=\"" + stylename + "\">");
}
/**
* Print <TR BGCOLOR="color"> tag. Adds a newline character at the end.
*
* @param color String color.
*/
public void trBgcolor(String color) {
println("<TR BGCOLOR=\"" + color + "\">");
}
/**
* Print <TR ALIGN="align" VALIGN="valign"> tag. Adds a newline character
* at the end.
*
* @param align String align.
* @param valign String valign.
*/
public void trAlignVAlign(String align, String valign) {
println("<TR ALIGN=\"" + align + "\" VALIGN=\"" + valign + "\">");
}
/**
* Print <TH ALIGN="align"> tag.
*
* @param align the align attribute.
*/
public void thAlign(String align) {
print("<TH ALIGN=\"" + align + "\">");
}
/**
* Print <TH align="align" COLSPAN=i> tag.
*
* @param align the align attribute.
* @param i integer.
*/
public void thAlignColspan(String align, int i) {
print("<TH ALIGN=\"" + align + "\" COLSPAN=\"" + i + "\">");
}
/**
* Print <TH align="align" NOWRAP> tag.
*
* @param align the align attribute.
*/
public void thAlignNowrap(String align) {
print("<TH ALIGN=\"" + align + "\" NOWRAP>");
}
/**
* Print </TH> tag. Add a newline character at the end.
*/
public void thEnd() {
println("</TH>");
}
/**
* Print <TD COLSPAN=i> tag.
*
* @param i integer.
*/
public void tdColspan(int i) {
print("<TD COLSPAN=" + i + ">");
}
/**
* Print <TD BGCOLOR="color" CLASS="stylename"> tag.
*
* @param color String color.
* @param stylename String stylename.
*/
public void tdBgcolorStyle(String color, String stylename) {
print("<TD BGCOLOR=\"" + color + "\" CLASS=\"" + stylename + "\">");
}
/**
* Print <TD COLSPAN=i BGCOLOR="color" CLASS="stylename"> tag.
*
* @param i integer.
* @param color String color.
* @param stylename String stylename.
*/
public void tdColspanBgcolorStyle(int i, String color, String stylename) {
print("<TD COLSPAN=" + i + " BGCOLOR=\"" + color + "\" CLASS=\"" +
stylename + "\">");
}
/**
* Print <TD ALIGN="align"> tag. Adds a newline character
* at the end.
*
* @param align String align.
*/
public void tdAlign(String align) {
print("<TD ALIGN=\"" + align + "\">");
}
/**
* Print <TD ALIGN="align" CLASS="stylename"> tag.
*
* @param align String align.
* @param stylename String stylename.
*/
public void tdVAlignClass(String align, String stylename) {
print("<TD VALIGN=\"" + align + "\" CLASS=\"" + stylename + "\">");
}
/**
* Print <TD VALIGN="valign"> tag.
*
* @param valign String valign.
*/
public void tdVAlign(String valign) {
print("<TD VALIGN=\"" + valign + "\">");
}
/**
* Print <TD ALIGN="align" VALIGN="valign"> tag.
*
* @param align String align.
* @param valign String valign.
*/
public void tdAlignVAlign(String align, String valign) {
print("<TD ALIGN=\"" + align + "\" VALIGN=\"" + valign + "\">");
}
/**
* Print <TD ALIGN="align" ROWSPAN=rowspan> tag.
*
* @param align String align.
* @param rowspan integer rowspan.
*/
public void tdAlignRowspan(String align, int rowspan) {
print("<TD ALIGN=\"" + align + "\" ROWSPAN=" + rowspan + ">");
}
/**
* Print <TD ALIGN="align" VALIGN="valign" ROWSPAN=rowspan> tag.
*
* @param align String align.
* @param valign String valign.
* @param rowspan integer rowspan.
*/
public void tdAlignVAlignRowspan(String align, String valign,
int rowspan) {
print("<TD ALIGN=\"" + align + "\" VALIGN=\"" + valign
+ "\" ROWSPAN=" + rowspan + ">");
}
/**
* Print <BLOCKQUOTE> tag. Add a newline character at the end.
*/
public void blockquote() {
println("<BLOCKQUOTE>");
}
/**
* Print </BLOCKQUOTE> tag. Add a newline character at the end.
*/
public void blockquoteEnd() {
println("</BLOCKQUOTE>");
}
/**
* Get the "<CODE>" string.
*
* @return String Return String "<CODE>";
*/
public String getCode() {
return "<CODE>";
}
/**
* Get the "</CODE>" string.
*
* @return String Return String "</CODE>";
*/
public String getCodeEnd() {
return "</CODE>";
}
/**
* Print <NOFRAMES> tag. Add a newline character at the end.
*/
public void noFrames() {
println("<NOFRAMES>");
}
/**
* Print </NOFRAMES> tag. Add a newline character at the end.
*/
public void noFramesEnd() {
println("</NOFRAMES>");
}
}