org.extex.unit.tex.register.box
Class BoxPrimitive

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

public class BoxPrimitive
extends AbstractCode
implements Boxable

This class provides an implementation for the primitive \box.

The Primitive \box

The primitive \box inserts the contents of the named box register at the current position. In addition the box register is cleared.

If the primitive is used on the right hand side of a box assignment then the box is cleared and the former contents is used for the assignment.

Syntax

The formal description of this primitive is the following:
    ⟨box⟩
      → \box ⟨box register name⟩ 

Examples

    \box42  

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
BoxPrimitive(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.
 Box getBox(Context context, TokenSource source, Typesetter typesetter, Token insert)
          Getter for the content as Box.
 
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

BoxPrimitive

public BoxPrimitive(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,
                    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
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)

getBox

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

Specified by:
getBox in interface Boxable
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:
ConfigurationException - in case of an configuration error
HelpingException - in case of an error
TypesetterException - in case of an error in the typesetter
See Also:
Boxable.getBox( org.extex.interpreter.context.Context, org.extex.interpreter.TokenSource, org.extex.typesetter.Typesetter, Token)