org.extex.interpreter.context.impl.extension
Interface GroupExtension

All Superinterfaces:

Group, java.io.Serializable, Tokenizer

All Known Implementing Classes:

GroupExtensionImpl

public interface GroupExtension
extends Group, Tokenizer, java.io.Serializable

This is the implementation of a group object with ExTeX-functions.

Version:

$Revision: 6265 $

Author:

Michael Niedermair

Method Summary

Bool	getBool(java.lang.String name) Getter for the named bool register in the current group.
HashToks	getHashToks(java.lang.String name) Getter for the named hash-toks register in the current group.
Pair	getPair(java.lang.String name) Getter for the named pair register in the current group.
Real	getReal(java.lang.String name) Getter for the named real register in the current group.
Transform	getTransform(java.lang.String name) Getter for the named transform register in the current group.
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 a bool register in the requested groups.
void	setHashToks(java.lang.String name, HashToks value) Setter for the hash-toks register in the current group.
void	setHashToks(java.lang.String name, HashToks value, boolean global) Setter for a hash-toks register in the 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 a pair register in the 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 value, boolean global) Setter for a real register in the 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 a transform register in the requested groups.

Methods inherited from interface org.extex.interpreter.max.context.Group

afterGroup, afterGroup, get, getAfterGroup, getBox, getCatcode, getCode, getCount, getDelcode, getDimen, getFont, getIf, getInFile, getLccode, getLevel, getLocator, getMathcode, getMuskip, getNamespace, getNext, getOutFile, getSfcode, getSkip, getStandardTokenStream, getStart, getToks, getToksOrNull, getType, getTypesettingContext, getUccode, runAfterGroup, set, setBox, setCatcode, setCode, setCount, setDelcode, setDimen, setFont, setIf, setInFile, setLccode, setLocator, setMathcode, setMuskip, setNamespace, setOutFile, setSfcode, setSkip, setStandardTokenStream, setStart, setToks, setType, setTypesettingContext, setUccode

Method Detail

setReal

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

Setter for the real register in the current group.

Parameters:

name - the name of the register

value - the value of the register

setReal

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

Setter for a real register in the requested groups.

Parameters:

name - the name of the real register

value - the value of the real 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 named real register in the current group. The name can either be a string representing a number or an arbitrary string. In the first case the behavior of the numbered real registers is emulated. The other case can be used to store special real values. As a default value 0 is returned.

Parameters:

name - the name of the real register

Returns:

the value of the real register or its default

setBool

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

Setter for the bool register in the current group.

Parameters:

name - the name of the register

value - the value of the register

setBool

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

Setter for a bool register in the requested groups.

Parameters:

name - the name of the register

value - the 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 named bool register in the current group. The name can either be a string representing a number or an arbitrary string. In the first case the behavior of the numbered real registers is emulated. The other case can be used to store special real values. As a default value null is returned.

Parameters:

name - the name of the register

Returns:

the value of the register or its default

setPair

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

Setter for the pair register in the current group.

Parameters:

name - the name of the register

value - the value of the register

setPair

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

Setter for a pair register in the requested groups.

Parameters:

name - the name of the register

value - the 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 named pair register in the current group. The name can either be a string representing a number or an arbitrary string. In the first case the behavior of the numbered real registers is emulated. The other case can be used to store special real values. As a default value null is returned.

Parameters:

name - the name of the register

Returns:

the value of the register or its default

setTransform

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

Setter for the transform register in the current group.

Parameters:

name - the name of the register

value - the value of the register

setTransform

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

Setter for a transform register in the requested groups.

Parameters:

name - the name of the register

value - the 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 named transform register in the current group. The name can either be a string representing a number or an arbitrary string. In the first case the behavior of the numbered real registers is emulated. The other case can be used to store special real values. As a default value null is returned.

Parameters:

name - the name of the register

Returns:

the value of the register or its default

setHashToks

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

Setter for the hash-toks register in the current group.

Parameters:

name - the name of the register

value - the value of the register

setHashToks

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

Setter for a hash-toks register in the requested groups.

Parameters:

name - the name of the register

value - the 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 named hash-toks register in the current group. The name can either be a string representing a number or an arbitrary string. In the first case the behavior of the numbered hash-toks registers is emulated. The other case can be used to store special hash-toks values. As a default value null is returned.

Parameters:

name - the name of the register

Returns:

the value of the register or its default