uk.ac.ed.ph.snuggletex.jeuclid

Class JEuclidUtilities

java.lang.Object

uk.ac.ed.ph.snuggletex.jeuclid.JEuclidUtilities

public final class JEuclidUtilities
extends Object

Some utility methods for using the JEuclid-based "MathML to Image" conversion functionality.

Version:

$Revision$

Author:

David McKain

See Also:

WebPageOutputOptionsBuilder

Constructor Summary

Constructors

Constructor and Description
JEuclidUtilities()

Method Summary

Modifier and Type	Method and Description
static WebPageOutputOptions	createHTML4WebPageOptions(boolean downConvertFirst, MathMLImageSavingCallback callback) Creates a new WebPageOutputOptions suitably configured for to convert MathML to images, with optional down-conversion.
static WebPageOutputOptions	createHTML5WebPageOptions(boolean downConvertFirst, MathMLImageSavingCallback callback) Creates a new WebPageOutputOptions suitably configured for to convert MathML to images, with optional down-conversion.
static WebPageOutputOptions	createWebPageOptions(boolean downConvertFirst, MathMLImageSavingCallback callback) Deprecated. Use one of the explicit createXHTMLWebPageOptions(boolean, MathMLImageSavingCallback), createHTML4WebPageOptions(boolean, MathMLImageSavingCallback) or createHTML5WebPageOptions(boolean, MathMLImageSavingCallback) methods now.
static WebPageOutputOptions	createXHTMLWebPageOptions(boolean downConvertFirst, MathMLImageSavingCallback callback) Creates a new WebPageOutputOptions suitably configured for to convert MathML to images, with optional down-conversion.
static void	setupJEuclidPostProcessors(DOMOutputOptions options, boolean downConvertFirst, MathMLImageSavingCallback callback) Takes an existing DOMOutputOptions and configures it to convert MathML to images using JEuclid, optionally down-converting simple expressions to HTML+CSS beforehand.

Methods inherited from class java.lang.Object

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

Constructor Detail

JEuclidUtilities

public JEuclidUtilities()

Method Detail

setupJEuclidPostProcessors

public static void setupJEuclidPostProcessors(DOMOutputOptions options,
                                              boolean downConvertFirst,
                                              MathMLImageSavingCallback callback)

Takes an existing DOMOutputOptions and configures it to convert MathML to images using JEuclid, optionally down-converting simple expressions to HTML+CSS beforehand.

This works by replacing any existing DOMPostProcessors. If you want to use other DOMPostProcessors, then you will have to work out whether they fit in with this process and configure things manually.

Parameters:

options - existing DOMOutputOptions Object

downConvertFirst -

callback -

createWebPageOptions

@Deprecated
public static WebPageOutputOptions createWebPageOptions(boolean downConvertFirst,
                                                                     MathMLImageSavingCallback callback)

Deprecated. Use one of the explicit createXHTMLWebPageOptions(boolean, MathMLImageSavingCallback), createHTML4WebPageOptions(boolean, MathMLImageSavingCallback) or createHTML5WebPageOptions(boolean, MathMLImageSavingCallback) methods now.

Creates a new WebPageOutputOptions suitably configured for converting MathML to images, with optional down-conversion. As of SnuggleTeX 1.3.0, this simply calls #createXHTMLWebPageOptions(). This method will be removed in SnuggleTeX 1.4.

Parameters:

downConvertFirst -

callback -

createXHTMLWebPageOptions

public static WebPageOutputOptions createXHTMLWebPageOptions(boolean downConvertFirst,
                                                             MathMLImageSavingCallback callback)

Creates a new WebPageOutputOptions suitably configured for to convert MathML to images, with optional down-conversion. The resulting web page will be XHTML.

Parameters:

downConvertFirst -

callback -

createHTML4WebPageOptions

public static WebPageOutputOptions createHTML4WebPageOptions(boolean downConvertFirst,
                                                             MathMLImageSavingCallback callback)

Creates a new WebPageOutputOptions suitably configured for to convert MathML to images, with optional down-conversion. The resulting web page will be HTML 4.

Parameters:

downConvertFirst -

callback -

createHTML5WebPageOptions

public static WebPageOutputOptions createHTML5WebPageOptions(boolean downConvertFirst,
                                                             MathMLImageSavingCallback callback)

Creates a new WebPageOutputOptions suitably configured for to convert MathML to images, with optional down-conversion. The resulting web page will be HTML 5.

Parameters:

downConvertFirst -

callback -