org.extex.unit.etex.typesetter.paragraph
Class Parshapelength

java.lang.Object
  extended by org.extex.interpreter.type.AbstractCode
      extended by org.extex.unit.etex.typesetter.paragraph.Parshapelength
All Implemented Interfaces:
java.io.Serializable, CountConvertible, DimenConvertible, Code, Theable

public class Parshapelength
extends AbstractCode
implements CountConvertible, DimenConvertible, Theable

This class provides an implementation for the primitive \relax.

The Primitive \parshapelength

The primitive \parshapelength gives access to the settings for the current paragraph shape. The primitive takes a number as parameter. If this number is positive then the length of the line denoted by the parameter is returned. The line numbering starts with 1. If the argument is less than 1 then 0 is returned.

Syntax

The formal description of this primitive is the following:
    ⟨parshapelength⟩
        → \parshapelength ⟨8-bit number⟩ 

Examples

    \dimen2=\parshapelength 3  
    \dimen2=\parshapelength -3  

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
Parshapelength(CodeToken token)
          Creates a new object.
 
Method Summary
 long convertCount(Context context, TokenSource source, Typesetter typesetter)
          This method converts a register into a count.
 long convertDimen(Context context, TokenSource source, Typesetter typesetter)
          This method converts a register into a dimen.
 Tokens the(Context context, TokenSource source, Typesetter typesetter)
          This method is the getter for the description of the primitive.
 
Methods inherited from class org.extex.interpreter.type.AbstractCode
execute, 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

Parshapelength

public Parshapelength(CodeToken token)
Creates a new object.

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

convertCount

public long convertCount(Context context,
                         TokenSource source,
                         Typesetter typesetter)
                  throws HelpingException,
                         TypesetterException
This method converts a register into a count. It might be necessary to read further tokens to determine which value to use. For instance an additional register number might be required. In this case the additional arguments Context and TokenSource can be used.

Specified by:
convertCount in interface CountConvertible
Parameters:
context - the interpreter context
source - the source for new tokens
typesetter - the typesetter to use for conversion
Returns:
the converted value
Throws:
HelpingException - in case of an error
TypesetterException - in case of an error in the typesetter
See Also:
CountConvertible.convertCount( org.extex.interpreter.context.Context, org.extex.interpreter.TokenSource, org.extex.typesetter.Typesetter)

convertDimen

public long convertDimen(Context context,
                         TokenSource source,
                         Typesetter typesetter)
                  throws HelpingException,
                         TypesetterException
This method converts a register into a dimen. It might be necessary to read further tokens to determine which value to use. For instance an additional register number might be required. In this case the additional arguments Context and TokenSource can be used. The return value is the length in scaled points.

Specified by:
convertDimen in interface DimenConvertible
Parameters:
context - the interpreter context
source - the source for new tokens
typesetter - the typesetter to use for conversion
Returns:
the converted value in sp
Throws:
HelpingException - in case of an error
TypesetterException - in case of an error in the typesetter
See Also:
DimenConvertible.convertDimen( org.extex.interpreter.context.Context, org.extex.interpreter.TokenSource, org.extex.typesetter.Typesetter)

the

public Tokens the(Context context,
                  TokenSource source,
                  Typesetter typesetter)
           throws HelpingException,
                  TypesetterException
This method is the getter for the description of the primitive.

Specified by:
the in interface Theable
Parameters:
context - the interpreter context
source - the source for further tokens to qualify the request
typesetter - the typesetter to use
Returns:
the description of the primitive as list of Tokens
Throws:
HelpingException - in case of an error
TypesetterException - in case of an error
See Also:
Theable.the( org.extex.interpreter.context.Context, org.extex.interpreter.TokenSource, Typesetter)