de.dante.extex.interpreter.primitives.register.box
Class Setbox

java.lang.Object
  extended byde.dante.extex.interpreter.type.AbstractCode
      extended byde.dante.extex.interpreter.primitives.register.box.AbstractBox
          extended byde.dante.extex.interpreter.primitives.register.box.Setbox
All Implemented Interfaces:
Code, Localizable, java.io.Serializable
Direct Known Subclasses:
Dp, Ht, Wd

public class Setbox
extends AbstractBox
implements Code

This class provides an implementation for the primitive \setbox.

The Primitive \setbox

TODO missing documentation

Syntax

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

    ⟨optional prefix⟩
      →
       |  \global ⟨optional prefix⟩  

Examples

    \setbox0\hbox{abc}  

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

Field Summary
protected static long serialVersionUID
          The constant serialVersionUID contains the id for serialization.
 
Constructor Summary
Setbox(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.register.box.AbstractBox
getKey
 
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
 
Methods inherited from interface de.dante.extex.interpreter.type.Code
getName, isIf, isOuter, setName
 

Field Detail

serialVersionUID

protected static final long serialVersionUID
The constant serialVersionUID contains the id for serialization.

See Also:
Constant Field Values
Constructor Detail

Setbox

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

Parameters:
name - the name for 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)