org.extex.interpreter.context.impl.extension
Class GroupExtensionImpl

java.lang.Object
  org.extex.interpreter.max.context.GroupImpl
      org.extex.interpreter.context.impl.extension.GroupExtensionImpl

All Implemented Interfaces:

java.io.Serializable, GroupExtension, Group, Tokenizer

public class GroupExtensionImpl
extends GroupImpl
implements Tokenizer, Group, GroupExtension, java.io.Serializable

This is a simple implementation for a group with ExTeX-functions.

Version:

$Revision: 6265 $

Author:

Michael Niedermair

See Also:

Serialized Form

Constructor Summary

GroupExtensionImpl(Group next)
Creates a new object.

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 class org.extex.interpreter.max.context.GroupImpl

afterGroup, afterGroup, get, getAfterGroup, getBox, getCatcode, getCode, getCodeForToken, 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, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

Constructor Detail

GroupExtensionImpl

public GroupExtensionImpl(Group next)
                   throws GeneralException

Creates a new object.

Parameters:

next - the next group in the stack. If the value is null then this is the global base

Throws:

GeneralException - if the group is not a groupextension

Method Detail

getReal

public Real getReal(java.lang.String name)

Description copied from interface: GroupExtension

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.

Specified by:

getReal in interface GroupExtension

Parameters:

name - the name of the real register

Returns:

the value of the real register or its default

See Also:

GroupExtension.getReal( java.lang.String)

setReal

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

Description copied from interface: GroupExtension

Setter for a real register in the requested groups.

Specified by:

setReal in interface GroupExtension

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

See Also:

GroupExtension.setReal( java.lang.String, org.extex.interpreter.primitives.register.real.Real, boolean)

setReal

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

Description copied from interface: GroupExtension

Setter for the real register in the current group.

Specified by:

setReal in interface GroupExtension

Parameters:

name - the name of the register

value - the value of the register

See Also:

GroupExtension.setReal( java.lang.String, org.extex.interpreter.primitives.register.real.Real)

getBool

public Bool getBool(java.lang.String name)

Description copied from interface: GroupExtension

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.

Specified by:

getBool in interface GroupExtension

Parameters:

name - the name of the register

Returns:

the value of the register or its default

See Also:

GroupExtension.getBool( java.lang.String)

setBool

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

Description copied from interface: GroupExtension

Setter for a bool register in the requested groups.

Specified by:

setBool in interface GroupExtension

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

See Also:

GroupExtension.setBool( java.lang.String, org.extex.interpreter.primitives.register.bool.Bool, boolean)

setBool

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

Description copied from interface: GroupExtension

Setter for the bool register in the current group.

Specified by:

setBool in interface GroupExtension

Parameters:

name - the name of the register

value - the value of the register

See Also:

GroupExtension.setBool( java.lang.String, org.extex.interpreter.primitives.register.bool.Bool)

getPair

public Pair getPair(java.lang.String name)

Description copied from interface: GroupExtension

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.

Specified by:

getPair in interface GroupExtension

Parameters:

name - the name of the register

Returns:

the value of the register or its default

See Also:

GroupExtension.getPair( java.lang.String)

setPair

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

Description copied from interface: GroupExtension

Setter for a pair register in the requested groups.

Specified by:

setPair in interface GroupExtension

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

See Also:

GroupExtension.setPair( java.lang.String, org.extex.interpreter.primitives.register.pair.Pair, boolean)

setPair

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

Description copied from interface: GroupExtension

Setter for the pair register in the current group.

Specified by:

setPair in interface GroupExtension

Parameters:

name - the name of the register

value - the value of the register

See Also:

GroupExtension.setPair( java.lang.String, org.extex.interpreter.primitives.register.pair.Pair)

getTransform

public Transform getTransform(java.lang.String name)

Description copied from interface: GroupExtension

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.

Specified by:

getTransform in interface GroupExtension

Parameters:

name - the name of the register

Returns:

the value of the register or its default

See Also:

GroupExtension.getTransform( java.lang.String)

setTransform

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

Description copied from interface: GroupExtension

Setter for a transform register in the requested groups.

Specified by:

setTransform in interface GroupExtension

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

See Also:

GroupExtension.setTransform( java.lang.String, org.extex.interpreter.primitives.register.transform.Transform, boolean)

setTransform

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

Description copied from interface: GroupExtension

Setter for the transform register in the current group.

Specified by:

setTransform in interface GroupExtension

Parameters:

name - the name of the register

value - the value of the register

See Also:

GroupExtension.setTransform( java.lang.String, org.extex.interpreter.primitives.register.transform.Transform)

getHashToks

public HashToks getHashToks(java.lang.String name)

Description copied from interface: GroupExtension

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.

Specified by:

getHashToks in interface GroupExtension

Parameters:

name - the name of the register

Returns:

the value of the register or its default

See Also:

GroupExtension.getHashToks( java.lang.String)

setHashToks

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

Description copied from interface: GroupExtension

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

Specified by:

setHashToks in interface GroupExtension

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

See Also:

GroupExtension.setHashToks( java.lang.String, org.extex.interpreter.primitives.register.hash.HashToks, boolean)

setHashToks

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

Description copied from interface: GroupExtension

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

Specified by:

setHashToks in interface GroupExtension

Parameters:

name - the name of the register

value - the value of the register

See Also:

GroupExtension.setHashToks( java.lang.String, org.extex.interpreter.primitives.register.hash.HashToks)