uk.ac.ed.ph.snuggletex.definitions

类 BuiltinCommand

java.lang.Object

uk.ac.ed.ph.snuggletex.definitions.BuiltinCommand

所有已实现的接口:

Command, CommandOrEnvironment

public final class BuiltinCommand
extends java.lang.Object
implements Command

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.

另请参阅:

BuiltinEnvironment, CorePackageDefinitions

字段概要

字段

限定符和类型	字段和说明
protected java.util.EnumSet<LaTeXMode>	allowedModes
protected boolean	allowingOptionalArgument
protected int	argumentCount
protected H	domBuildingHandler
protected java.util.EnumMap<InterpretationType,Interpretation>	interpretationMap
protected java.lang.String	texName
protected TextFlowContext	textFlowContext

构造器概要

构造器

构造器和说明
BuiltinCommand(java.lang.String texName, CommandType commandType, boolean allowingOptionalArgument, int argumentCount, java.util.EnumSet<LaTeXMode> allowedModes, LaTeXMode[] argumentModes, java.util.EnumMap<InterpretationType,Interpretation> interpretations, CommandHandler domBuilderHandler, TextFlowContext textFlowContext, CombinerTargetMatcher combinerTargetMatcher)

方法概要

限定符和类型	方法和说明
java.util.EnumSet<LaTeXMode>	getAllowedModes()
int	getArgumentCount() Returns the number of mandatory arguments this command expects, which will be zero or greater.
LaTeXMode	getArgumentMode(int argumentIndex) 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.
CombinerTargetMatcher	getCombinerTargetMatcher()
H	getDOMBuildingHandler()
Interpretation	getInterpretation(InterpretationType type)
java.util.EnumMap<InterpretationType,Interpretation>	getInterpretationMap()
MathCharacter	getMathCharacter()
int	getMathCharacterCodePoint()
java.lang.String	getTeXName() Returns the TeX name for this command or environment.
TextFlowContext	getTextFlowContext()
CommandType	getType()
boolean	hasInterpretation(InterpretationType type)
boolean	isAllowingOptionalArgument() Returns whether this command/environment takes an optional argument.
java.lang.String	toString()

从类继承的方法 java.lang.Object

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

从接口继承的方法 uk.ac.ed.ph.snuggletex.definitions.CommandOrEnvironment

getArgumentCount, getTeXName, isAllowingOptionalArgument

字段详细资料

texName

protected final java.lang.String texName

allowingOptionalArgument

protected final boolean allowingOptionalArgument

argumentCount

protected final int argumentCount

allowedModes

protected final java.util.EnumSet<LaTeXMode> allowedModes

interpretationMap

protected final java.util.EnumMap<InterpretationType,Interpretation> interpretationMap

textFlowContext

protected final TextFlowContext textFlowContext

domBuildingHandler

protected final H domBuildingHandler

构造器详细资料

BuiltinCommand

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

方法详细资料

getType

public CommandType getType()

getArgumentMode

public LaTeXMode getArgumentMode(int argumentIndex)

从接口复制的说明: CommandOrEnvironment

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 在接口中 CommandOrEnvironment

getCombinerTargetMatcher

public CombinerTargetMatcher getCombinerTargetMatcher()

getMathCharacter

public MathCharacter getMathCharacter()

getMathCharacterCodePoint

public int getMathCharacterCodePoint()

getTeXName

public java.lang.String getTeXName()

从接口复制的说明: CommandOrEnvironment

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

指定者:

getTeXName 在接口中 CommandOrEnvironment

isAllowingOptionalArgument

public boolean isAllowingOptionalArgument()

从接口复制的说明: 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.

指定者:

isAllowingOptionalArgument 在接口中 CommandOrEnvironment

getArgumentCount

public int getArgumentCount()

从接口复制的说明: CommandOrEnvironment

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

指定者:

getArgumentCount 在接口中 CommandOrEnvironment

getAllowedModes

public java.util.EnumSet<LaTeXMode> getAllowedModes()

getInterpretationMap

public java.util.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 java.lang.String toString()

覆盖:

toString 在类中 java.lang.Object