Package org.scilab.forge.jlatexmath

Class TeXFormula

java.lang.Object

org.scilab.forge.jlatexmath.TeXFormula

Direct Known Subclasses:

ArrayOfAtoms

public class TeXFormula
extends Object

Represents a logical mathematical formula that will be displayed (by creating a TeXIcon from it and painting it) using algorithms that are based on the TeX algorithms.

These formula's can be built using the built-in primitive TeX parser (methods with String arguments) or using other TeXFormula objects. Most methods have (an) equivalent(s) where one or more TeXFormula arguments are replaced with String arguments. These are just shorter notations, because all they do is parse the string(s) to TeXFormula's and call an equivalent method with (a) TeXFormula argument(s). Most methods also come in 2 variants. One kind will use this TeXFormula to build another mathematical construction and then change this object to represent the newly build construction. The other kind will only use other TeXFormula's (or parse strings), build a mathematical construction with them and insert this newly build construction at the end of this TeXFormula. Because all the provided methods return a pointer to this (modified) TeXFormula (except for the createTeXIcon method that returns a TeXIcon pointer), method chaining is also possible.

Important: All the provided methods modify this TeXFormula object, but all the TeXFormula arguments of these methods will remain unchanged and independent of this TeXFormula object!

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	TeXFormula.TeXIconBuilder	Apply the Builder pattern instead of using the createTeXIcon(...) factories

Field Summary

Fields

Modifier and Type	Field	Description
static final int	BOLD
static float	FONT_SCALE_FACTOR
boolean	isColored
static final int	ITALIC
protected Map<String,String>	jlmXMLMap
List<MiddleAtom>	middle
static float	PIXELS_PER_POINT
protected static final float	PREC
static Map<String,TeXFormula>	predefinedTeXFormulas
static Map<String,String>	predefinedTeXFormulasAsString
static final int	ROMAN
Atom	root
static final int	SANSSERIF
static final int	SERIF
static String[]	symbolFormulaMappings
static String[]	symbolMappings
static String[]	symbolTextMappings
String	textStyle
static final int	TYPEWRITER
static final String	VERSION

Constructor Summary

Constructors

Modifier	Constructor	Description
	TeXFormula()	Creates an empty TeXFormula.
	TeXFormula(String s)	Creates a new TeXFormula by parsing the given string (using a primitive TeX parser).
	TeXFormula(String s, boolean firstpass)
	TeXFormula(String s, String textStyle)
	TeXFormula(String s, String textStyle, boolean firstpass, boolean space)
	TeXFormula(String s, Map<String,String> map)	Creates a new TeXFormula by parsing the given string (using a primitive TeX parser).
	TeXFormula(TeXFormula f)	Creates a new TeXFormula that is a copy of the given TeXFormula.
protected	TeXFormula(TeXParser tp)	Creates an empty TeXFormula.
protected	TeXFormula(TeXParser tp, String s)	Creates a new TeXFormula by parsing the given string (using a primitive TeX parser).
protected	TeXFormula(TeXParser tp, String s, boolean firstpass)
protected	TeXFormula(TeXParser tp, String s, String textStyle)
protected	TeXFormula(TeXParser tp, String s, String textStyle, boolean firstpass, boolean space)

Method Summary

Modifier and Type	Method	Description
TeXFormula	add(Atom el)	Inserts an atom at the end of the current formula
static void	addSymbolMappings(InputStream in, String name)
TeXFormula	append(boolean isPartial, String s)
TeXIcon	createTeXIcon(int style, float size)	Creates a TeXIcon from this TeXFormula using the default TeXFont in the given point size and starting from the given TeX style.
static TeXFormula	get(String name)	Get a predefined TeXFormula.
void	setLaTeX(String ltx)	Change the text of the TeXFormula and regenerate the root

Methods inherited from class java.lang.Object

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

Field Details

VERSION

public static final String VERSION

See Also:

• Constant Field Values

SERIF

public static final int SERIF

See Also:

• Constant Field Values

SANSSERIF

public static final int SANSSERIF

See Also:

• Constant Field Values

BOLD

public static final int BOLD

See Also:

• Constant Field Values

ITALIC

public static final int ITALIC

See Also:

• Constant Field Values

ROMAN

public static final int ROMAN

