uk.ac.ed.ph.snuggletex.definitions

Class UserDefinedEnvironment

java.lang.Object

uk.ac.ed.ph.snuggletex.definitions.UserDefinedCommandOrEnvironment

uk.ac.ed.ph.snuggletex.definitions.UserDefinedEnvironment

All Implemented Interfaces:

CommandOrEnvironment, Environment

public final class UserDefinedEnvironment
extends UserDefinedCommandOrEnvironment
implements Environment

Represents a user-defined environment, created by clients using the \\newenvironment command.

Version:

$Revision$

Author:

David McKain

See Also:

UserDefinedCommand

Field Summary

Fields inherited from class uk.ac.ed.ph.snuggletex.definitions.UserDefinedCommandOrEnvironment

argumentCount, optionalArgument, texName

Constructor Summary

Constructors

Constructor and Description
UserDefinedEnvironment(String texName, String optionalArgument, int argumentCount, FrozenSlice beginDefinitionSlice, FrozenSlice endDefinitionSlice)

Method Summary

Modifier and Type	Method and Description
FrozenSlice	getBeginDefinitionSlice()
LaTeXMode	getContentMode() Use existing content mode
FrozenSlice	getEndDefinitionSlice()

Methods inherited from class uk.ac.ed.ph.snuggletex.definitions.UserDefinedCommandOrEnvironment

getArgumentCount, getArgumentMode, getOptionalArgument, getTeXName, isAllowingOptionalArgument, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface uk.ac.ed.ph.snuggletex.definitions.CommandOrEnvironment

getArgumentCount, getArgumentMode, getTeXName, isAllowingOptionalArgument

Constructor Detail

UserDefinedEnvironment

public UserDefinedEnvironment(String texName,
                              String optionalArgument,
                              int argumentCount,
                              FrozenSlice beginDefinitionSlice,
                              FrozenSlice endDefinitionSlice)

Method Detail

getBeginDefinitionSlice

public FrozenSlice getBeginDefinitionSlice()

getEndDefinitionSlice

public FrozenSlice getEndDefinitionSlice()

getContentMode

public LaTeXMode getContentMode()

Use existing content mode

Specified by:

getContentMode in interface Environment