uk.ac.ed.ph.snuggletex.jeuclid

Class SimpleMathMLImageSavingCallback

java.lang.Object

uk.ac.ed.ph.snuggletex.jeuclid.SimpleMathMLImageSavingCallback

All Implemented Interfaces:

MathMLImageSavingCallback

public abstract class SimpleMathMLImageSavingCallback
extends Object
implements MathMLImageSavingCallback

Partial convenience implementation of MathMLImageSavingCallback that assumes that the same Content Type will be used to produce each MathML image and restricts the number of configurable features somewhat.

Version:

$Revision$

Author:

David McKain

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_ANTI_ALIASING
static String	DEFAULT_CONTENT_TYPE
static String	DEFAULT_FONT_SIZE

Constructor Summary

Constructors

Constructor and Description
SimpleMathMLImageSavingCallback()

Method Summary

Modifier and Type	Method and Description
String	getFontSize()
String	getImageContentType()
String	getImageContentType(int mathmlCounter) Implement to return the desired MIME type for the resulting image.
abstract File	getImageOutputFile(int mathmlCounter) Implement if you want the resulting image to be written to a File of your choice.
abstract OutputStream	getImageOutputStream(int mathmlCounter) Implement this if you want the resulting image to be written to an OutputStream of your choice.
abstract String	getImageURL(int mathmlCounter) Implement to return the URL String that will be put into the img src attribute to refer to the image.
net.sourceforge.jeuclid.MutableLayoutContext	getLayoutContext(int mathmlCounter) Implement to fill in the JEuclid MutableLayoutContext specifying how you want to render this image.
void	imageSavingSucceeded(Object imageFileOrOutputStream, int mathmlCounter, String contentType) (A "do nothing" implementation for convenience.)
boolean	isAntiAliasing()
void	setAntiAliasing(boolean antiAliasing)
void	setFontSize(String fontSize)
void	setImageContentType(String imageType)

Methods inherited from class java.lang.Object

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

Methods inherited from interface uk.ac.ed.ph.snuggletex.jeuclid.MathMLImageSavingCallback

imageSavingFailed

Field Detail

DEFAULT_FONT_SIZE

public static String DEFAULT_FONT_SIZE

DEFAULT_CONTENT_TYPE

public static String DEFAULT_CONTENT_TYPE

DEFAULT_ANTI_ALIASING

public static boolean DEFAULT_ANTI_ALIASING

Constructor Detail

SimpleMathMLImageSavingCallback

public SimpleMathMLImageSavingCallback()

Method Detail

getFontSize

public String getFontSize()

setFontSize

public void setFontSize(String fontSize)

isAntiAliasing

public boolean isAntiAliasing()

setAntiAliasing

public void setAntiAliasing(boolean antiAliasing)

getImageContentType

public String getImageContentType()

setImageContentType

public void setImageContentType(String imageType)

getImageContentType

public final String getImageContentType(int mathmlCounter)

Description copied from interface: MathMLImageSavingCallback

Implement to return the desired MIME type for the resulting image.

Consult the JEuclid documentation for what is supported; you may need to add additional libraries for certain MIME types.

SnuggleTeX contains everything required to support PNG. Note that conversion to GIF does not generally work well so should be avoided...!

Specified by:

getImageContentType in interface MathMLImageSavingCallback

Parameters:

mathmlCounter - identifies the position of the image within the document being processed, which can be used to ensure unique file names.

getLayoutContext

public final net.sourceforge.jeuclid.MutableLayoutContext getLayoutContext(int mathmlCounter)

Description copied from interface: MathMLImageSavingCallback

Implement to fill in the JEuclid MutableLayoutContext specifying how you want to render this image.

Specified by:

getLayoutContext in interface MathMLImageSavingCallback

Parameters:

mathmlCounter - identifies the position of the image within the document being processed, which can be used to ensure unique file names.

getImageOutputFile

public abstract File getImageOutputFile(int mathmlCounter)

Description copied from interface: MathMLImageSavingCallback

Implement if you want the resulting image to be written to a File of your choice. Return null if you want the image to be written to the result of MathMLImageSavingCallback.getImageOutputStream(int) instead.

Specified by:

getImageOutputFile in interface MathMLImageSavingCallback

Parameters:

mathmlCounter - identifies the position of the image within the document being processed, which can be used to ensure unique file names.

See Also:

MathMLImageSavingCallback.getImageOutputFile(int)

getImageOutputStream

public abstract OutputStream getImageOutputStream(int mathmlCounter)

Description copied from interface: MathMLImageSavingCallback

Implement this if you want the resulting image to be written to an OutputStream of your choice. The method MathMLImageSavingCallback.getImageOutputFile(int) is checked first, so must return null in this case.

Specified by:

getImageOutputStream in interface MathMLImageSavingCallback

Parameters:

mathmlCounter - identifies the position of the image within the document being processed, which can be used to ensure unique file names.

See Also:

MathMLImageSavingCallback.getImageOutputStream(int)

getImageURL

public abstract String getImageURL(int mathmlCounter)

Description copied from interface: MathMLImageSavingCallback

Implement to return the URL String that will be put into the img src attribute to refer to the image.

Specified by:

getImageURL in interface MathMLImageSavingCallback

Parameters:

mathmlCounter - identifies the position of the image within the document being processed, which can be used to ensure unique file names.

See Also:

MathMLImageSavingCallback.getImageURL(int)

imageSavingSucceeded

public void imageSavingSucceeded(Object imageFileOrOutputStream,
                                 int mathmlCounter,
                                 String contentType)

(A "do nothing" implementation for convenience.)

Specified by:

imageSavingSucceeded in interface MathMLImageSavingCallback

Parameters:

imageFileOrOutputStream - File or OutputStream written

mathmlCounter - identifies the position of the image within the document being processed, which can be used to ensure unique file names.

contentType - content type of the saved image File

See Also:

MathMLImageSavingCallback.imageSavingSucceeded(Object, int, String)