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

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

All Implemented Interfaces:

java.io.Serializable, Code, ExpandableCode, TokensConvertible

Direct Known Subclasses:

Botmark

public class Botmarks
extends AbstractMarksCode

This class provides an implementation for the primitive \botmarks.

The Primitive \botmarks

The primitive \botmarks expands to the last mark on the current page of the given class. If no mark has been encountered on the current page then it expands to the last mark on the previous page. If no mark has been placed ever then the primitive expands to the empty token list.

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

Syntax

The formal description of this primitive is the following:

    ⟨botmark⟩
      → \botmarks ⟨mark name⟩  

Examples

    \botmarks42  

    \botmarks\count0  

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

Botmarks(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

Botmarks

public Botmarks(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)