uk.ac.ed.ph.snuggletex.definitions

Class BuiltinEnvironment

java.lang.Object

uk.ac.ed.ph.snuggletex.definitions.BuiltinEnvironment

All Implemented Interfaces:

CommandOrEnvironment, Environment

public final class BuiltinEnvironment
extends Object
implements Environment

Defines a built-in LaTeX environment, as specified within a SnugglePackage.

Version:

$Revision:179 $

Author:

David McKain

See Also:

BuiltinCommand, CorePackageDefinitions

Field Summary

Fields

Modifier and Type	Field and Description
protected EnumSet<LaTeXMode>	allowedModes
protected boolean	allowingOptionalArgument
protected int	argumentCount
protected H	domBuildingHandler
protected EnumMap<InterpretationType,Interpretation>	interpretationMap
protected String	texName
protected TextFlowContext	textFlowContext

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
EnumSet<LaTeXMode>	getAllowedModes()
int	getArgumentCount() Returns the number of mandatory arguments this command expects, which will be zero or greater.
LaTeXMode	getArgumentMode(int argumentIndex) (Currently all built-in environments parse their arguments in LaTeXMode.PARAGRAPH.)
LaTeXMode	getContentMode() Specifies which mode to parse content in.
H	getDOMBuildingHandler()
Interpretation	getInterpretation(InterpretationType type)
EnumMap<InterpretationType,Interpretation>	getInterpretationMap()
String	getTeXName() Returns the TeX name for this command or environment.
TextFlowContext	getTextFlowContext()
boolean	hasInterpretation(InterpretationType type)
boolean	isAllowingOptionalArgument() Returns whether this command/environment takes an optional argument.
String	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, getTeXName, isAllowingOptionalArgument

Field Detail

texName

protected final String texName

allowingOptionalArgument

protected final boolean allowingOptionalArgument

argumentCount

protected final int argumentCount

allowedModes

protected final EnumSet<LaTeXMode> allowedModes

interpretationMap

protected final EnumMap<InterpretationType,Interpretation> interpretationMap

textFlowContext

protected final TextFlowContext textFlowContext

domBuildingHandler

protected final H domBuildingHandler

Constructor Detail

BuiltinEnvironment

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

Method Detail

getArgumentMode

public LaTeXMode getArgumentMode(int argumentIndex)

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

Specified by:

getArgumentMode in interface CommandOrEnvironment

getContentMode

public LaTeXMode getContentMode()

Description copied from interface: Environment

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

Specified by:

getContentMode in interface Environment

getTeXName

public String getTeXName()

Description copied from interface: CommandOrEnvironment

Returns the TeX name for this command or environment. (In the case of commands, this does not include the leading backslash.)

Specified by:

getTeXName in interface CommandOrEnvironment

isAllowingOptionalArgument

public boolean isAllowingOptionalArgument()

Description copied from interface: CommandOrEnvironment

Returns whether this command/environment takes an optional argument. As per LaTeX convention, this will only return true if the command/environment takes at least one mandatory argument as well.

Specified by:

isAllowingOptionalArgument in interface CommandOrEnvironment

getArgumentCount

public int getArgumentCount()

Description copied from interface: CommandOrEnvironment

Returns the number of mandatory arguments this command expects, which will be zero or greater.

Specified by:

getArgumentCount in interface CommandOrEnvironment

getAllowedModes

public EnumSet<LaTeXMode> getAllowedModes()

getInterpretationMap

public EnumMap<InterpretationType,Interpretation> getInterpretationMap()

hasInterpretation

public boolean hasInterpretation(InterpretationType type)

getInterpretation

public Interpretation getInterpretation(InterpretationType type)

getTextFlowContext

public TextFlowContext getTextFlowContext()

getDOMBuildingHandler

public H getDOMBuildingHandler()

toString

public final String toString()

Overrides:

toString in class Object