public final Class BuiltinCommand

Class Inheritance

extends BuiltinCommandOrEnvironment<CommandHandler>
implements Command

java.lang.Object
uk.ac.ed.ph.snuggletex.definitions.BuiltinCommandOrEnvironment
uk.ac.ed.ph.snuggletex.definitions.BuiltinCommand

All Implemented Interfaces

uk.ac.ed.ph.snuggletex.definitions.Command, uk.ac.ed.ph.snuggletex.definitions.CommandOrEnvironment

Imports

uk.ac.ed.ph.snuggletex.SnugglePackage, uk.ac.ed.ph.snuggletex.dombuilding.CommandHandler, uk.ac.ed.ph.snuggletex.semantics.Interpretation, .InterpretationType, .MathCharacterInterpretation, java.util.EnumMap, .EnumSet

Represents a Command that has been defined internally via a SnugglePackage.

All of the core LaTeX macros have been defined in this way - see CorePackageDefinitions.

Author: David McKain
Version: $Revision:179 $
See Also: BuiltinEnvironment, CorePackageDefinitions

Field Summary

Modifier and Type	Field and Description
private final LaTeXMode[]	argumentModes Mode to use when parsing arguments.
private final CombinerTargetMatcher	combinerTargetMatcher
private final CommandType	type

Inherited from uk.ac.ed.ph.snuggletex.definitions.BuiltinCommandOrEnvironment:: allowedModes allowingOptionalArgument argumentCount domBuildingHandler interpretationMap texName textFlowContext

Constructor Summary

Access	Constructor and Description
public	BuiltinCommand(final String texName, final CommandType commandType, final boolean allowingOptionalArgument, final int argumentCount, final EnumSet<LaTeXMode> allowedModes, final LaTeXMode[] argumentModes, final EnumMap<InterpretationType, Interpretation> interpretations, final CommandHandler domBuilderHandler, final TextFlowContext textFlowContext, final CombinerTargetMatcher combinerTargetMatcher)

Access

Constructor and Description

public

BuiltinCommand(final String texName, final CommandType commandType, final boolean allowingOptionalArgument, final int argumentCount, final EnumSet<LaTeXMode> allowedModes, final LaTeXMode[] argumentModes, final EnumMap<InterpretationType, Interpretation> interpretations, final CommandHandler domBuilderHandler, final TextFlowContext textFlowContext, final CombinerTargetMatcher combinerTargetMatcher)

Method Summary

Modifier and Type	Method and Description
public LaTeXMode	getArgumentMode(int argumentIndex) Implements uk.ac.ed.ph.snuggletex.definitions.CommandOrEnvironment.getArgumentMode. Returns the LaTeX mode that each argument should be parsed in, starting with the optional argument (if used) and then each mandatory argument in order.
public CombinerTargetMatcher	getCombinerTargetMatcher()
public MathCharacter	getMathCharacter()
public int	getMathCharacterCodePoint()
public CommandType	getType()

Inherited from uk.ac.ed.ph.snuggletex.definitions.BuiltinCommandOrEnvironment:: getAllowedModes getArgumentCount getDOMBuildingHandler getInterpretation getInterpretationMap getTeXName getTextFlowContext hasInterpretation isAllowingOptionalArgument toString

Field Detail

argumentModes	back to summary
private final LaTeXMode[] argumentModes Mode to use when parsing arguments. If not supplied, will preserve mode that Macro is being used in. (Main example: \mbox{...} will go into LR mode for its arguments)

combinerTargetMatcher	back to summary
private final CombinerTargetMatcher combinerTargetMatcher

type	back to summary
private final CommandType type

Constructor Detail

BuiltinCommand	back to summary
public BuiltinCommand(final String texName, final CommandType commandType, final boolean allowingOptionalArgument, final int argumentCount, final EnumSet<LaTeXMode> allowedModes, final LaTeXMode[] argumentModes, final EnumMap<InterpretationType, Interpretation> interpretations, final CommandHandler domBuilderHandler, final TextFlowContext textFlowContext, final CombinerTargetMatcher combinerTargetMatcher)

BuiltinCommand

back to summary

public BuiltinCommand(final String texName, final CommandType commandType, final boolean allowingOptionalArgument, final int argumentCount, final EnumSet<LaTeXMode> allowedModes, final LaTeXMode[] argumentModes, final EnumMap<InterpretationType, Interpretation> interpretations, final CommandHandler domBuilderHandler, final TextFlowContext textFlowContext, final CombinerTargetMatcher combinerTargetMatcher)

Method Detail

getArgumentMode	back to summary
public LaTeXMode getArgumentMode(int argumentIndex) Implements uk.ac.ed.ph.snuggletex.definitions.CommandOrEnvironment.getArgumentMode. Doc from uk.ac.ed.ph.snuggletex.definitions.CommandOrEnvironment.getArgumentMode. Returns the LaTeX mode that each argument should be parsed in, starting with the optional argument (if used) and then each mandatory argument in order. Null entries indicate that the current LaTeX mode should be used.

getArgumentMode

back to summary

public LaTeXMode getArgumentMode(int argumentIndex)

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

Doc from uk.ac.ed.ph.snuggletex.definitions.CommandOrEnvironment.getArgumentMode.

Returns the LaTeX mode that each argument should be parsed in, starting with the optional argument (if used) and then each mandatory argument in order. Null entries indicate that the current LaTeX mode should be used.

getCombinerTargetMatcher	back to summary
public CombinerTargetMatcher getCombinerTargetMatcher()

getMathCharacter	back to summary
public MathCharacter getMathCharacter()

getMathCharacterCodePoint	back to summary
public int getMathCharacterCodePoint()

getType	back to summary
public CommandType getType()