de.dante.extex.interpreter.primitives.typesetter.mark
Class Botmarks

java.lang.Object
  extended byde.dante.extex.interpreter.type.AbstractCode
      extended byde.dante.extex.interpreter.primitives.typesetter.mark.AbstractMarksCode
          extended byde.dante.extex.interpreter.primitives.typesetter.mark.Botmarks
All Implemented Interfaces:
Code, ExpandableCode, Localizable, java.io.Serializable, 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: 1.6 $
Author:
Gerd Neugebauer
See Also:
Serialized Form

Field Summary
protected static long serialVersionUID
          The constant serialVersionUID contains the id for serialization.
 
Constructor Summary
Botmarks(java.lang.String name)
          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 de.dante.extex.interpreter.primitives.typesetter.mark.AbstractMarksCode
convertTokens, execute, expand, getKey
 
Methods inherited from class de.dante.extex.interpreter.type.AbstractCode
enableLocalization, getLocalizer, getName, isIf, isOuter, printable, printableControlSequence, readResolve, setName, toString
 
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(java.lang.String name)
Creates a new object.

Parameters:
name - the name for debugging
Method Detail

getValue

protected Tokens getValue(Context context,
                          java.lang.String key)
                   throws InterpreterException
Description copied from class: AbstractMarksCode
Get the value for this mark.

Specified by:
getValue in class AbstractMarksCode
Parameters:
context - the interpreter context
key - the key
Returns:
the value
Throws:
InterpreterException - in case of an exception
See Also:
AbstractMarksCode.getValue( de.dante.extex.interpreter.context.Context, java.lang.String)