org.extex.typesetter.listMaker
Class AbstractListMaker

java.lang.Object
  org.extex.typesetter.listMaker.AbstractListMaker

All Implemented Interfaces:

ListMaker, TokenDelegateListMaker

Direct Known Subclasses:

HorizontalListMaker, InnerVerticalListMaker

public abstract class AbstractListMaker
extends java.lang.Object
implements TokenDelegateListMaker

This abstract class provides some methods common to all ListMakers.

Version:

$Revision: 5947 $

Author:

Gerd Neugebauer

Constructor Summary

AbstractListMaker(ListManager theManager, Locator locator)
Creates a new object.

Method Summary

protected Localizer	getLocalizer() Getter for the localizer.
Locator	getLocator() Getter for the locator.
ListManager	getManager() Getter for manager.
abstract Mode	getMode() Getter for the current mode.
protected Localizer	getMyLocalizer() Getter for the localizer.
FixedDimen	getPrevDepth() Getter for the previous depth parameter.
long	getSpacefactor() Getter for the space factor.
void	leftBrace() Notification method to deal the case that a left brace has been encountered.
void	mathShift(Context context, TokenSource source, Token t) Treat a math shift character.
void	rightBrace() Notification method to deal the case that a right brace has been encountered.
void	setPrevDepth(FixedDimen pd) Setter for the previous depth parameter.
void	setSpacefactor(FixedCount sf) Setter for the space factor.
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 token) Treat a alignment tab character.
java.lang.String	toString() Get the string representation of this object for debugging purposes.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.extex.typesetter.listMaker.TokenDelegateListMaker

cr, letter

Methods inherited from interface org.extex.typesetter.ListMaker

add, add, addAndAdjust, addSpace, afterParagraph, complete, getLastNode, par, removeLastNode, showlist

Constructor Detail

AbstractListMaker

public AbstractListMaker(ListManager theManager,
                         Locator locator)

Creates a new object.

Parameters:

theManager - the manager to ask for global changes

locator - the locator

Method Detail

getLocalizer

protected Localizer getLocalizer()

Getter for the localizer.

Returns:

the localizer

getLocator

public Locator getLocator()

Getter for the locator.

Specified by:

getLocator in interface ListMaker

Returns:

the locator

See Also:

ListMaker.getLocator()

getManager

public ListManager getManager()

Getter for manager.

Returns:

the manager.

getMode

public abstract Mode getMode()

Getter for the current mode.

Specified by:

getMode in interface ListMaker

Returns:

the mode which is one of the values defined in Mode.

See Also:

ListMaker.getMode()

getMyLocalizer

protected Localizer getMyLocalizer()

Getter for the localizer.

Returns:

the localizer

getPrevDepth

public FixedDimen getPrevDepth()
                        throws TypesetterUnsupportedException

Getter for the previous depth parameter.

Specified by:

getPrevDepth in interface ListMaker

Returns:

the previous depth

Throws:

TypesetterUnsupportedException - in case of an error

See Also:

ListMaker.getPrevDepth()

getSpacefactor

public long getSpacefactor()
                    throws TypesetterUnsupportedException

Description copied from interface: ListMaker

Getter for the space factor.

Specified by:

getSpacefactor in interface ListMaker

Returns:

the space factor

Throws:

TypesetterUnsupportedException - in case of an error

See Also:

ListMaker.getSpacefactor()

leftBrace

public void leftBrace()

Notification method to deal the case that a left brace has been encountered.

Specified by:

leftBrace in interface ListMaker

See Also:

ListMaker.leftBrace()

mathShift

public 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.

Specified by:

mathShift in interface TokenDelegateListMaker

Parameters:

context - the interpreter context

source - the source for new tokens

t - the actual math shift character token

Throws:

TypesetterException - in case of an error

ConfigurationException - in case of a configuration error

HelpingException - in case of an error

See Also:

TokenDelegateListMaker.mathShift( org.extex.interpreter.context.Context, org.extex.interpreter.TokenSource, org.extex.scanner.type.token.Token)

rightBrace

public void rightBrace()
                throws TypesetterException

Notification method to deal the case that a right brace has been encountered.

Specified by:

rightBrace in interface ListMaker

Throws:

TypesetterException - in case of an error

See Also:

ListMaker.rightBrace()

setPrevDepth

public void setPrevDepth(FixedDimen pd)
                  throws TypesetterUnsupportedException

Setter for the previous depth parameter.

Specified by:

setPrevDepth in interface ListMaker

Parameters:

pd - the previous depth parameter

Throws:

TypesetterUnsupportedException - in case of an error

See Also:

ListMaker.setPrevDepth( org.extex.core.dimen.FixedDimen)

setSpacefactor

public void setSpacefactor(FixedCount sf)
                    throws TypesetterUnsupportedException,
                           InvalidSpacefactorException

Setter for the space factor.

Specified by:

setSpacefactor in interface ListMaker

Parameters:

sf - the space factor to set

Throws:

TypesetterUnsupportedException - in case of an error

InvalidSpacefactorException - in case of an invalid space factor

See Also:

ListMaker.setSpacefactor( org.extex.core.count.FixedCount)

subscriptMark

public 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.

Specified by:

subscriptMark in interface TokenDelegateListMaker

Parameters:

context - the interpreter context

source - the source for new tokens

typesetter - the typesetter

token - the actual sub mark token

Throws:

TypesetterException - in case of an error

HelpingException - in case of an error

See Also:

TokenDelegateListMaker.subscriptMark( org.extex.interpreter.context.Context, org.extex.interpreter.TokenSource, org.extex.typesetter.Typesetter, org.extex.scanner.type.token.Token)

superscriptMark

public 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.

Specified by:

superscriptMark in interface TokenDelegateListMaker

Parameters:

context - the interpreter context

source - the source for new tokens

typesetter - the typesetter

token - the actual super mark token

Throws:

TypesetterException - in case of an error

HelpingException - in case of an error

See Also:

TokenDelegateListMaker.superscriptMark( org.extex.interpreter.context.Context, org.extex.interpreter.TokenSource, org.extex.typesetter.Typesetter, org.extex.scanner.type.token.Token)

tab

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

Treat a alignment tab character.

Specified by:

tab in interface TokenDelegateListMaker

Parameters:

context - the interpreter context

source - the source for new tokens

token - the actual tab token

Throws:

TypesetterException - in case of an error

ConfigurationException - in case of a configuration error

See Also:

TokenDelegateListMaker.tab( org.extex.interpreter.context.Context, org.extex.interpreter.TokenSource, org.extex.scanner.type.token.Token)

toString

public java.lang.String toString()

Get the string representation of this object for debugging purposes.

Overrides:

toString in class java.lang.Object

Returns:

the string representation

See Also:

Object.toString()