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

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

All Implemented Interfaces:

java.io.Serializable, Code, ExpandableCode, TokensConvertible

Direct Known Subclasses:

Topmark

public class Topmarks
extends AbstractMarksCode

This class provides an implementation for the primitive \topmarks.

The Primitive \topmarks

The primitive \topmarks provides access to the topmost mark of the given class 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 of the class is available yet.

The primitive \topmark is an abbreviation for \topmarks0.

The class of the top mark is determined when the \marks primitive is used to insert a mark into the current list. In TeX the class used to be a number in the range 0–255; the limit has been raised in eTeX to 32767 and in ExTeX to allow any number or tokens value.

Syntax

The formal description of this primitive is the following:

    ⟨topmarks⟩
      → \topmarks ⟨mark name⟩  

Examples

    \topmarks42  

    \topmarks{abc}  

    \topmarks\count0  

    \toks0=\topmark3  

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

Topmarks(CodeToken token)
Creates a new object.

Method Summary

protected Tokens

getValue(Context context, java.lang.String key) Get the value for this mark.

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

convertTokens, execute, expand, getKey

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

Topmarks

public Topmarks(CodeToken token)

Creates a new object.

Parameters:

token - the initial token for the primitive

Method Detail

getValue

protected Tokens getValue(Context context,
                          java.lang.String key)

Get the value for this mark.

Specified by:

getValue in class AbstractMarksCode

Parameters:

context - the interpreter context

key - the key

Returns:

the value

See Also:

AbstractMarksCode.getValue( org.extex.interpreter.context.Context, java.lang.String)