org.extex.unit.tex.typesetter.spacing
Class Vskip

java.lang.Object
  org.extex.interpreter.type.AbstractCode
      org.extex.unit.tex.typesetter.AbstractVerticalCode
          org.extex.unit.tex.typesetter.spacing.Vskip

All Implemented Interfaces:

java.io.Serializable, Code, VerticalSkip

public class Vskip
extends AbstractVerticalCode
implements VerticalSkip

This class provides an implementation for the primitive \vskip.

The Primitive \vskip

TODO missing documentation

Syntax

The formal description of this primitive is the following:

     ⟨vskip⟩
         → \vskip ⟨Glue⟩
 

Examples

     \vskip 1em plus 1pt minus 1pt
 

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

Vskip(CodeToken token)
Creates a new object.

Method Summary

void	execute(Flags prefix, Context context, TokenSource source, Typesetter typesetter) This method takes the first token and executes it. The result is placed on the stack. This operation might have side effects. To execute a token it might be necessary to consume further tokens.
FixedGlue	getGlue(Context context, TokenSource source, Typesetter typesetter) This method acquires a vertical glue.

Methods inherited from class org.extex.unit.tex.typesetter.AbstractVerticalCode

ensureVerticalMode

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

Vskip

public Vskip(CodeToken token)

Creates a new object.

Parameters:

token - the initial token for the primitive

Method Detail

execute

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

This method takes the first token and executes it. The result is placed on the stack. This operation might have side effects. To execute a token it might be necessary to consume further tokens.

Specified by:

execute in interface Code

Overrides:

execute in class AbstractCode

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:

AbstractCode.execute( org.extex.interpreter.Flags, org.extex.interpreter.context.Context, org.extex.interpreter.TokenSource, org.extex.typesetter.Typesetter)

getGlue

public FixedGlue getGlue(Context context,
                         TokenSource source,
                         Typesetter typesetter)
                  throws HelpingException,
                         TypesetterException

This method acquires a vertical glue.

Specified by:

getGlue in interface VerticalSkip

Parameters:

context - the interpreter context

source - the source for new tokens

typesetter - the typesetter

Returns:

the amount of vertical skip

Throws:

HelpingException - in case of an error

TypesetterException - in case of an error in the typesetter

See Also:

VerticalSkip.getGlue( org.extex.interpreter.context.Context, org.extex.interpreter.TokenSource, org.extex.typesetter.Typesetter)