/*
* Copyright (c) 1997, 2010, Oracle and/or its affiliates. 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. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle 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 Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package com.sun.tools.doclets.formats.html.markup;
import java.io.*;
import java.util.*;
import com.sun.javadoc.*;
import com.sun.tools.doclets.internal.toolkit.*;
/**
* Class for the Html Format Code Generation specific to JavaDoc.
* This Class contains methods related to the Html Code Generation which
* are used by the Sub-Classes in the package com.sun.tools.doclets.standard
* and com.sun.tools.doclets.oneone.
*
* @since 1.2
* @author Atul M Dambalkar
* @author Robert Field
*/
public abstract class HtmlDocWriter extends HtmlWriter {
/**
* Constructor. Initializes the destination file name through the super
* class HtmlWriter.
*
* @param filename String file name.
*/
public HtmlDocWriter(Configuration configuration,
String filename) throws IOException {
super(configuration,
null, configuration.destDirName + filename,
configuration.docencoding);
// use File to normalize file separators
configuration.message.notice("doclet.Generating_0",
new File(configuration.destDirName, filename));
}
public HtmlDocWriter(Configuration configuration,
String path, String filename) throws IOException {
super(configuration,
configuration.destDirName + path, filename,
configuration.docencoding);
// use File to normalize file separators
configuration.message.notice("doclet.Generating_0",
new File(configuration.destDirName,
((path.length() > 0)? path + File.separator: "") + filename));
}
/**
* Accessor for configuration.
*/
public abstract Configuration configuration();
/**
* Print Html Hyper Link.
*
* @param link String name of the file.
* @param where Position of the link in the file. Character '#' is not
* needed.
* @param label Tag for the link.
* @param strong Boolean that sets label to strong.
*/
public void printHyperLink(String link, String where,
String label, boolean strong) {
print(getHyperLinkString(link, where, label, strong, "", "", ""));
}
/**
* Print Html Hyper Link.
*
* @param link String name of the file.
* @param where Position of the link in the file. Character '#' is not
* needed.
* @param label Tag for the link.
*/
public void printHyperLink(String link, String where, String label) {
printHyperLink(link, where, label, false);
}
/**
* Print Html Hyper Link.
*
* @param link String name of the file.
* @param where Position of the link in the file. Character '#' is not
* needed.
* @param label Tag for the link.
* @param strong Boolean that sets label to strong.
* @param stylename String style of text defined in style sheet.
*/
public void printHyperLink(String link, String where,
String label, boolean strong,
String stylename) {
print(getHyperLinkString(link, where, label, strong, stylename, "", ""));
}
/**
* Return Html Hyper Link string.
*
* @param link String name of the file.
* @param where Position of the link in the file. Character '#' is not
* needed.
* @param label Tag for the link.
* @param strong Boolean that sets label to strong.
* @return String Hyper Link.
*/
public String getHyperLinkString(String link, String where,
String label, boolean strong) {
return getHyperLinkString(link, where, label, strong, "", "", "");
}
/**
* Get Html Hyper Link string.
*
* @param link String name of the file.
* @param where Position of the link in the file. Character '#' is not
* needed.
* @param label Tag for the link.
* @param strong Boolean that sets label to strong.
* @param stylename String style of text defined in style sheet.
* @return String Hyper Link.
*/
public String getHyperLinkString(String link, String where,
String label, boolean strong,
String stylename) {
return getHyperLinkString(link, where, label, strong, stylename, "", "");
}
/**
* Get Html Hyper Link string.
*
* @param link String name of the file.
* @param where Position of the link in the file. Character '#' is not
* needed.
* @param label Tag for the link.
* @return a content tree for the hyper link
*/
public Content getHyperLink(String link, String where,
Content label) {
return getHyperLink(link, where, label, "", "");
}
/**
* Get Html Hyper Link string.
*
* @param link String name of the file.
* @param where Position of the link in the file. Character '#' is not
* needed.
* @param label Tag for the link.
* @param strong Boolean that sets label to strong.
* @param stylename String style of text defined in style sheet.
* @param title String that describes the link's content for accessibility.
* @param target Target frame.
* @return String Hyper Link.
*/
public String getHyperLinkString(String link, String where,
String label, boolean strong,
String stylename, String title, String target) {
StringBuffer retlink = new StringBuffer();
retlink.append("<a href=\"");
retlink.append(link);
if (where != null && where.length() != 0) {
retlink.append("#");
retlink.append(where);
}
retlink.append("\"");
if (title != null && title.length() != 0) {
retlink.append(" title=\"" + title + "\"");
}
if (target != null && target.length() != 0) {
retlink.append(" target=\"" + target + "\"");
}
retlink.append(">");
if (stylename != null && stylename.length() != 0) {
retlink.append("<FONT CLASS=\"");
retlink.append(stylename);
retlink.append("\">");
}
if (strong) {
retlink.append("<span class=\"strong\">");
}
retlink.append(label);
if (strong) {
retlink.append("</span>");
}
if (stylename != null && stylename.length() != 0) {
retlink.append("</FONT>");
}
retlink.append("</a>");
return retlink.toString();
}
/**
* Get Html Hyper Link.
*
* @param link String name of the file.
* @param where Position of the link in the file. Character '#' is not
* needed.
* @param label Tag for the link.
* @param title String that describes the link's content for accessibility.
* @param target Target frame.
* @return a content tree for the hyper link.
*/
public Content getHyperLink(String link, String where,
Content label, String title, String target) {
if (where != null && where.length() != 0) {
link += "#" + where;
}
HtmlTree anchor = HtmlTree.A(link, label);
if (title != null && title.length() != 0) {
anchor.addAttr(HtmlAttr.TITLE, title);
}
if (target != null && target.length() != 0) {
anchor.addAttr(HtmlAttr.TARGET, target);
}
return anchor;
}
/**
* Get a hyperlink to a file.
*
* @param link String name of the file
* @param label Label for the link
* @return a content for the hyperlink to the file
*/
public Content getHyperLink(String link, Content label) {
return getHyperLink(link, "", label);
}
/**
* Get link string without positioning in the file.
*
* @param link String name of the file.
* @param label Tag for the link.
* @return Strign Hyper link.
*/
public String getHyperLinkString(String link, String label) {
return getHyperLinkString(link, "", label, false);
}
/**
* Print the name of the package, this class is in.
*
* @param cd ClassDoc.
*/
public void printPkgName(ClassDoc cd) {
print(getPkgName(cd));
}
/**
* Get the name of the package, this class is in.
*
* @param cd ClassDoc.
*/
public String getPkgName(ClassDoc cd) {
String pkgName = cd.containingPackage().name();
if (pkgName.length() > 0) {
pkgName += ".";
return pkgName;
}
return "";
}
/**
* Keep track of member details list. Print the definition list start tag
* if it is not printed yet.
*/
public void printMemberDetailsListStartTag () {
if (!getMemberDetailsListPrinted()) {
dl();
memberDetailsListPrinted = true;
}
}
/**
* Print the definition list end tag if the list start tag was printed.
*/
public void printMemberDetailsListEndTag () {
if (getMemberDetailsListPrinted()) {
dlEnd();
memberDetailsListPrinted = false;
}
}
public boolean getMemberDetailsListPrinted() {
return memberDetailsListPrinted;
}
/**
* Print the frameset version of the Html file header.
* Called only when generating an HTML frameset file.
*
* @param title Title of this HTML document
* @param noTimeStamp If true, don't print time stamp in header
* @param frameset the frameset to be added to the HTML document
*/
public void printFramesetDocument(String title, boolean noTimeStamp,
Content frameset) {
Content htmlDocType = DocType.Frameset();
Content htmlComment = new Comment(configuration.getText("doclet.New_Page"));
Content head = new HtmlTree(HtmlTag.HEAD);
if (! noTimeStamp) {
Content headComment = new Comment("Generated by javadoc on " + today());
head.addContent(headComment);
}
if (configuration.charset.length() > 0) {
Content meta = HtmlTree.META("Content-Type", "text/html",
configuration.charset);
head.addContent(meta);
}
Content windowTitle = HtmlTree.TITLE(new StringContent(title));
head.addContent(windowTitle);
head.addContent(getFramesetJavaScript());
Content htmlTree = HtmlTree.HTML(configuration.getLocale().getLanguage(),
head, frameset);
Content htmlDocument = new HtmlDocument(htmlDocType,
htmlComment, htmlTree);
print(htmlDocument.toString());
}
/**
* Print the appropriate spaces to format the class tree in the class page.
*
* @param len Number of spaces.
*/
public String spaces(int len) {
String space = "";
for (int i = 0; i < len; i++) {
space += " ";
}
return space;
}
/**
* Print the closing </body> and </html> tags.
*/
public void printBodyHtmlEnd() {
println();
bodyEnd();
htmlEnd();
}
/**
* Calls {@link #printBodyHtmlEnd()} method.
*/
public void printFooter() {
printBodyHtmlEnd();
}
/**
* Print closing </html> tag.
*/
public void printFrameFooter() {
htmlEnd();
}
/**
* Print ten non-breaking spaces(" ").
*/
public void printNbsps() {
print(" ");
}
/**
* Get the day and date information for today, depending upon user option.
*
* @return String Today.
* @see java.util.Calendar
* @see java.util.GregorianCalendar
* @see java.util.TimeZone
*/
public String today() {
Calendar calendar = new GregorianCalendar(TimeZone.getDefault());
return calendar.getTime().toString();
}
}