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

public final Class BuiltinEnvironment

extends BuiltinCommandOrEnvironment<EnvironmentHandler>
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.SnugglePackage, uk.ac.ed.ph.snuggletex.dombuilding.EnvironmentHandler, uk.ac.ed.ph.snuggletex.semantics.Interpretation, .InterpretationType, java.util.EnumMap, .EnumSet
Defines a built-in LaTeX environment, as specified within a SnugglePackage.
Author
David McKain
Version
$Revision:179 $
See Also
BuiltinCommand, CorePackageDefinitions

Field Summary

Modifier and TypeField and Description
private final LaTeXMode
contentMode

Mode to use when parsing content.

Inherited from uk.ac.ed.ph.snuggletex.definitions.BuiltinCommandOrEnvironment:
allowedModesallowingOptionalArgumentargumentCountdomBuildingHandlerinterpretationMaptexNametextFlowContext

Constructor Summary

AccessConstructor and Description
public
BuiltinEnvironment(final String texName, final boolean allowingOptionalArgument, final int argumentCount, final EnumSet<LaTeXMode> allowedModes, final LaTeXMode contentMode, final EnumMap<InterpretationType, Interpretation> interpretations, final EnvironmentHandler domBuildingHandler, final TextFlowContext textFlowContext)

Method Summary

Modifier and TypeMethod and Description
public LaTeXMode
getArgumentMode(int argumentIndex)

Implements uk.ac.ed.ph.snuggletex.definitions.CommandOrEnvironment.getArgumentMode.

(Currently all built-in environments parse their arguments in LaTeXMode#PARAGRAPH.)

public LaTeXMode
getContentMode()

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

Specifies which mode to parse content in. If null, then the "current" mode is used.

Inherited from uk.ac.ed.ph.snuggletex.definitions.BuiltinCommandOrEnvironment:
getAllowedModesgetArgumentCountgetDOMBuildingHandlergetInterpretationgetInterpretationMapgetTeXNamegetTextFlowContexthasInterpretationisAllowingOptionalArgumenttoString

Field Detail

contentModeback to summary
private final LaTeXMode contentMode

Mode to use when parsing content. If null, will preserve mode that environment is called in.

Constructor Detail

BuiltinEnvironmentback to summary
public BuiltinEnvironment(final String texName, final boolean allowingOptionalArgument, final int argumentCount, final EnumSet<LaTeXMode> allowedModes, final LaTeXMode contentMode, final EnumMap<InterpretationType, Interpretation> interpretations, final EnvironmentHandler domBuildingHandler, final TextFlowContext textFlowContext)

Method Detail

getArgumentModeback to summary
public LaTeXMode getArgumentMode(int argumentIndex)

Implements uk.ac.ed.ph.snuggletex.definitions.CommandOrEnvironment.getArgumentMode.

(Currently all built-in environments parse their arguments in LaTeXMode#PARAGRAPH.)

getContentModeback to summary
public LaTeXMode getContentMode()

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

Doc from uk.ac.ed.ph.snuggletex.definitions.Environment.getContentMode.

Specifies which mode to parse content in. If null, then the "current" mode is used.