org.extex.interpreter.context
Interface ContextMark

All Known Subinterfaces:

Context, ContextInternals

All Known Implementing Classes:

ContextExtensionImpl, ContextImpl

public interface ContextMark

This interface describes the container for marks of an interpreter context.

Version:

$Revision$

Author:

Gerd Neugebauer

Method Summary

void	clearSplitMarks() This method clears all split marks.
Tokens	getBottomMark(java.lang.Object name) Getter for the bottom mark.
Tokens	getFirstMark(java.lang.Object name) Getter for the first mark.
Tokens	getSplitBottomMark(java.lang.Object name) Getter for the split bottom mark.
Tokens	getSplitFirstMark(java.lang.Object name) Getter for the split first mark.
Tokens	getTopMark(java.lang.Object name) Getter for the top mark.
void	setMark(java.lang.Object name, Tokens mark) Setter for a mark.
void	setSplitMark(java.lang.Object name, Tokens mark) Setter for a split mark.
void	startMarks() This method indicated that a new page is started.

Method Detail

clearSplitMarks

void clearSplitMarks()

This method clears all split marks.

getBottomMark

Tokens getBottomMark(java.lang.Object name)

Getter for the bottom mark.

Parameters:

name - the name of the mark

Returns:

the bottom mark

getFirstMark

Tokens getFirstMark(java.lang.Object name)

Getter for the first mark.

Parameters:

name - the name of the mark

Returns:

the first mark

getSplitBottomMark

Tokens getSplitBottomMark(java.lang.Object name)

Getter for the split bottom mark.

Parameters:

name - the name of the mark

Returns:

the split bottom mark

getSplitFirstMark

Tokens getSplitFirstMark(java.lang.Object name)

Getter for the split first mark.

Parameters:

name - the name of the mark

Returns:

the split first mark

getTopMark

Tokens getTopMark(java.lang.Object name)

Getter for the top mark.

Parameters:

name - the name of the mark

Returns:

the top mark

setMark

void setMark(java.lang.Object name,
             Tokens mark)

Setter for a mark. The information for first mark and top mark are updated if necessary.

Parameters:

name - the name of the mark

mark - the vale of the mark

setSplitMark

void setSplitMark(java.lang.Object name,
                  Tokens mark)

Setter for a split mark. The information for first mark and top mark are updated is necessary.

Parameters:

name - the name of the mark

mark - the vale of the mark

startMarks

void startMarks()

This method indicated that a new page is started. The values of first mark, bottom mark, and top mark should be updated properly.