org.extex.interpreter.context
Interface ContextExtension

All Superinterfaces:

java.io.Serializable

All Known Implementing Classes:

ContextExtensionImpl

public interface ContextExtension
extends java.io.Serializable

This interface describes the container for all data of an interpreter context for the ExTeX-functions.

Version:

$Revision: 1$

Author:

Michael Niedermair

Method Summary

Bool	getBool(java.lang.String name) Getter for the bool register.
HashToks	getHashToks(java.lang.String name) Getter for the hashtoks register.
Pair	getPair(java.lang.String name) Getter for the pair register.
Real	getReal(java.lang.String name) Getter for the real register.
Transform	getTransform(java.lang.String name) Getter for the transform register.
void	setBool(java.lang.String name, Bool value) Setter for the bool register in the current group.
void	setBool(java.lang.String name, Bool value, boolean global) Setter for the bool register in all requested groups.
void	setHashToks(java.lang.String name, HashToks value) Setter for the hashtoks register in the current group.
void	setHashToks(java.lang.String name, HashToks value, boolean global) Setter for the hashtoks register in all requested groups.
void	setPair(java.lang.String name, Pair value) Setter for the pair register in the current group.
void	setPair(java.lang.String name, Pair value, boolean global) Setter for the pair register in all requested groups.
void	setReal(java.lang.String name, Real value) Setter for the real register in the current group.
void	setReal(java.lang.String name, Real real, boolean global) Setter for the real register in all requested groups.
void	setTransform(java.lang.String name, Transform value) Setter for the transform register in the current group.
void	setTransform(java.lang.String name, Transform value, boolean global) Setter for the transform register in all requested groups.

Method Detail

setReal

void setReal(java.lang.String name,
             Real value)

Setter for the real register in the current group. Real registers are named, either with a number or an arbitrary string.

Parameters:

name - the name or the number of the register

value - the new value of the register

setReal

void setReal(java.lang.String name,
             Real real,
             boolean global)

Setter for the real register in all requested groups. Real registers are named, either with a number or an arbitrary string.

Parameters:

name - the name or the number of the register

real - the new value of the register

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

getReal

Real getReal(java.lang.String name)

Getter for the real register. Real registers are named, either with a number or an arbitrary string.

Parameters:

name - the name or number of the real register

Returns:

the real register or null if it is not defined

setBool

void setBool(java.lang.String name,
             Bool value)

Setter for the bool register in the current group. Bool registers are named, either with a number or an arbitrary string.

Parameters:

name - the name or the number of the register

value - the new value of the register

setBool

void setBool(java.lang.String name,
             Bool value,
             boolean global)

Setter for the bool register in all requested groups. Bool registers are named, either with a number or an arbitrary string.

Parameters:

name - the name or the number of the register

value - the new value of the register

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

getBool

Bool getBool(java.lang.String name)

Getter for the bool register. Bool registers are named, either with a number or an arbitrary string.

Parameters:

name - the name or number of the register

Returns:

the bool register or null if it is not defined

setPair

void setPair(java.lang.String name,
             Pair value)

Setter for the pair register in the current group. Pair registers are named, either with a number or an arbitrary string.

Parameters:

name - the name or the number of the register

value - the new value of the register

setPair

void setPair(java.lang.String name,
             Pair value,
             boolean global)

Setter for the pair register in all requested groups. Pair registers are named, either with a number or an arbitrary string.

Parameters:

name - the name or the number of the register

value - the new value of the register

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

getPair

Pair getPair(java.lang.String name)

Getter for the pair register. Pair registers are named, either with a number or an arbitrary string.

Parameters:

name - the name or number of the register

Returns:

the bool register or null if it is not defined

setTransform

void setTransform(java.lang.String name,
                  Transform value)

Setter for the transform register in the current group. Transform registers are named, either with a number or an arbitrary string.

Parameters:

name - the name or the number of the register

value - the new value of the register

setTransform

void setTransform(java.lang.String name,
                  Transform value,
                  boolean global)

Setter for the transform register in all requested groups. Transform registers are named, either with a number or an arbitrary string.

Parameters:

name - the name or the number of the register

value - the new value of the register

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

getTransform

Transform getTransform(java.lang.String name)

Getter for the transform register. Transform registers are named, either with a number or an arbitrary string.

Parameters:

name - the name or number of the register

Returns:

the bool register or null if it is not defined

setHashToks

void setHashToks(java.lang.String name,
                 HashToks value)

Setter for the hashtoks register in the current group. Hashtoks registers are named, either with a number or an arbitrary string.

Parameters:

name - the name or the number of the register

value - the new value of the register

setHashToks

void setHashToks(java.lang.String name,
                 HashToks value,
                 boolean global)

Setter for the hashtoks register in all requested groups. Transform registers are named, either with a number or an arbitrary string.

Parameters:

name - the name or the number of the register

value - the new value of the register

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

getHashToks

HashToks getHashToks(java.lang.String name)

Getter for the hashtoks register. Transform registers are named, either with a number or an arbitrary string.

Parameters:

name - the name or number of the register

Returns:

the bool register or null if it is not defined