org.extex.unit.tex.register.dimen
Class DimenParameter

java.lang.Object
  org.extex.interpreter.type.AbstractCode
      org.extex.interpreter.type.AbstractAssignment
          org.extex.unit.tex.register.dimen.AbstractDimen
              org.extex.unit.tex.register.dimen.DimenPrimitive
                  org.extex.unit.tex.register.dimen.DimenParameter

All Implemented Interfaces:

java.io.Serializable, Configurable, CountConvertible, DimenConvertible, Code, Advanceable, Divideable, Multiplyable, ExpandableCode, InitializableCode, Theable

public class DimenParameter
extends DimenPrimitive
implements InitializableCode, Configurable

This class provides an implementation for the primitive \dimen. It sets the named length register to the value given, and as a side effect all prefixes are zeroed.

Example

 \day=345
 

Version:

$Revision: 4770 $

Author:

Gerd Neugebauer

See Also:

Serialized Form

Field Summary

protected static long

serialVersionUID The constant serialVersionUID contains the id for serialization.

Constructor Summary

DimenParameter(CodeToken token)
Creates a new object.

DimenParameter(CodeToken token, java.lang.String key)
Creates a new object.

Method Summary

void	configure(Configuration config) Configure an object according to a given Configuration.
protected java.lang.String	getKey(Context context, TokenSource source, Typesetter typesetter) Return the key (the name of the primitive) for the register.
void	init(Context context, TokenSource source, Typesetter typesetter) Initialize the Code with some value coming from a Token source.

Methods inherited from class org.extex.unit.tex.register.dimen.DimenPrimitive

advance, assign, convertCount, convertDimen, divide, expand, multiply, the

Methods inherited from class org.extex.interpreter.type.AbstractAssignment

execute

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

DimenParameter

public DimenParameter(CodeToken token)

Creates a new object.

Parameters:

token - the initial token for the primitive

DimenParameter

public DimenParameter(CodeToken token,
                      java.lang.String key)

Creates a new object.

Parameters:

token - the initial token for the primitive

key - the key

Method Detail

configure

public void configure(Configuration config)
               throws ConfigurationException

Configure an object according to a given Configuration.

Specified by:

configure in interface Configurable

Parameters:

config - the configuration object to consider

Throws:

ConfigurationException - in case that something went wrong

See Also:

Configurable.configure( org.extex.framework.configuration.Configuration)

getKey

protected java.lang.String getKey(Context context,
                                  TokenSource source,
                                  Typesetter typesetter)

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

Overrides:

getKey in class AbstractDimen

Parameters:

context - the interpreter context to use

source - the source for new tokens

typesetter - the typesetter

Returns:

the key for the current register

See Also:

AbstractDimen.getKey( org.extex.interpreter.context.Context, org.extex.interpreter.TokenSource, org.extex.typesetter.Typesetter)

init

public void init(Context context,
                 TokenSource source,
                 Typesetter typesetter)
          throws HelpingException,
                 TypesetterException

Initialize the Code with some value coming from a Token source.

Specified by:

init in interface InitializableCode

Parameters:

context - the interpreter context

source - the source of information for the initialization

typesetter - the typesetter

Throws:

HelpingException - in case of an error

TypesetterException - in case of an error in the typesetter

See Also:

InitializableCode.init( org.extex.interpreter.context.Context, TokenSource, Typesetter)