de.dante.extex.interpreter.primitives.info
Class Showbox

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.info.Showbox
All Implemented Interfaces:
Code, Localizable, LogEnabled, java.io.Serializable

public class Showbox
extends AbstractBox
implements LogEnabled

This class provides an implementation for the primitive \showbox.

The Primitive \showbox

The primitive \showbox produces a listing of the box register given as parameter. The listing is restricted in breadth and depth by the count registers \showboxbreadth and \showboxdepth respectively.

Syntax

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

Examples

    \showbox 1  

The Count Parameter \showboxbreadth

The count register \showboxbreadth contains the breadth to which the box produced by \showbox should be presented.

Syntax

The formal description of this primitive is the following:
    ⟨showboxbreadth⟩
      → \showboxbreadth ⟨equals⟩ ⟨number⟩  

Examples

    \showboxbreadth=16  

The Count Parameter \showboxdepth

The count register \showboxdepth contains the depth to which the box produced by \showbox should be presented.

Syntax

The formal description of this primitive is the following:
    ⟨showboxdepth⟩
      → \showboxdepth ⟨equals⟩ ⟨number⟩  

Examples

    \showboxdepth=16  

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

Field Summary
protected static long serialVersionUID
          The constant serialVersionUID contains the id for serialization.
 
Constructor Summary
Showbox(java.lang.String name)
          Creates a new object.
 
Method Summary
 void enableLogging(java.util.logging.Logger theLogger)
          Setter for the logger.
 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
 

Field Detail

serialVersionUID

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

See Also:
Constant Field Values
Constructor Detail

Showbox

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

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

enableLogging

public void enableLogging(java.util.logging.Logger theLogger)
Description copied from interface: LogEnabled
Setter for the logger.

Specified by:
enableLogging in interface LogEnabled
Parameters:
theLogger - the logger to use
See Also:
LogEnabled.enableLogging( java.util.logging.Logger)

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)