org.extex.typesetter.type.noad
Interface Noad

All Known Implementing Classes:

AbstractNoad, AbstractNucleusNoad, AccentNoad, BinaryNoad, CharNoad, ChoiceNoad, CloseNoad, FractionNoad, GlueNoad, InnerNoad, KernNoad, LeftNoad, MathDelimiter, MathGlyph, MathList, MiddleNoad, NodeNoad, OpenNoad, OperatorNoad, OrdinaryNoad, OverlinedNoad, PunctationNoad, RadicalNoad, RelationNoad, RightNoad, StyleNoad, UnderlinedNoad, VCenterNoad

public interface Noad

The interface Noad is a type of data structure which represents mathematical constructions.

Version:

$Revision: 4739 $

Author:

Gerd Neugebauer

Method Summary

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.
void	toString(java.lang.StringBuffer sb) Produce a printable representation of the noad in a StringBuffer.
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.

Method Detail

getSpacingClass

MathSpacing getSpacingClass()

Getter for spacing class.

Returns:

the spacing class

getSubscript

Noad getSubscript()

Getter for the subscript.

Returns:

the subscript.

getSuperscript

Noad getSuperscript()

Getter for the superscript.

Returns:

the superscript.

setSpacingClass

void setSpacingClass(MathSpacing spacingClass)

Setter for spacing class.

Parameters:

spacingClass - the spacing class to set

setSubscript

void setSubscript(Noad subscript)

Setter for the subscript.

Parameters:

subscript - the subscript to set.

setSuperscript

void setSuperscript(Noad superscript)

Setter for the superscript.

Parameters:

superscript - the superscript to set.

toString

void toString(java.lang.StringBuffer sb)

Produce a printable representation of the noad in a StringBuffer.

Parameters:

sb - the string buffer

toString

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

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

Parameters:

sb - the string buffer

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

typeset

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

Translate a Noad into a NodeList.

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

ConfigurationException - in case of a configuration problem