org.extex.unit.tex.font
Class Fontdimen

java.lang.Object
  org.extex.interpreter.type.AbstractCode
      org.extex.interpreter.type.AbstractAssignment
          org.extex.unit.tex.font.Fontdimen

All Implemented Interfaces:

java.io.Serializable, Code, ExpandableCode, Theable

public class Fontdimen
extends AbstractAssignment
implements ExpandableCode, Theable

This class provides an implementation for the primitive \fontdimen.

The Primitive \fontdimen

The primitive \fontdimen can be used to set a font dimension value. Each font has an arbitrary number of dimen values which are addressed by an numerical index in TeX. In ExTeX this has been extended to arbitrary strings.

The primitive expands to the value of the font dimension in a right hand context.

Syntax

The formal description of this primitive is the following:

    ⟨fontdimen⟩
       → \fontdimen ⟨8-bit number⟩ ⟨font⟩ ⟨equals⟩ ⟨dimen⟩   

TODO gene: document Extension

Examples

    \fontdimen13\ff=5pt  

    \the\fontdimen13\ff  

    \the\fontdimen{em}\ff=8pt  

Version:

$Revision:4431 $

Author:

Gerd Neugebauer, Michael Niedermair

See Also:

Serialized Form

Field Summary

protected static long

serialVersionUID The constant serialVersionUID contains the id for serialization.

Constructor Summary

Fontdimen(CodeToken token)
Creates a new object.

Method Summary

void	assign(Flags prefix, Context context, TokenSource source, Typesetter typesetter) The method assign is the core of the functionality of execute().
void	expand(Flags prefix, Context context, TokenSource source, Typesetter typesetter) This method takes the first token and expands it.
protected java.lang.String	getKey(Context context, TokenSource source, Typesetter typesetter) Get the key for the font 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.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

Fontdimen

public Fontdimen(CodeToken token)

Creates a new object.

Parameters:

token - the initial token for the primitive

Method Detail

assign

public void assign(Flags prefix,
                   Context context,
                   TokenSource source,
                   Typesetter typesetter)
            throws HelpingException,
                   TypesetterException

The method assign is the core of the functionality of execute(). This method is preferable to execute() since the execute() method provided in this class takes care of \afterassignment and \globaldefs as well.

Specified by:

assign in class AbstractAssignment

Parameters:

prefix - the prefix controlling the execution

context - the interpreter context

source - the token source

typesetter - the typesetter

Throws:

HelpingException - in case of an error

TypesetterException - in case of an error in the typesetter

See Also:

AbstractAssignment.assign( org.extex.interpreter.Flags, org.extex.interpreter.context.Context, org.extex.interpreter.TokenSource, org.extex.typesetter.Typesetter)

expand

public void expand(Flags prefix,
                   Context context,
                   TokenSource source,
                   Typesetter typesetter)
            throws HelpingException,
                   TypesetterException

Description copied from interface: ExpandableCode

This method takes the first token and expands it. The result is placed on the stack. This means that expandable code does one step of expansion and puts the result on the stack. To expand a token it might be necessary to consume further tokens.

Specified by:

expand in interface ExpandableCode

Parameters:

prefix - the prefix flags controlling the expansion

context - the interpreter context

source - the token source

typesetter - the typesetter

Throws:

HelpingException - in case of an error

TypesetterException - in case of an error in the typesetter

See Also:

ExpandableCode.expand( org.extex.interpreter.Flags, org.extex.interpreter.context.Context, org.extex.interpreter.TokenSource, org.extex.typesetter.Typesetter)

getKey

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

Get the key for the font dimen. According to TeX the key is an arbitrary number. In ExTeX this has been extended to take an expandable sequence of tokens enclosed in braces. The left brace acts as indicator that this extension is used.

Parameters:

context - the interpreter context

source - the source for new tokens

typesetter - the typesetter

Returns:

the key

Throws:

HelpingException - in case of an error

TypesetterException - in case of an error in the typesetter

the

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

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:

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)