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

java.lang.Object
  org.extex.interpreter.type.AbstractCode
      org.extex.unit.tex.typesetter.mark.AbstractMarkCode
          org.extex.unit.tex.typesetter.mark.Marks
              org.extex.unit.tex.typesetter.mark.Mark

All Implemented Interfaces:

java.io.Serializable, Code

public class Mark
extends Marks

This class provides an implementation for the primitive \mark.

The Primitive \mark

The primitive \mark places its argument as a mark node on the current node list. The argument is expanded during this operation as in \edef.

The tokens are stored in the current node list. They are not affected by grouping in any way.

Suppose we have several pages. Page 1 contains no mark. Page 2 contains the marks a and b. Page 3 does not contain any marks. Page 4 contains the mark c and page 5 does not contain any marks. The marks and the expansion text of the primitives \topmark, \firstmark, and \botmark are shown in the table below.

	on page 1	on page 2	on page 3	on page 4	on page 5
marks		\mark{a} \mark{b}		\mark{c}
\topmark		a	b	b	c
\firstmark		a	b	c	c
\botmark		b	b	c	c

Syntax

The formal description of this primitive is the following:

    ⟨mark⟩
      → \mark ⟨expanded tokens⟩  

Examples

    \mark{abc}  

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

Mark(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.Marks

execute

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

Mark

public Mark(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 AbstractMarkCode

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)