See Also:

• Constant Field Values

TYPEWRITER

public static final int TYPEWRITER

See Also:

• Constant Field Values

PIXELS_PER_POINT

public static float PIXELS_PER_POINT

FONT_SCALE_FACTOR

public static float FONT_SCALE_FACTOR

PREC

protected static final float PREC

See Also:

• Constant Field Values

predefinedTeXFormulas

public static Map<String,TeXFormula> predefinedTeXFormulas

predefinedTeXFormulasAsString

public static Map<String,String> predefinedTeXFormulasAsString

symbolMappings

public static String[] symbolMappings

symbolTextMappings

public static String[] symbolTextMappings

symbolFormulaMappings

public static String[] symbolFormulaMappings

middle

public List<MiddleAtom> middle

jlmXMLMap

protected Map<String,String> jlmXMLMap

root

public Atom root

textStyle

public String textStyle

isColored

public boolean isColored

Constructor Details

TeXFormula

public TeXFormula()

Creates an empty TeXFormula.

TeXFormula

public TeXFormula(String s,
 Map<String,String> map)
           throws ParseException

Creates a new TeXFormula by parsing the given string (using a primitive TeX parser).

Parameters:

s - the string to be parsed

Throws:

ParseException - if the string could not be parsed correctly

TeXFormula

public TeXFormula(String s)
           throws ParseException

Creates a new TeXFormula by parsing the given string (using a primitive TeX parser).

Parameters:

s - the string to be parsed

Throws:

ParseException - if the string could not be parsed correctly

TeXFormula

public TeXFormula(String s,
 boolean firstpass)
           throws ParseException

Throws:

ParseException

TeXFormula

public TeXFormula(String s,
 String textStyle)
           throws ParseException

Throws:

ParseException

TeXFormula

public TeXFormula(String s,
 String textStyle,
 boolean firstpass,
 boolean space)
           throws ParseException

Throws:

ParseException

TeXFormula

public TeXFormula(TeXFormula f)

Creates a new TeXFormula that is a copy of the given TeXFormula.

Both TeXFormula's are independent of one another!

Parameters:

f - the formula to be copied

TeXFormula

protected TeXFormula(TeXParser tp)

Creates an empty TeXFormula.

TeXFormula

protected TeXFormula(TeXParser tp,
 String s)
              throws ParseException

Creates a new TeXFormula by parsing the given string (using a primitive TeX parser).

Parameters:

s - the string to be parsed

Throws:

ParseException - if the string could not be parsed correctly

TeXFormula

protected TeXFormula(TeXParser tp,
 String s,
 boolean firstpass)
              throws ParseException

Throws:

ParseException

TeXFormula

protected TeXFormula(TeXParser tp,
 String s,
 String textStyle)
              throws ParseException

Throws:

ParseException

TeXFormula

protected TeXFormula(TeXParser tp,
 String s,
 String textStyle,
 boolean firstpass,
 boolean space)
              throws ParseException

Throws:

ParseException

Method Details

addSymbolMappings

public static void addSymbolMappings(InputStream in,
 String name)
                              throws ResourceParseException

Throws:

ResourceParseException

setLaTeX

public void setLaTeX(String ltx)
              throws ParseException

Change the text of the TeXFormula and regenerate the root

Parameters:

ltx - the latex formula

Throws:

ParseException

add

public TeXFormula add(Atom el)

Inserts an atom at the end of the current formula

append

public TeXFormula append(boolean isPartial,
 String s)
                  throws ParseException

Throws:

ParseException

createTeXIcon

public TeXIcon createTeXIcon(int style,
 float size)

Creates a TeXIcon from this TeXFormula using the default TeXFont in the given point size and starting from the given TeX style. If the given integer value does not represent a valid TeX style, the default style TeXConstants.STYLE_DISPLAY will be used.

Parameters:

style - a TeX style constant (from TeXConstants) to start from

size - the default TeXFont's point size

Returns:

the created TeXIcon

get

public static TeXFormula get(String name)
                      throws FormulaNotFoundException

Get a predefined TeXFormula.

Parameters:

name - the name of the predefined TeXFormula

Returns:

a copy of the predefined TeXFormula

Throws:

FormulaNotFoundException - if no predefined TeXFormula is found with the given name