uk.ac.ed.ph.snuggletex.definitions

类 UserDefinedCommandOrEnvironment

java.lang.Object

uk.ac.ed.ph.snuggletex.definitions.UserDefinedCommandOrEnvironment

所有已实现的接口:

CommandOrEnvironment

直接已知子类:

UserDefinedCommand, UserDefinedEnvironment

public abstract class UserDefinedCommandOrEnvironment
extends java.lang.Object
implements CommandOrEnvironment

Partial base class for UserDefinedCommands and UserDefinedEnvironments.

另请参阅:

UserDefinedEnvironment

字段概要

字段

限定符和类型	字段和说明
protected int	argumentCount Number of arguments
protected java.lang.String	optionalArgument Optional argument, which may be blank. null if not supported
protected java.lang.String	texName

构造器概要

构造器

构造器和说明
UserDefinedCommandOrEnvironment(java.lang.String texName, java.lang.String optionalArgument, int argumentCount)

方法概要

限定符和类型	方法和说明
int	getArgumentCount() Returns the number of mandatory arguments this command expects, which will be zero or greater.
LaTeXMode	getArgumentMode(int argumentIndex) User-defined commands and environments stay in the same mode when parsing arguments.
java.lang.String	getOptionalArgument()
java.lang.String	getTeXName() Returns the TeX name for this command or environment.
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

字段详细资料

texName

protected final java.lang.String texName

optionalArgument

protected final java.lang.String optionalArgument

Optional argument, which may be blank. null if not supported

argumentCount

protected final int argumentCount

Number of arguments

构造器详细资料

UserDefinedCommandOrEnvironment

public UserDefinedCommandOrEnvironment(java.lang.String texName,
                                       java.lang.String optionalArgument,
                                       int argumentCount)

方法详细资料

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

getOptionalArgument

public java.lang.String getOptionalArgument()

getArgumentCount

public int getArgumentCount()

从接口复制的说明: CommandOrEnvironment

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

指定者:

getArgumentCount 在接口中 CommandOrEnvironment

getArgumentMode

public LaTeXMode getArgumentMode(int argumentIndex)

User-defined commands and environments stay in the same mode when parsing arguments.

指定者:

getArgumentMode 在接口中 CommandOrEnvironment

toString

public final java.lang.String toString()

覆盖:

toString 在类中 java.lang.Object