org.xwiki.formula

Interface FormulaRenderer

All Known Implementing Classes:

AbstractFormulaRenderer

@Role
public interface FormulaRenderer

Convert a LaTeX formula into an image.

Since:

2.0M3

Version:

$Id: 3a01bdca2ae766e12573a71285dc7f98b6990328 $

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	FormulaRenderer.FontSize Encloses the supported LaTeX font sizes used for displaying a mathematical formula.
static class	FormulaRenderer.Type Encloses the supported formats for rendered mathematical formulae.

Method Summary

Modifier and Type	Method and Description
ImageData	getImage(String imageID) Retrieve the image data from the storage.
String	process(String formula, boolean inline, FormulaRenderer.FontSize size, FormulaRenderer.Type type) Generates the image (if not already generated), stores it, and returns a key which can be used for retrieving it in a subsequent request.

Method Detail

process

String process(String formula,
               boolean inline,
               FormulaRenderer.FontSize size,
               FormulaRenderer.Type type)
        throws IllegalArgumentException,
               IOException

Generates the image (if not already generated), stores it, and returns a key which can be used for retrieving it in a subsequent request.

Parameters:

formula - the mathematical formula to render, in LaTeX format, without the surrounding math-mode commands ($, begin{math}, etc.)

inline - whether the formula appears inline inside the text, or as a standalone block

size - the font size to use for the text

type - The type of image to generate. See the FormulaRenderer.Type enum for supported types. Not all renderers support all types.

Returns:

an identifier which can be used for retrieving the image from the storage

Throws:

IllegalArgumentException - if the LaTeX syntax of the formula is incorrect and the error is unrecoverable

IOException - in case of a renderer execution error

getImage

ImageData getImage(String imageID)

Retrieve the image data from the storage.

Parameters:

imageID - the identifier for the image, returned by process(String, boolean, FontSize, Type)

Returns:

the generated ImageData, or null if no image exists with this identifier