de.dante.extex.interpreter.primitives.math.fraction
Class Above

java.lang.Object
  extended byde.dante.extex.interpreter.type.AbstractCode
      extended byde.dante.extex.interpreter.primitives.math.AbstractMathCode
          extended byde.dante.extex.interpreter.primitives.math.fraction.Above
All Implemented Interfaces:
Code, Localizable, java.io.Serializable

public class Above
extends AbstractMathCode

This class provides an implementation for the primitive \above.

The Math Primitive \above

The math primitive \above arranges that the material in the math group before it is typeset above the material after the primitive. The two parts are separated by a line of the width given. If the width is less than 0pt then no rule is drawn but the given height is left blank.

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:
    ⟨above⟩
       → ⟨math material⟩ \above ⟨dimen⟩ ⟨math material⟩ 

Examples

    {a \above.1pt b}  

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

Field Summary
protected static long serialVersionUID
          The constant serialVersionUID contains the id for serialization.
 
Constructor Summary
Above(java.lang.String name)
          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.
 
Methods inherited from class de.dante.extex.interpreter.primitives.math.AbstractMathCode
getListMaker
 
Methods inherited from class de.dante.extex.interpreter.type.AbstractCode
enableLocalization, getLocalizer, getName, isIf, isOuter, printable, printableControlSequence, readResolve, setName, toString
 
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

Above

public Above(java.lang.String name)
Creates a new object.

Parameters:
name - the name for tracing and debugging
Method Detail

execute

public void execute(Flags prefix,
                    Context context,
                    TokenSource source,
                    Typesetter typesetter)
             throws InterpreterException
Description copied from interface: Code
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
Throws:
InterpreterException
See Also:
Code.execute( de.dante.extex.interpreter.Flags, de.dante.extex.interpreter.context.Context, de.dante.extex.interpreter.TokenSource, de.dante.extex.typesetter.Typesetter)