org.extex.typesetter.type.math
Class MathDelimiter

java.lang.Object
  org.extex.typesetter.type.math.MathDelimiter

All Implemented Interfaces:

java.io.Serializable, Noad

public class MathDelimiter
extends java.lang.Object
implements Noad, java.io.Serializable

This class provides a container for a delimiter consisting of a class, a large, and a small math glyph.

Version:

$Revision: 6457 $

Author:

Gerd Neugebauer

See Also:

Serialized Form

Field Summary

protected static long

serialVersionUID The constant serialVersionUID contains the id for serialization.

Constructor Summary

MathDelimiter(MathClass mathClass, MathGlyph smallChar, MathGlyph largeChar)
Creates a new object.

Method Summary

MathGlyph	getLargeChar() Getter for largeChar.
MathClass	getMathClass() Getter for mathClass.
MathGlyph	getSmallChar() Getter for smallChar.
MathSpacing	getSpacingClass() Getter for spacing class.
Noad	getSubscript() Getter for the subscript.
Noad	getSuperscript() Getter for the superscript.
void	setSpacingClass(MathSpacing spacingClass) Setter for spacing class.
void	setSubscript(Noad subscript) Setter for the subscript.
void	setSuperscript(Noad superscript) Setter for the superscript.
java.lang.String	toString() Returns a string representation of the object.
void	toString(java.lang.StringBuffer sb) Append the printable representation of the current instance to the string buffer.
void	toString(java.lang.StringBuffer sb, int depth) Produce a printable representation to a certain depth of the noad.
void	typeset(Noad previousNoad, NoadList noads, int index, NodeList list, MathContext mathContext, java.util.logging.Logger logger) Translate a Noad into a NodeList.
void	typeset(NodeList list, MathContext mathContext, FixedDimen height, FixedDimen depth) Translate a MathDelimter into a NodeList.

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

protected static final long serialVersionUID

The constant serialVersionUID contains the id for serialization.

See Also:

Constant Field Values

Constructor Detail

MathDelimiter

public MathDelimiter(MathClass mathClass,
                     MathGlyph smallChar,
                     MathGlyph largeChar)

Creates a new object.

Parameters:

mathClass - the class

smallChar - the small character

largeChar - the large character

Method Detail

getLargeChar

public MathGlyph getLargeChar()

Getter for largeChar.

Returns:

the largeChar.

getMathClass

public MathClass getMathClass()

Getter for mathClass.

Returns:

the mathClass.

getSmallChar

public MathGlyph getSmallChar()

Getter for smallChar.

Returns:

the smallChar.

getSpacingClass

public MathSpacing getSpacingClass()

Getter for spacing class.

Specified by:

getSpacingClass in interface Noad

Returns:

the spacing class

See Also:

Noad.getSpacingClass()

getSubscript

public Noad getSubscript()

Getter for the subscript.

Specified by:

getSubscript in interface Noad

Returns:

the subscript.

See Also:

Noad.getSubscript()

getSuperscript

public Noad getSuperscript()

Getter for the superscript.

Specified by:

getSuperscript in interface Noad

Returns:

the superscript.

See Also:

Noad.getSuperscript()

setSpacingClass

public void setSpacingClass(MathSpacing spacingClass)

Setter for spacing class.

Specified by:

setSpacingClass in interface Noad

Parameters:

spacingClass - the spacing class to set

See Also:

Noad.setSpacingClass( org.extex.typesetter.type.noad.util.MathSpacing)

setSubscript

public void setSubscript(Noad subscript)

Setter for the subscript.

Specified by:

setSubscript in interface Noad

Parameters:

subscript - the subscript to set.

See Also:

Noad.setSubscript( org.extex.typesetter.type.noad.Noad)

setSuperscript

public void setSuperscript(Noad superscript)

Setter for the superscript.

Specified by:

setSuperscript in interface Noad

Parameters:

superscript - the superscript to set.

See Also:

Noad.setSuperscript( org.extex.typesetter.type.noad.Noad)

toString

public java.lang.String toString()

Returns a string representation of the object.

Overrides:

toString in class java.lang.Object

Returns:

a string representation of the object.

See Also:

Object.toString()

toString

public void toString(java.lang.StringBuffer sb)

Append the printable representation of the current instance to the string buffer.

Specified by:

toString in interface Noad

Parameters:

sb - the target string buffer

See Also:

"TTP [691]"

toString

public void toString(java.lang.StringBuffer sb,
                     int depth)

Produce a printable representation to a certain depth of the noad.

Specified by:

toString in interface Noad

Parameters:

sb - the string buffer

depth - the depth to which the full information should be given

See Also:

Noad.toString( java.lang.StringBuffer, int)

typeset

public void typeset(Noad previousNoad,
                    NoadList noads,
                    int index,
                    NodeList list,
                    MathContext mathContext,
                    java.util.logging.Logger logger)
             throws TypesetterException

Translate a Noad into a NodeList.

Specified by:

typeset in interface Noad

Parameters:

previousNoad - the previous noad

noads - the list of noads currently processed

index - the index of the current node in the list

list - the list to add the nodes to. This list contains the Nodes previously typeset. Thus it can be used to look back

mathContext - the context to consider

logger - the logger for debugging and tracing information

Throws:

TypesetterException - in case of a problem

See Also:

Noad.typeset( org.extex.typesetter.type.noad.Noad, org.extex.typesetter.type.noad.NoadList, int, org.extex.typesetter.type.NodeList, org.extex.typesetter.type.noad.util.MathContext, java.util.logging.Logger)

typeset

public void typeset(NodeList list,
                    MathContext mathContext,
                    FixedDimen height,
                    FixedDimen depth)
             throws TypesetterException,
                    ConfigurationException

Translate a MathDelimter into a NodeList.

Parameters:

list - the list to add the nodes to. This list contains the Nodes previously typeset. Thus it can be used to look back

mathContext - the context to consider

height - the target height. If null then the natural height is used

depth - the target depth. If null then the natural depth is used

Throws:

TypesetterException - in case of a problem

ConfigurationException - in case of a configuration problem