Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.extex.unit.etex.register.skip
Class Mutoglue

java.lang.Object
  extended by org.extex.interpreter.type.AbstractCode
      extended by org.extex.unit.etex.register.skip.Mutoglue
All Implemented Interfaces:
java.io.Serializable, GlueConvertible, Code
public class Mutoglue
extends AbstractCode
implements GlueConvertible

This class provides an implementation for the primitive \mutoglue.

The Primitive \mutoglue

The primitive \mutoglue converts a muglue specification to a glue specification. For this conversion 1mu=1pt is assumed. This primitive can be used wherever a glue is expected.

Syntax

The formal description of this primitive is the following: 
    ⟨mutoglue⟩
      → \mutoglue ⟨muglue⟩

Examples

    \skip0=\mutoglue1mu  
    \skip0=\glueexpr\mutoglue1mu\relax

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
Mutoglue(CodeToken token)
          Creates a new object.
 
Method Summary
 Glue convertGlue(Context context, TokenSource source, Typesetter typesetter)
          This method converts a register into a glue value.
 
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

Mutoglue

public Mutoglue(CodeToken token)
Creates a new object.

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

convertGlue

public Glue convertGlue(Context context,
                        TokenSource source,
                        Typesetter typesetter)
                 throws HelpingException,
                        TypesetterException
This method converts a register into a glue value. 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:
convertGlue in interface GlueConvertible
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:
GlueConvertible.convertGlue( org.extex.interpreter.context.Context, org.extex.interpreter.TokenSource, org.extex.typesetter.Typesetter)
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
 PREV CLASS   NEXT CLASS FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD