Top Description Fields Constructors Methods
uk.ac.ed.ph.snuggletex.definitions

public final Class UserDefinedEnvironment

extends UserDefinedCommandOrEnvironment
implements Environment
Class Inheritance
All Implemented Interfaces
uk.ac.ed.ph.snuggletex.definitions.Environment, uk.ac.ed.ph.snuggletex.definitions.CommandOrEnvironment
Imports
uk.ac.ed.ph.snuggletex.internal.FrozenSlice
Represents a user-defined environment, created by clients using the \\newenvironment command.
Author
David McKain
Version
$Revision$
See Also
UserDefinedCommand

Field Summary

Modifier and TypeField and Description
private final FrozenSlice
beginDefinitionSlice

private final FrozenSlice
endDefinitionSlice

Inherited from uk.ac.ed.ph.snuggletex.definitions.UserDefinedCommandOrEnvironment:
argumentCountoptionalArgumenttexName

Constructor Summary

AccessConstructor and Description
public
UserDefinedEnvironment(final String texName, final String optionalArgument, final int argumentCount, final FrozenSlice beginDefinitionSlice, final FrozenSlice endDefinitionSlice)

Method Summary

Modifier and TypeMethod and Description
public FrozenSlice
getBeginDefinitionSlice()

public LaTeXMode
getContentMode()

Implements uk.ac.ed.ph.snuggletex.definitions.Environment.getContentMode.

Use existing content mode

public FrozenSlice
getEndDefinitionSlice()

Inherited from uk.ac.ed.ph.snuggletex.definitions.UserDefinedCommandOrEnvironment:
getArgumentCountgetArgumentModegetOptionalArgumentgetTeXNameisAllowingOptionalArgumenttoString

Field Detail

beginDefinitionSliceback to summary
private final FrozenSlice beginDefinitionSlice
endDefinitionSliceback to summary
private final FrozenSlice endDefinitionSlice

Constructor Detail

UserDefinedEnvironmentback to summary
public UserDefinedEnvironment(final String texName, final String optionalArgument, final int argumentCount, final FrozenSlice beginDefinitionSlice, final FrozenSlice endDefinitionSlice)

Method Detail

getBeginDefinitionSliceback to summary
public FrozenSlice getBeginDefinitionSlice()
getContentModeback to summary
public LaTeXMode getContentMode()

Implements uk.ac.ed.ph.snuggletex.definitions.Environment.getContentMode.

Use existing content mode

getEndDefinitionSliceback to summary
public FrozenSlice getEndDefinitionSlice()