de.dante.extex.interpreter.primitives.register.skip
Class Gluestretchorder

java.lang.Object
  de.dante.extex.interpreter.type.AbstractCode
      de.dante.extex.interpreter.primitives.register.skip.Gluestretchorder

All Implemented Interfaces:

Code, CountConvertible, DimenConvertible, Localizable, java.io.Serializable, Theable

public class Gluestretchorder

extends AbstractCode

implements CountConvertible, DimenConvertible, Theable

This class provides an implementation for the primitive \gluestretchorder.

The Primitive \gluestretchorder

The primitive \gluestretchorder determines the order of the glue stretch component of the following glue specification. A fixed, non-stretchable glue returns the value 0. Glue with the order fil gives 1, fill gives 2, and filll gives 3.

Note that the glue specification of 1 fi returns also 1. This is due to the compatibility with eTeX which does not have this unit. This unit has been introduced by Omega.

Syntax

    ⟨gluestretchorder⟩
      → \gluestretchorder ⟨glue⟩ 

Examples

   \gluestretchorder\skip1  

Version:

$Revision: 1.10 $

Author:

Gerd Neugebauer

See Also:

Serialized Form

serialVersionUID

protected static final long serialVersionUID

The constant serialVersionUID contains the id for serialization.

See Also:

Constant Field Values

Gluestretchorder

public Gluestretchorder(java.lang.String name)

Creates a new object.

Parameters:

name - the name for debugging

convertCount

public long convertCount(Context context,
                         TokenSource source,
                         Typesetter typesetter)
                  throws InterpreterException

Description copied from interface: CountConvertible

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:

InterpreterException - in case of an error

See Also:

CountConvertible.convertCount( de.dante.extex.interpreter.context.Context, de.dante.extex.interpreter.TokenSource, de.dante.extex.typesetter.Typesetter)

convertDimen

public long convertDimen(Context context,
                         TokenSource source,
                         Typesetter typesetter)
                  throws InterpreterException

Description copied from interface: DimenConvertible

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:

InterpreterException - in case of an error

See Also:

DimenConvertible.convertDimen( de.dante.extex.interpreter.context.Context, de.dante.extex.interpreter.TokenSource, de.dante.extex.typesetter.Typesetter)

the

public Tokens the(Context context,
                  TokenSource source,
                  Typesetter typesetter)
           throws InterpreterException

Description copied from interface: Theable

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:

InterpreterException - in case of an error

See Also:

Theable.the( de.dante.extex.interpreter.context.Context, de.dante.extex.interpreter.TokenSource, de.dante.extex.typesetter.Typesetter)