org.extex.unit.tex.typesetter.box
Class Vtop

java.lang.Object
  org.extex.interpreter.type.AbstractCode
      org.extex.unit.tex.typesetter.box.AbstractBoxPrimitive
          org.extex.unit.tex.typesetter.box.Vbox
              org.extex.unit.tex.typesetter.box.Vtop

All Implemented Interfaces:

java.io.Serializable, Boxable, BoxOrRule, Code

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

The formal description of this primitive is the following:

    ⟨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:4431 $

Author:

Gerd Neugebauer

See Also:

Serialized Form

Field Summary

protected static long

serialVersionUID The constant serialVersionUID contains the id for serialization.

Constructor Summary

Vtop(CodeToken token)
Creates a new object.

Method Summary

protected Box

constructBox(Context context, TokenSource source, Typesetter typesetter, Token startToken, Token insert) Acquire a Box and adjust its height and depth according to the rules required.

Methods inherited from class org.extex.unit.tex.typesetter.box.Vbox

acquireBox, getBox

Methods inherited from class org.extex.unit.tex.typesetter.box.AbstractBoxPrimitive

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

Vtop

public Vtop(CodeToken token)

Creates a new object.

Parameters:

token - the initial token for the primitive

Method Detail

constructBox

protected Box constructBox(Context context,
                           TokenSource source,
                           Typesetter typesetter,
                           Token startToken,
                           Token insert)
                    throws HelpingException,
                           TypesetterException

Acquire a Box and adjust its height and depth according to the rules 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

insert - the token to insert at the beginning or null

Returns:

the complete Box

Throws:

HelpingException - in case of an error

TypesetterException - in case of an error in the typesetter

See Also:

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