uk.ac.ed.ph.snuggletex.jeuclid

Interface MathMLImageSavingCallback

All Known Implementing Classes:

SimpleMathMLImageSavingCallback

public interface MathMLImageSavingCallback

Trivial callback interface used by JEuclidMathMLPostProcessor to determine where to save each generating MathML image and the URL to use in the resulting HTML as it traverses a given DOM Document.

You should implement this to do whatever is appropriate for your needs.

This can be used independently of SnuggleTeX.

Version:

$Revision$

Author:

David McKain

See Also:

JEuclidMathMLPostProcessor

Method Summary

Modifier and Type	Method and Description
String	getImageContentType(int mathmlCounter) Implement to return the desired MIME type for the resulting image.
File	getImageOutputFile(int mathmlCounter) Implement if you want the resulting image to be written to a File of your choice.
OutputStream	getImageOutputStream(int mathmlCounter) Implement this if you want the resulting image to be written to an OutputStream of your choice.
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	imageSavingFailed(Object imageFileOrOutputStream, int mathmlCounter, String contentType, Throwable exception) Called back if MathML image could not be saved for some reason.
void	imageSavingSucceeded(Object imageFileOrOutputStream, int mathmlCounter, String contentType) Called back once a MathML image has been saved successfully.

Method Detail

getImageContentType

String getImageContentType(int mathmlCounter)

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...!

Parameters:

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

getImageOutputFile

File getImageOutputFile(int mathmlCounter)

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 getImageOutputStream(int) instead.

Parameters:

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

getImageOutputStream

OutputStream getImageOutputStream(int mathmlCounter)

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

Parameters:

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

getImageURL

String getImageURL(int mathmlCounter)

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

Parameters:

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

getLayoutContext

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

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

Parameters:

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

imageSavingSucceeded

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

Called back once a MathML image has been saved successfully. Implementors can do anything they need to do at this point.

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

imageSavingFailed

void imageSavingFailed(Object imageFileOrOutputStream,
                       int mathmlCounter,
                       String contentType,
                       Throwable exception)

Called back if MathML image could not be saved for some reason.

Parameters:

imageFileOrOutputStream - File or OutputStream that would have been written if successful

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

exception - cause of the failure, which may be null