org.extex.typesetter.listMaker.math
Class DisplaymathListMaker

java.lang.Object
  org.extex.typesetter.listMaker.AbstractListMaker
      org.extex.typesetter.listMaker.HorizontalListMaker
          org.extex.typesetter.listMaker.math.MathListMaker
              org.extex.typesetter.listMaker.math.DisplaymathListMaker

All Implemented Interfaces:

LogEnabled, ListMaker, EqConsumer, NoadConsumer, TokenDelegateListMaker

public class DisplaymathListMaker
extends MathListMaker
implements EqConsumer

This is the list maker for the display math formulae.

The Tokens Parameter \everydisplayend

The tokens parameter \everydisplayend contains a list of tokens which is inserted at the end of display math. Those tokens take effect just before the math mode is ended but after any tokens given explicitly.

Syntax

The formal description of this primitive is the following:

    ⟨everydisplayend⟩
      → \everydisplayend ⟨equals⟩ ⟨tokens⟩  

Examples

    \everydisplayend={\,}  

The Tokens Parameter \everydisplay

The tokens parameter \everydisplay contains a list of tokens which is inserted at the beginning of display math. Those tokens take effect after the math mode has been entered but before any tokens given explicitly.

Syntax

The formal description of this primitive is the following:

    ⟨everydisplay⟩
      → \everydisplay ⟨equals⟩ ⟨tokens⟩  

Examples

    \everydisplay={\,}  

Version:

$Revision:4496 $

Author:

Gerd Neugebauer

Constructor Summary

DisplaymathListMaker(ListManager manager, Locator locator)
Creates a new object.

Method Summary

NodeList	complete(TypesetterOptions context) Close the node list.
Mode	getMode() Getter for the current mode.
void	mathShift(Context context, TokenSource source, Token t) Treat a math shift character.
void	switchToNumber(boolean left) This method switches the collection of material to the target "equation number".

Methods inherited from class org.extex.typesetter.listMaker.math.MathListMaker

add, add, add, add, add, add, add, addSpace, cr, enableLogging, getInsertionPoint, getLastNoad, getLastNode, getLogger, getNoads, insufficientExtensionFonts, insufficientSymbolFonts, isClosing, left, leftBrace, letter, middle, par, removeLastNode, right, rightBrace, scanNoad, setClosing, setInsertionPoint, showlist, subscriptMark, superscriptMark, switchToFraction

Methods inherited from class org.extex.typesetter.listMaker.HorizontalListMaker

add, addAndAdjust, afterParagraph, getNodes, getSpacefactor, setNodes, setSpacefactor, toString

Methods inherited from class org.extex.typesetter.listMaker.AbstractListMaker

getLocalizer, getLocator, getManager, getMyLocalizer, getPrevDepth, setPrevDepth, tab

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

add, addAndAdjust, afterParagraph, getLocator, getPrevDepth, getSpacefactor, setPrevDepth, setSpacefactor

Constructor Detail

DisplaymathListMaker

public DisplaymathListMaker(ListManager manager,
                            Locator locator)

Creates a new object.

Parameters:

manager - the manager to ask for global changes

locator - the locator

Method Detail

complete

public NodeList complete(TypesetterOptions context)
                  throws TypesetterException

Close the node list. In the course of the closing, the Noad list is translated into a Node list.

Specified by:

complete in interface ListMaker

Overrides:

complete in class MathListMaker

Parameters:

context - the fragment of the context accessible for the typesetter

Returns:

the node list enclosed in this instance

Throws:

TypesetterException - in case of an error

See Also:

ListMaker.complete(TypesetterOptions)

getMode

public Mode getMode()

Getter for the current mode.

Specified by:

getMode in interface ListMaker

Overrides:

getMode in class MathListMaker

Returns:

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

See Also:

ListMaker.getMode()

mathShift

public void mathShift(Context context,
                      TokenSource source,
                      Token t)
               throws TypesetterException,
                      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

Overrides:

mathShift in class MathListMaker

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

HelpingException - in case of an error

See Also:

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

switchToNumber

public void switchToNumber(boolean left)
                    throws CantUseInException

This method switches the collection of material to the target "equation number".

Specified by:

switchToNumber in interface EqConsumer

Parameters:

left - the indicator on which side to produce the equation number. A value true indicates that the left side should be used.

Throws:

CantUseInException - in case that the EqConsumer is in a mode where a switching to the number is not possible

See Also:

EqConsumer.switchToNumber(boolean)