org.extex.typesetter.listMaker
Interface TokenDelegateListMaker

All Superinterfaces:

ListMaker

All Known Implementing Classes:

AbstractListMaker, DisplaymathListMaker, HAlignListMaker, HorizontalListMaker, InnerVerticalListMaker, MathListMaker, NullTypesetterImpl, RestrictedHorizontalListMaker, TypesetterImpl, VerticalListMaker

public interface TokenDelegateListMaker
extends ListMaker

This interface describes the capabilities of a list maker.

Version:

$Revision$

Author:

Gerd Neugebauer

See Also:

"TeX – The Program [211]"

Method Summary

void	cr(Context context, TypesettingContext tc, UnicodeChar uc) Process a carriage return.
boolean	letter(UnicodeChar uc, TypesettingContext tc, Context context, TokenSource source, Locator locator) Add a letter to the current list or treat it in some other appropriate way.
void	mathShift(Context context, TokenSource source, Token t) Treat a math shift character.
void	subscriptMark(Context context, TokenSource source, Typesetter typesetter, Token token) Treat a subscript mark.
void	superscriptMark(Context context, TokenSource source, Typesetter typesetter, Token token) Treat a superscript mark.
void	tab(Context context, TokenSource source, Token t) Treat a alignment tab character.

Methods inherited from interface org.extex.typesetter.ListMaker

add, add, addAndAdjust, addSpace, afterParagraph, complete, getLastNode, getLocator, getMode, getPrevDepth, getSpacefactor, leftBrace, par, removeLastNode, rightBrace, setPrevDepth, setSpacefactor, showlist

Method Detail

cr

void cr(Context context,
        TypesettingContext tc,
        UnicodeChar uc)
        throws TypesetterException

Process a carriage return.

Parameters:

context - the interpreter context

tc - the typesetting context

uc - the character

Throws:

TypesetterException - in case of an error

letter

boolean letter(UnicodeChar uc,
               TypesettingContext tc,
               Context context,
               TokenSource source,
               Locator locator)
               throws TypesetterException

Add a letter to the current list or treat it in some other appropriate way.

Parameters:

tc - the typesetting context

uc - the character

context - the interpreter context

source - the source for new tokens

locator - the locator

Returns:

true iff the character has been discarded because it is not defined in the current font.

Throws:

TypesetterException - in case of an error

mathShift

void mathShift(Context context,
               TokenSource source,
               Token t)
               throws TypesetterException,
                      ConfigurationException,
                      HelpingException

Treat a math shift character. Usually this leads to entering or leaving math mode – maybe after inspection of a following token.

Parameters:

context - the interpreter context

source - the source for new tokens

t - the actual math shift character token

Throws:

HelpingException - in case of an error

TypesetterException - in case of an error

ConfigurationException - in case of a configuration error

subscriptMark

void subscriptMark(Context context,
                   TokenSource source,
                   Typesetter typesetter,
                   Token token)
                   throws TypesetterException,
                          HelpingException

Treat a subscript mark. This might be meaningful in math mode only.

Parameters:

context - the interpreter context

source - the source for new tokens

typesetter - the typesetter

token - the actual sub mark token

Throws:

HelpingException - in case of an error

TypesetterException - in case of an error

superscriptMark

void superscriptMark(Context context,
                     TokenSource source,
                     Typesetter typesetter,
                     Token token)
                     throws TypesetterException,
                            HelpingException

Treat a superscript mark. This might be meaningful in math mode only.

Parameters:

context - the interpreter context

source - the source for new tokens

typesetter - the typesetter

token - the actual super mark token

Throws:

HelpingException - in case of an error

TypesetterException - in case of an error

tab

void tab(Context context,
         TokenSource source,
         Token t)
         throws TypesetterException,
                ConfigurationException

Treat a alignment tab character.

Parameters:

context - the interpreter context

source - the source for new tokens

t - the actual tab token

Throws:

TypesetterException - in case of an error

ConfigurationException - in case of a configuration error