Vss

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

de.dante.extex.interpreter.primitives.typesetter.spacing
Class Vss

java.lang.Object
  de.dante.extex.interpreter.type.AbstractCode
      de.dante.extex.interpreter.primitives.typesetter.AbstractVerticalCode
          de.dante.extex.interpreter.primitives.typesetter.spacing.Vss

All Implemented Interfaces:: Code, Localizable, java.io.Serializable, VerticalSkip

public class Vss
extends AbstractVerticalCode
implements VerticalSkip

This class provides an implementation for the primitive \vss.

The Primitive `\vss`

TODO missing documentation

Syntax

The formal description of this primitive is the following:

    ⟨vss⟩
        → \vss

Examples

    \vss

Version:: $Revision: 1.10 $
Author:: Gerd Neugebauer
See Also:: Serialized Form

Field Summary
`protected static long`	`serialVersionUID` The constant `serialVersionUID` contains the id for serialization.

Constructor Summary
`Vss(java.lang.String name)` 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.
`FixedGlue`	`getGlue(Context context, TokenSource source, Typesetter typesetter)` This method acquires a vertical glue.

Methods inherited from class de.dante.extex.interpreter.primitives.typesetter.AbstractVerticalCode

ensureVerticalMode

Methods inherited from class de.dante.extex.interpreter.type.AbstractCode

enableLocalization, getLocalizer, getName, isIf, isOuter, printable, printableControlSequence, readResolve, setName, toString

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

Vss

public Vss(java.lang.String name)

Creates a new object.
Parameters:: name - the name for debugging

Method Detail

execute

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

Description copied from interface: Code

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

Throws:: InterpreterException
See Also:: Code.execute( de.dante.extex.interpreter.Flags, de.dante.extex.interpreter.context.Context, de.dante.extex.interpreter.TokenSource, de.dante.extex.typesetter.Typesetter)

getGlue

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

Description copied from interface: VerticalSkip

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:: InterpreterException - in case of an error
See Also:: VerticalSkip.getGlue( de.dante.extex.interpreter.context.Context, de.dante.extex.interpreter.TokenSource, de.dante.extex.typesetter.Typesetter)