org.extex.typesetter
Interface PageContext

All Known Subinterfaces:

Context, ContextInternals

All Known Implementing Classes:

ContextExtensionImpl, ContextImpl

public interface PageContext

This interface describes the possibilities of the typesetter to access its options.

Version:

$Revision: 6367 $

Author:

Gerd Neugebauer

Method Summary

FixedCount	getCountOption(java.lang.String name) Getter for a count register.
FixedDimen	getDimenOption(java.lang.String name) Getter for a dimen register.
Font	getFont(java.lang.String name) Getter for a current font register.
FixedGlue	getGlueOption(java.lang.String name) Getter for a glue register.
UnicodeChar	getLccode(UnicodeChar uc) Getter for the lccode mapping of upper case characters to their lower case equivalent.
Muskip	getMuskip(java.lang.String name) Getter for a muskip register.
java.lang.String	getNamespace() Getter for the current name space.
OutFile	getOutFile(java.lang.String key) Getter for an output file descriptor.
ParagraphShape	getParshape() Getter for the paragraph shape.
TokenFactory	getTokenFactory() Getter for the token factory.
TypesettingContext	getTypesettingContext() Getter for the typesetting context.
TypesettingContextFactory	getTypesettingContextFactory() Getter for the typesetting context factory.
void	setCountOption(java.lang.String name, long value) Setter for a count register.
void	setMark(java.lang.Object index, Tokens mark) Setter for a mark.
void	setOutFile(java.lang.String key, OutFile file, boolean global) Setter for a outfile descriptor.
void	setParshape(ParagraphShape shape) Setter for the paragraph shape.

Method Detail

getCountOption

FixedCount getCountOption(java.lang.String name)

Getter for a count register.

Parameters:

name - the name of the register

Returns:

the content of the count register

getDimenOption

FixedDimen getDimenOption(java.lang.String name)

Getter for a dimen register.

Parameters:

name - the name of the register

Returns:

the content of the dimen register

getFont

Font getFont(java.lang.String name)

Getter for a current font register.

Parameters:

name - the name or the number of the register

Returns:

the named font register or null if none is set

getGlueOption

FixedGlue getGlueOption(java.lang.String name)

Getter for a glue register.

Parameters:

name - the name of the register

Returns:

the content of the glue register

getLccode

UnicodeChar getLccode(UnicodeChar uc)

Getter for the lccode mapping of upper case characters to their lower case equivalent.

Parameters:

uc - the upper case character

Returns:

the lower case equivalent or null if none exists

getMuskip

Muskip getMuskip(java.lang.String name)

Getter for a muskip register.

Parameters:

name - the name of the register

Returns:

the muskip register value

getNamespace

java.lang.String getNamespace()

Getter for the current name space.

Returns:

the current name space

getOutFile

OutFile getOutFile(java.lang.String key)

Getter for an output file descriptor.

Parameters:

key - the name or the number of the file register

Returns:

the output file descriptor

getParshape

ParagraphShape getParshape()

Getter for the paragraph shape.

Returns:

the paragraph shape or null if no special shape is present

getTokenFactory

TokenFactory getTokenFactory()

Getter for the token factory. The token factory can be used to get new tokens of some kind.

Returns:

the token factory

getTypesettingContext

TypesettingContext getTypesettingContext()

Getter for the typesetting context.

Returns:

the typesetting context

getTypesettingContextFactory

TypesettingContextFactory getTypesettingContextFactory()

Getter for the typesetting context factory.

Returns:

the typesetting context factory

setCountOption

void setCountOption(java.lang.String name,
                    long value)
                    throws GeneralException

Setter for a count register.

Parameters:

name - the name of the register

value - the value

Throws:

GeneralException - in case of an error

setMark

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

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

Parameters:

index - the name of the mark

mark - the vale of the mark

setOutFile

void setOutFile(java.lang.String key,
                OutFile file,
                boolean global)

Setter for a outfile descriptor.

Parameters:

key - the name or the number of the file register

file - the descriptor of the output file

global - the indicator for the scope; true means all groups; otherwise the current group is affected only

setParshape

void setParshape(ParagraphShape shape)

Setter for the paragraph shape.

Parameters:

shape - the new paragraph shape