de.dante.extex.interpreter.primitives.typesetter.box
Class Vtop

java.lang.Object
  de.dante.extex.interpreter.type.AbstractCode
      de.dante.extex.interpreter.primitives.typesetter.box.AbstractBoxPrimitive
          de.dante.extex.interpreter.primitives.typesetter.box.Vbox
              de.dante.extex.interpreter.primitives.typesetter.box.Vtop

All Implemented Interfaces:

Boxable, BoxOrRule, Code, Localizable, java.io.Serializable

public class Vtop

extends Vbox

This class provides an implementation for the primitive \vtop.

The Primitive \vtop

TODO missing documentation

The contents of the toks register \everyvbox is inserted at the beginning of the vertical material of the box.

Syntax

    ⟨vtop⟩
      → \vtop ⟨box specification⟩ { ⟨vertical material⟩ }

    ⟨box specification⟩
      →
         | to ⟨rule dimension⟩
         | spread ⟨rule dimension⟩  

Examples

    \vtop{abc}  

    \vtop to 120pt{abc}  

    \vtop spread 12pt{abc}  

Version:

$Revision: 1.13 $

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

Vtop

public Vtop(java.lang.String name)

Creates a new object.

Parameters:

name - the name for tracing and debugging

constructBox

protected Box constructBox(Context context,
                           TokenSource source,
                           Typesetter typesetter,
                           Token startToken)
                    throws InterpreterException

Description copied from class: Vbox

Acquire a Box and adjust its height and depth according to the rules required.

For a \vbox the alignment takes the last box contained and uses its reference point. The depth is preserved and the height is adjusted if required.

Overrides:

constructBox in class Vbox

Parameters:

context - the interpreter context

source - the source for new tokens

typesetter - the typesetter

startToken - the token which started the group

Returns:

the complete Box

Throws:

InterpreterException - in case of an error

See Also:

Vbox.constructBox( de.dante.extex.interpreter.context.Context, de.dante.extex.interpreter.TokenSource, de.dante.extex.typesetter.Typesetter, de.dante.extex.scanner.type.token.Token)