org.extex.unit.tex.info
Class Showbox

java.lang.Object
  org.extex.interpreter.type.AbstractCode
      org.extex.unit.tex.info.Showbox

All Implemented Interfaces:

java.io.Serializable, LogEnabled, Code

public class Showbox
extends AbstractCode
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: 4732 $

Author:

Gerd Neugebauer

See Also:

Serialized Form

Field Summary

protected static long

serialVersionUID The constant serialVersionUID contains the id for serialization.

Constructor Summary

Showbox(CodeToken token)
Creates a new object.

Method Summary

void	enableLogging(java.util.logging.Logger log) Setter for the logger.
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.

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

Showbox

public Showbox(CodeToken token)

Creates a new object.

Parameters:

token - the initial token for the primitive

Method Detail

enableLogging

public void enableLogging(java.util.logging.Logger log)

Setter for the logger.

Specified by:

enableLogging in interface LogEnabled

Parameters:

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