org.extex.unit.tex.math.fraction
Class Atopwithdelims

java.lang.Object
  extended by org.extex.interpreter.type.AbstractCode
      extended by org.extex.unit.tex.math.AbstractMathCode
          extended by org.extex.unit.tex.math.delimiter.AbstractTeXDelimiter
              extended by org.extex.unit.tex.math.fraction.Atopwithdelims
All Implemented Interfaces:
java.io.Serializable, Code

public class Atopwithdelims
extends AbstractTeXDelimiter

This class provides an implementation for the primitive \atopwithdelims.

The Math Primitive \atopwithdelims

The math primitive \atopwithdelims arranges that the material in the math group before it is typeset above the material after the primitive. The two parts are not separated by a line. The construction is enclosed in the delimiters given

If several primitives of type \above, \abovewithdelims, \atop, \atopwithdelims, \over, or \overwithdelims are encountered in the same math group then the result is ambiguous and an error is raised.

If the primitive is used outside of math mode then an error is raised.

Syntax

The formal description of this primitive is the following:
    ⟨atopwithdelims⟩
       → ⟨math material⟩ \atopwithdelims ... ⟨math material⟩ 

Examples

    {a\atopwithdelims\delimiter"123456\delimiter"123456 b} 

Version:
$Revision: 4732 $
Author:
Gerd Neugebauer
See Also:
Serialized Form

Field Summary
protected static long serialVersionUID
          The constant serialVersionUID contains the id for serialization.
 
Constructor Summary
Atopwithdelims(CodeToken token)
          Creates a new object.
 
Method Summary
 void execute(Flags prefix, Context context, TokenSource source, Typesetter typesetter)
          This method takes the first token and executes it. The result is placed on the stack. This operation might have side effects. To execute a token it might be necessary to consume further tokens.
 
Methods inherited from class org.extex.unit.tex.math.delimiter.AbstractTeXDelimiter
delimiterToLong, getMyLocalizer, newMathDelimiter, parseDelimiter
 
Methods inherited from class org.extex.unit.tex.math.AbstractMathCode
getListMaker
 
Methods inherited from class org.extex.interpreter.type.AbstractCode
getLocalizer, getName, getToken, isIf, isOuter, readResolve, toString, toText, toText
 
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

Atopwithdelims

public Atopwithdelims(CodeToken token)
Creates a new object.

Parameters:
token - the initial token for the primitive
Method Detail

execute

public void execute(Flags prefix,
                    Context context,
                    TokenSource source,
                    Typesetter typesetter)
             throws HelpingException,
                    ConfigurationException,
                    TypesetterException
This method takes the first token and executes it. The result is placed on the stack. This operation might have side effects. To execute a token it might be necessary to consume further tokens.

Specified by:
execute in interface Code
Overrides:
execute in class AbstractCode
Parameters:
prefix - the prefix controlling the execution
context - the interpreter context
source - the token source
typesetter - the typesetter
Throws:
HelpingException - in case of an error
ConfigurationException - in case of an configuration error
TypesetterException - in case of an error in the typesetter
See Also:
AbstractCode.execute( org.extex.interpreter.Flags, org.extex.interpreter.context.Context, org.extex.interpreter.TokenSource, org.extex.typesetter.Typesetter)