de.java2html.converter
Class JavaSource2HTMLConverter

java.lang.Object
  de.java2html.converter.AbstractJavaSourceConverter
      de.java2html.converter.JavaSource2HTMLConverter

All Implemented Interfaces:

IJavaSourceConverter

public class JavaSource2HTMLConverter
extends AbstractJavaSourceConverter

Algorithm and stuff for converting a TypedSource object to to a HTML string representation. The result is XHTML1.0 Transitional compliant. For questions, suggestions, bug-reports, enhancement-requests etc. I may be contacted at: markus@jave.de The Java2html home page is located at: http://www.java2html.de

Author:

Markus Gebhard Copyright (C) Markus Gebhard 2000-2002 This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This program 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 for more details. You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.

Field Summary

static boolean

java2HtmlHomepageLinkEnabled Deprecated. As of Jan 2, 2004 (Markus Gebhard) replaced by JavaSourceConversionOptions.setShowJava2HtmlLink(boolean)

Constructor Summary

JavaSource2HTMLConverter()

Method Summary

void	convert(TypedSource source, JavaSourceConversionOptions options, java.io.BufferedWriter writer)
java.lang.String	getBlockSeparator(JavaSourceConversionOptions options) Returns the code that has to be placed between two blocks of converted code.
java.lang.String	getDocumentFooter(JavaSourceConversionOptions options) Returns a footer for the result document.
java.lang.String	getDocumentHeader(JavaSourceConversionOptions options, java.lang.String title) Returns a header for the result document.

Methods inherited from class de.java2html.converter.AbstractJavaSourceConverter

convert, getDefaultFileExtension, getMetaData, writeBlockSeparator, writeDocumentFooter, writeDocumentHeader

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

java2HtmlHomepageLinkEnabled

@Deprecated
public static boolean java2HtmlHomepageLinkEnabled

Deprecated. As of Jan 2, 2004 (Markus Gebhard) replaced by JavaSourceConversionOptions.setShowJava2HtmlLink(boolean)

Flag indication whether html output contains a link to the Java2Html-Homepage or not.

Constructor Detail

JavaSource2HTMLConverter

public JavaSource2HTMLConverter()

Method Detail

getDocumentHeader

public java.lang.String getDocumentHeader(JavaSourceConversionOptions options,
                                          java.lang.String title)

Description copied from class: AbstractJavaSourceConverter

Returns a header for the result document. This one will be placed before the first block of converted code. Subclasses can return an empty String ("") if there is none neccessary.

Specified by:

getDocumentHeader in class AbstractJavaSourceConverter

getDocumentFooter

public java.lang.String getDocumentFooter(JavaSourceConversionOptions options)

Description copied from class: AbstractJavaSourceConverter

Returns a footer for the result document. This one will be placed behind the last block of converted code. Subclasses can return an empty String ("") if there is none neccessary.

Specified by:

getDocumentFooter in class AbstractJavaSourceConverter

getBlockSeparator

public java.lang.String getBlockSeparator(JavaSourceConversionOptions options)

Description copied from class: AbstractJavaSourceConverter

Returns the code that has to be placed between two blocks of converted code. Subclasses can return an empty String ("") if there is none neccessary.

Specified by:

getBlockSeparator in class AbstractJavaSourceConverter

convert

public void convert(TypedSource source,
                    JavaSourceConversionOptions options,
                    java.io.BufferedWriter writer)
             throws java.io.IOException

Specified by:

convert in class AbstractJavaSourceConverter

Throws:

java.io.IOException