org.extex.unit.tex.typesetter.displace
Class Raise

java.lang.Object
  extended by org.extex.interpreter.type.AbstractCode
      extended by org.extex.unit.tex.typesetter.box.AbstractBoxPrimitive
          extended by org.extex.unit.tex.typesetter.displace.Raise
All Implemented Interfaces:
java.io.Serializable, Boxable, BoxOrRule, Code

public class Raise
extends AbstractBoxPrimitive

This class provides an implementation for the primitive \raise.

The Primitive \raise

The primitive \raise takes a box and a length and shifts up the amount specified by the length. If the length is negative then the shift is done downwards.

The primitive \lower is the counterpart to \lower.

Syntax

The formal description of this primitive is the following:
    ⟨raise⟩
      → \raise ⟨dimen⟩ ⟨box⟩  

Examples

    \raise 2em \hbox{abc}  
    \raise -1pt \hbox to 120pt {abc}  
    \raise 2mm \hbox spread 12pt {abc}  

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

Field Summary
protected static long serialVersionUID
          The constant serialVersionUID contains the id for serialization.
 
Constructor Summary
Raise(CodeToken token)
          Creates a new object.
 
Method Summary
 Box getBox(Context context, TokenSource source, Typesetter typesetter, Token insert)
          Getter for the content as Box.
 
Methods inherited from class org.extex.unit.tex.typesetter.box.AbstractBoxPrimitive
execute
 
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

Raise

public Raise(CodeToken token)
Creates a new object.

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

getBox

public Box getBox(Context context,
                  TokenSource source,
                  Typesetter typesetter,
                  Token insert)
           throws HelpingException,
                  TypesetterException
Getter for the content as Box.

Parameters:
context - the interpreter context
source - the source for new tokens
typesetter - the typesetter to use
insert - the token to insert either at the beginning of the box or after the box has been gathered. If it is null then nothing is inserted
Returns:
an appropriate Box
Throws:
HelpingException - in case of an error
TypesetterException - in case of an error in the typesetter
See Also:
BoxPrimitive.getBox( org.extex.interpreter.context.Context, org.extex.interpreter.TokenSource, org.extex.typesetter.Typesetter, org.extex.scanner.type.token.Token)