Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

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

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.BoxPrimitive
All Implemented Interfaces:
Boxable, BoxOrRule, Code, Localizable, java.io.Serializable
Direct Known Subclasses:
Copy
public class BoxPrimitive
extends AbstractBox
implements Boxable, java.io.Serializable

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: 1.29 $
Author:
Gerd Neugebauer
See Also:
Serialized Form

Field Summary
protected static long serialVersionUID
          The constant serialVersionUID contains the id for serialization.
 
Constructor Summary
BoxPrimitive(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.
 Box getBox(Context context, TokenSource source, Typesetter typesetter)
          Getter for the content as Box.
 
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
 

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(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)

getBox

public Box getBox(Context context,
                  TokenSource source,
                  Typesetter typesetter)
           throws InterpreterException
Description copied from interface: Boxable
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
Returns:
an appropriate Box
Throws:
InterpreterException - in case of an error
See Also:
Boxable.getBox( de.dante.extex.interpreter.context.Context, de.dante.extex.interpreter.TokenSource, de.dante.extex.typesetter.Typesetter)
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD