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

java.lang.Object
  extended by org.extex.interpreter.type.AbstractCode
      extended by org.extex.unit.tex.typesetter.mark.AbstractMarksCode
          extended by org.extex.unit.tex.typesetter.mark.Firstmarks
              extended by org.extex.unit.tex.typesetter.mark.Firstmark
All Implemented Interfaces:
java.io.Serializable, Code, ExpandableCode, TokensConvertible

public class Firstmark
extends Firstmarks

This class provides an implementation for the primitive \firstmark.

The Primitive \firstmark

The primitive \firstmark expands to the first mark on the current page. 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 \mark for further explanation of marks.

Syntax

The formal description of this primitive is the following:
    ⟨firstmark⟩
      → \firstmark  

Examples

    \firstmark  

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
Firstmark(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.Firstmarks
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

Firstmark

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