BoxParameter

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 BoxParameter

java.lang.Object
  de.dante.extex.interpreter.type.AbstractCode
      de.dante.extex.interpreter.primitives.register.box.BoxParameter

All Implemented Interfaces:: Code, Localizable, java.io.Serializable

public class BoxParameter
extends AbstractCode
implements Code, java.io.Serializable

This class provides a Box parameter implementation.

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

Field Summary
`protected static long`	`serialVersionUID` The constant `serialVersionUID` contains the id for serialization.

Constructor Summary
`BoxParameter(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.
`protected java.lang.String`	`getKey(TokenSource source, Context context)` Return the key (the name of the primitive) for the register.

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

BoxParameter

public BoxParameter(java.lang.String name)

Creates a new object.
Parameters:: name - the name of the box

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)

getKey

protected java.lang.String getKey(TokenSource source,
                                  Context context)
                           throws InterpreterException

Return the key (the name of the primitive) for the register.

Parameters:: source - the source for new tokens – if required; context - the interpreter context to use
Returns:: the key for the box register
Throws:: InterpreterException - in case oif an error