org.extex.unit.tex.typesetter.mark
Class Topmark

java.lang.Object
  org.extex.interpreter.type.AbstractCode
      org.extex.unit.tex.typesetter.mark.AbstractMarksCode
          org.extex.unit.tex.typesetter.mark.Topmarks
              org.extex.unit.tex.typesetter.mark.Topmark

All Implemented Interfaces:

java.io.Serializable, Code, ExpandableCode, TokensConvertible

public class Topmark
extends Topmarks

This class provides an implementation for the primitive \topmark.

The Primitive \topmark

The primitive \topmark provides access to the topmost mark encountered on the current page – when processing the page in the output routine.

The primitive is a tokens register. It can be used wherever a tokens value is expected. The value is empty when no top mark is available yet.

See the documentation of the primitive \mark for further explanation of marks.

Syntax

The formal description of this primitive is the following:

    ⟨topmark⟩
      → \topmark  

Examples

    \topmark  

    \toks0=\topmark  

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

Topmark(CodeToken token)
Creates a new object.

Method Summary

protected java.lang.String

getKey(Context context, TokenSource source, Typesetter typesetter) Get the key for this mark.

Methods inherited from class org.extex.unit.tex.typesetter.mark.Topmarks

getValue

Methods inherited from class org.extex.unit.tex.typesetter.mark.AbstractMarksCode

convertTokens, execute, expand

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

Topmark

public Topmark(CodeToken token)

Creates a new object.

Parameters:

token - the initial token for the primitive

Method Detail

getKey

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

Get the key for this mark.

Overrides:

getKey in class AbstractMarksCode

Parameters:

context - the interpreter context

source - the source for new tokens

typesetter - the typesetter

Returns:

the key for the mark primitive

See Also:

AbstractMarkCode.getKey( org.extex.interpreter.context.Context, org.extex.interpreter.TokenSource, org.extex.typesetter.Typesetter)