uk.ac.ed.ph.snuggletex.definitions

Class UserDefinedCommandOrEnvironment

java.lang.Object

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

All Implemented Interfaces:

CommandOrEnvironment

Direct Known Subclasses:

UserDefinedCommand, UserDefinedEnvironment

public abstract class UserDefinedCommandOrEnvironment
extends Object
implements CommandOrEnvironment

Partial base class for UserDefinedCommands and UserDefinedEnvironments.

Version:

$Revision$

Author:

David McKain

See Also:

UserDefinedEnvironment

Field Summary

Fields

Modifier and Type	Field and Description
protected int	argumentCount Number of arguments
protected String	optionalArgument Optional argument, which may be blank. null if not supported
protected String	texName

Constructor Summary

Constructors

Constructor and Description
UserDefinedCommandOrEnvironment(String texName, String optionalArgument, int argumentCount)

Method Summary

Modifier and Type	Method and Description
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.
String	getOptionalArgument()
String	getTeXName() Returns the TeX name for this command or environment.
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

Field Detail

texName

protected final String texName

optionalArgument

protected final String optionalArgument

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

argumentCount

protected final int argumentCount

Number of arguments

Constructor Detail

UserDefinedCommandOrEnvironment

public UserDefinedCommandOrEnvironment(String texName,
                                       String optionalArgument,
                                       int argumentCount)

Method Detail

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

getOptionalArgument

public String getOptionalArgument()

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

getArgumentMode

public LaTeXMode getArgumentMode(int argumentIndex)

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

Specified by:

getArgumentMode in interface CommandOrEnvironment

toString

public final String toString()

Overrides:

toString in class Object