org.extex.unit.tex.register.skip
Class SkipParameter

java.lang.Object
  extended by org.extex.interpreter.type.AbstractCode
      extended by org.extex.interpreter.type.AbstractAssignment
          extended by org.extex.unit.tex.register.skip.AbstractSkip
              extended by org.extex.unit.tex.register.skip.SkipPrimitive
                  extended by org.extex.unit.tex.register.skip.SkipParameter
All Implemented Interfaces:
java.io.Serializable, GlueConvertible, Code, Advanceable, Divideable, Multiplyable, Theable

public class SkipParameter
extends SkipPrimitive

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

All features are inherited from SkipParameter. Just the key has to be provided under which this Glue has to be stored. This key is constructed from the name, a hash mark and the running number.

Example

 \skip12=345pt plus 12em
 

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

Field Summary
protected static long serialVersionUID
          The constant serialVersionUID contains the id for serialization.
 
Constructor Summary
SkipParameter(CodeToken token)
          Creates a new object.
SkipParameter(CodeToken token, java.lang.String key)
          Creates a new object.
 
Method Summary
protected  java.lang.String getKey(Context context, TokenSource source, Typesetter typesetter)
          Return the key (the name of the primitive) for the numbered skip register.
 
Methods inherited from class org.extex.unit.tex.register.skip.SkipPrimitive
advance, assign, convertGlue, divide, 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

SkipParameter

public SkipParameter(CodeToken token)
Creates a new object.

Parameters:
token - the initial token for the primitive

SkipParameter

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

Parameters:
token - the initial token for the primitive
key - the reference key
Method Detail

getKey

protected java.lang.String getKey(Context context,
                                  TokenSource source,
                                  Typesetter typesetter)
                           throws TypesetterException
Return the key (the name of the primitive) for the numbered skip register.

Overrides:
getKey in class AbstractSkip
Parameters:
context - the interpreter context to use
source - the source for new tokens
typesetter - the typesetter
Returns:
the key for the current register
Throws:
TypesetterException - in case of an error in the typesetter
See Also:
AbstractSkip.getKey( org.extex.interpreter.context.Context, org.extex.interpreter.TokenSource, org.extex.typesetter.Typesetter)