A B C D E F G H I J L M N O P Q R S T U V W X

A

AbstractCustomXMLElementHandler - Class in uk.ac.ed.ph.snuggletex.dombuilding

Provides base functionality for the commands and environments that build custom XML elements.

AbstractCustomXMLElementHandler() - Constructor for class uk.ac.ed.ph.snuggletex.dombuilding.AbstractCustomXMLElementHandler

ACCENT - Static variable in interface uk.ac.ed.ph.snuggletex.definitions.AccentMaps

AccentHandler - Class in uk.ac.ed.ph.snuggletex.dombuilding

This builder handles applying accents to characters.

AccentHandler(AccentMap, char, String) - Constructor for class uk.ac.ed.ph.snuggletex.dombuilding.AccentHandler

AccentHandler(AccentMap) - Constructor for class uk.ac.ed.ph.snuggletex.dombuilding.AccentHandler

AccentMap - Class in uk.ac.ed.ph.snuggletex.definitions

Map defines how unaccented alphabetic characters should map to corresponding Unicode characters when a particular type of accent is applied (e.g. circumflex).

AccentMap(char[], String) - Constructor for class uk.ac.ed.ph.snuggletex.definitions.AccentMap

AccentMaps - Interface in uk.ac.ed.ph.snuggletex.definitions

Defines all of the AccentMaps for the various types of accents we support.

addClientSideXSLTStylesheetURLs(String...) - Method in class uk.ac.ed.ph.snuggletex.WebPageOutputOptions

Appends to existing array of relative URLs specifying client-side XSLT stylesheets to be referenced in the resulting page.

addCombinerCommand(String, EnumSet<LaTeXMode>, CombinerTargetMatcher, CommandHandler, TextFlowContext) - Method in class uk.ac.ed.ph.snuggletex.SnugglePackage

addCommand(BuiltinCommand) - Method in class uk.ac.ed.ph.snuggletex.SnugglePackage

addCommandInterpretation(String, Interpretation) - Method in class uk.ac.ed.ph.snuggletex.SnugglePackage

addComplexCommand(String, boolean, int, EnumSet<LaTeXMode>, LaTeXMode[], CommandHandler, TextFlowContext) - Method in class uk.ac.ed.ph.snuggletex.SnugglePackage

addComplexCommandOneArg(String, boolean, EnumSet<LaTeXMode>, LaTeXMode, CommandHandler, TextFlowContext) - Method in class uk.ac.ed.ph.snuggletex.SnugglePackage

addComplexCommandOneArg(String, boolean, EnumSet<LaTeXMode>, LaTeXMode, Interpretation, CommandHandler, TextFlowContext) - Method in class uk.ac.ed.ph.snuggletex.SnugglePackage

addComplexCommandSameArgMode(String, boolean, int, EnumSet<LaTeXMode>, CommandHandler, TextFlowContext) - Method in class uk.ac.ed.ph.snuggletex.SnugglePackage

addComplexCommandSameArgMode(String, boolean, int, EnumSet<LaTeXMode>, Interpretation, CommandHandler, TextFlowContext) - Method in class uk.ac.ed.ph.snuggletex.SnugglePackage

addCSSStylesheetURLs(String...) - Method in class uk.ac.ed.ph.snuggletex.WebPageOutputOptions

Appends to existing array of relative URLs specifying client-side CSS stylesheets to be referenced in the resulting page.

addDOMPostProcessors(DOMPostProcessor...) - Method in class uk.ac.ed.ph.snuggletex.DOMOutputOptions

Appends to the currently specified DOMPostProcessor that will be called in turn to "fix up" or modify the raw DOM produced by SnuggleTeX immediately after it has been built.

addEnvironment(String, EnumSet<LaTeXMode>, LaTeXMode, Interpretation, EnvironmentHandler, TextFlowContext) - Method in class uk.ac.ed.ph.snuggletex.SnugglePackage

addEnvironment(String, EnumSet<LaTeXMode>, LaTeXMode, Interpretation[], EnvironmentHandler, TextFlowContext) - Method in class uk.ac.ed.ph.snuggletex.SnugglePackage

addEnvironment(String, boolean, int, EnumSet<LaTeXMode>, LaTeXMode, Interpretation, EnvironmentHandler, TextFlowContext) - Method in class uk.ac.ed.ph.snuggletex.SnugglePackage

addEnvironment(String, boolean, int, EnumSet<LaTeXMode>, LaTeXMode, Interpretation[], EnvironmentHandler, TextFlowContext) - Method in class uk.ac.ed.ph.snuggletex.SnugglePackage

addEnvironment(BuiltinEnvironment) - Method in class uk.ac.ed.ph.snuggletex.SnugglePackage

addErrorCode(ErrorCode) - Method in class uk.ac.ed.ph.snuggletex.SnugglePackage

addErrorCodes(ErrorCode...) - Method in class uk.ac.ed.ph.snuggletex.SnugglePackage

addInterpretation(Interpretation) - Method in class uk.ac.ed.ph.snuggletex.definitions.MathCharacter

addMathCharacterCommand(MathCharacter) - Method in class uk.ac.ed.ph.snuggletex.SnugglePackage

addMathCharacterCommandAlias(String, MathCharacter) - Method in class uk.ac.ed.ph.snuggletex.SnugglePackage

addPackage(SnugglePackage) - Method in class uk.ac.ed.ph.snuggletex.SnuggleEngine

Registers the given SnugglePackage with this SnuggleEngine.

addSimpleCommand(String, EnumSet<LaTeXMode>, CommandHandler, TextFlowContext) - Method in class uk.ac.ed.ph.snuggletex.SnugglePackage

addSimpleCommand(String, EnumSet<LaTeXMode>, Interpretation[], CommandHandler, TextFlowContext) - Method in class uk.ac.ed.ph.snuggletex.SnugglePackage

addSimpleCommand(String, EnumSet<LaTeXMode>, Interpretation, CommandHandler, TextFlowContext) - Method in class uk.ac.ed.ph.snuggletex.SnugglePackage

addSimpleMathCommand(String, MathInterpretation...) - Method in class uk.ac.ed.ph.snuggletex.SnugglePackage

addSimpleMathCommand(String, MathInterpretation, CommandHandler) - Method in class uk.ac.ed.ph.snuggletex.SnugglePackage

addSimpleMathCommand(String, MathInterpretation[], CommandHandler) - Method in class uk.ac.ed.ph.snuggletex.SnugglePackage

addStylesheets(Transformer...) - Method in class uk.ac.ed.ph.snuggletex.WebPageOutputOptions

Appends to existing array of JAXP Transformers representing XSLT stylesheet(s) that will be applied to the resulting web page once it has been built but before it is serialised.

AlignHandler - Class in uk.ac.ed.ph.snuggletex.dombuilding

Handles the LaTeX align environment.

AlignHandler() - Constructor for class uk.ac.ed.ph.snuggletex.dombuilding.AlignHandler

ALL_MATH_CHARACTER_DEFS_RESOURCE_NAME - Static variable in class uk.ac.ed.ph.snuggletex.definitions.CorePackageDefinitions

ALL_MODES - Static variable in class uk.ac.ed.ph.snuggletex.definitions.Globals

This represents all modes that LaTeX commands can be used in, so is currently a bit of a misnomer as it excludes LaTeXMode.VERBATIM!

AnchorHandler - Class in uk.ac.ed.ph.snuggletex.dombuilding

Handles the \\anchor command, generating an XHTML anchor.

AnchorHandler() - Constructor for class uk.ac.ed.ph.snuggletex.dombuilding.AnchorHandler

ANNOTATION_LOCAL_NAME - Static variable in class uk.ac.ed.ph.snuggletex.utilities.MathMLUtilities

ANNOTATION_XML_LOCAL_NAME - Static variable in class uk.ac.ed.ph.snuggletex.utilities.MathMLUtilities

appendErrorAsString(StringBuffer, InputError) - Static method in class uk.ac.ed.ph.snuggletex.utilities.MessageFormatter

appendErrorElement(Element, ErrorToken) - Method in class uk.ac.ed.ph.snuggletex.internal.DOMBuilder

appendMathCharacter(Element, MathCharacter) - Method in class uk.ac.ed.ph.snuggletex.internal.DOMBuilder

appendMathMLElement(Element, String) - Method in class uk.ac.ed.ph.snuggletex.internal.DOMBuilder

appendMathMLIdentifierElement(Element, String) - Method in class uk.ac.ed.ph.snuggletex.internal.DOMBuilder

Creates a MathML identifier element, which may either be a single character or multiple characters (e.g.

appendMathMLNumberElement(Element, String) - Method in class uk.ac.ed.ph.snuggletex.internal.DOMBuilder

appendMathMLOperatorElement(Element, String) - Method in class uk.ac.ed.ph.snuggletex.internal.DOMBuilder

appendMathMLSpace(Element, String) - Method in class uk.ac.ed.ph.snuggletex.internal.DOMBuilder

appendMathMLTextElement(Element, String, String, boolean) - Method in class uk.ac.ed.ph.snuggletex.internal.DOMBuilder

appendObject(Object) - Method in class uk.ac.ed.ph.snuggletex.internal.util.ObjectDumper

Does a dump of the given Object, using whatever DumpMode is providied for its class.

appendObject(Object, DumpMode) - Method in class uk.ac.ed.ph.snuggletex.internal.util.ObjectDumper

Does a dump of the given Object using the given DumpMode.

appendOrThrowError(Element, Token, ErrorCode, Object...) - Method in class uk.ac.ed.ph.snuggletex.internal.DOMBuilder

appendSimpleMathElement(Element, Token) - Method in class uk.ac.ed.ph.snuggletex.internal.DOMBuilder

appendSliceContext(StringBuffer, FrozenSlice) - Static method in class uk.ac.ed.ph.snuggletex.utilities.MessageFormatter

appendSnuggleElement(Element, String) - Method in class uk.ac.ed.ph.snuggletex.internal.DOMBuilder

appendTextNode(Element, String, boolean) - Method in class uk.ac.ed.ph.snuggletex.internal.DOMBuilder

appendXHTMLElement(Element, String) - Method in class uk.ac.ed.ph.snuggletex.internal.DOMBuilder

appendXHTMLTextElement(Element, String, String, boolean) - Method in class uk.ac.ed.ph.snuggletex.internal.DOMBuilder

applyCSSStyle(Element, String...) - Method in class uk.ac.ed.ph.snuggletex.internal.DOMBuilder

ArgumentContainerToken - Class in uk.ac.ed.ph.snuggletex.tokens

This token is used as a container for the arguments specified for a particular Command or Environment.

ArgumentContainerToken(FrozenSlice, LaTeXMode, List<FlowToken>) - Constructor for class uk.ac.ed.ph.snuggletex.tokens.ArgumentContainerToken

ArgumentContainerToken(FrozenSlice, LaTeXMode, List<FlowToken>, ComputedStyle) - Constructor for class uk.ac.ed.ph.snuggletex.tokens.ArgumentContainerToken

argumentCount - Variable in class uk.ac.ed.ph.snuggletex.definitions.UserDefinedCommandOrEnvironment

Number of arguments

ArrayHandler - Class in uk.ac.ed.ph.snuggletex.dombuilding

Handles the LaTeX array environment.

ArrayHandler() - Constructor for class uk.ac.ed.ph.snuggletex.dombuilding.ArrayHandler

ArrayListStack<E> - Class in uk.ac.ed.ph.snuggletex.internal.util

Trivial extension of ArrayList that mixes in the stack-like bits from Stack whilst still being non-synchronized.

ArrayListStack() - Constructor for class uk.ac.ed.ph.snuggletex.internal.util.ArrayListStack

ArrayListStack(Collection<? extends E>) - Constructor for class uk.ac.ed.ph.snuggletex.internal.util.ArrayListStack

ArrayListStack(int) - Constructor for class uk.ac.ed.ph.snuggletex.internal.util.ArrayListStack

B

beanToString(Object) - Static method in class uk.ac.ed.ph.snuggletex.internal.util.ObjectUtilities

Utility method to create a simple String representation of a JavaBean Object by showing all properties p which can be called by getP() on the Object.

BeanToStringOptions - Annotation Type in uk.ac.ed.ph.snuggletex.internal.util

Trivial annotation that can be applied to a getX() method to prevent its details from being listed by ObjectUtilities.beanToString(Object).

BoxHandler - Class in uk.ac.ed.ph.snuggletex.dombuilding

Handles \\mbox, \\fbox and friends.

BoxHandler(String) - Constructor for class uk.ac.ed.ph.snuggletex.dombuilding.BoxHandler

BraceContainerToken - Class in uk.ac.ed.ph.snuggletex.tokens

Represents a literal braced section in the original LaTeX document, i.e. something like { ... }.

BraceContainerToken(FrozenSlice, LaTeXMode, List<FlowToken>) - Constructor for class uk.ac.ed.ph.snuggletex.tokens.BraceContainerToken

BracketCombinerTargetMatcher() - Constructor for class uk.ac.ed.ph.snuggletex.dombuilding.MathFenceHandler.BracketCombinerTargetMatcher

BUFFER_SIZE - Static variable in class uk.ac.ed.ph.snuggletex.internal.util.IOUtilities

Buffer size when transferring streams

buildCSSPropertiesDocument(Document, Properties) - Method in class uk.ac.ed.ph.snuggletex.utilities.MathMLDownConverter

Converts the CSS Properties specified within the DOMOutputOptions into an XML document of the form: <properties xmlns="http;//www.ph.ed.ac.uk/snuggletex"> <property name="..." value="..."

buildCustomElement(DOMBuilder, Element, ArgumentContainerToken, ArgumentContainerToken, ArgumentContainerToken, ArgumentContainerToken) - Method in class uk.ac.ed.ph.snuggletex.dombuilding.AbstractCustomXMLElementHandler

buildDOMSubtree(List<FlowToken>) - Method in class uk.ac.ed.ph.snuggletex.internal.DOMBuilder

This is the external entry point used by SnuggleSession only.

buildDOMSubtree(Element, List<FlowToken>) - Method in class uk.ac.ed.ph.snuggletex.internal.DOMBuildingController

buildDOMSubtree(Element, DOMOutputOptions) - Method in class uk.ac.ed.ph.snuggletex.SnuggleSession

Builds a DOM sub-tree based on the currently parsed tokens, appending the results as children of the given target root Element.

buildDOMSubtree(Element) - Method in class uk.ac.ed.ph.snuggletex.SnuggleSession

Builds a DOM sub-tree based on the currently parsed tokens, appending the results as children of the given target root Element.

buildDOMSubtree() - Method in class uk.ac.ed.ph.snuggletex.SnuggleSession

Convenience method to build a DOM NodeList representing the converted Tokens.

buildDOMSubtree(DOMOutputOptions) - Method in class uk.ac.ed.ph.snuggletex.SnuggleSession

Convenience method to build a DOM NodeList representing the converted Tokens.

buildMathElement(Element, Token, ArgumentContainerToken, boolean) - Method in class uk.ac.ed.ph.snuggletex.internal.DOMBuilder

Builds a MathML math element for the given Token token, using contentToken to provide the content, descending into child Nodes as normal.

buildMathElement(Element, Token, ArgumentContainerToken, boolean, DOMBuilder.MathContentBuilderCallback) - Method in class uk.ac.ed.ph.snuggletex.internal.DOMBuilder

Builds a MathML math element for the given Token token, using contentToken to provide the content, using the given DOMBuilder.MathContentBuilderCallback to supply the content.

buildMathElementContent(Element, ArgumentContainerToken, boolean) - Method in interface uk.ac.ed.ph.snuggletex.internal.DOMBuilder.MathContentBuilderCallback

buildWebPage(List<FlowToken>) - Method in class uk.ac.ed.ph.snuggletex.internal.WebPageBuilder

buildWebPage(WebPageOutputOptions) - Method in class uk.ac.ed.ph.snuggletex.SnuggleSession

Builds a complete web page based on the currently parsed tokens, returning a DOM Document Object.

buildWebPageString(List<FlowToken>) - Method in class uk.ac.ed.ph.snuggletex.internal.WebPageBuilder

buildWebPageString(WebPageOutputOptions) - Method in class uk.ac.ed.ph.snuggletex.SnuggleSession

Builds a complete web page based on the currently parsed tokens, returning a String containing the resulting content.

buildXMLString() - Method in class uk.ac.ed.ph.snuggletex.SnuggleSession

Creates a well-formed external general parsed entity out of the currently parsed tokens.

buildXMLString(XMLStringOutputOptions) - Method in class uk.ac.ed.ph.snuggletex.SnuggleSession

Creates a well-formed external general parsed entity out of the currently parsed tokens.

buildXMLString(boolean) - Method in class uk.ac.ed.ph.snuggletex.SnuggleSession

Deprecated.

Use SnuggleSession.buildXMLString(XMLStringOutputOptions) instead

buildXMLString(DOMOutputOptions) - Method in class uk.ac.ed.ph.snuggletex.SnuggleSession

Deprecated.

Use SnuggleSession.buildXMLString(XMLStringOutputOptions) instead.

buildXMLString(DOMOutputOptions, boolean) - Method in class uk.ac.ed.ph.snuggletex.SnuggleSession

Deprecated.

Use SnuggleSession.buildXMLString(XMLStringOutputOptions) instead.

BuiltinCommand - Class in uk.ac.ed.ph.snuggletex.definitions

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

BuiltinCommand(String, CommandType, boolean, int, EnumSet<LaTeXMode>, LaTeXMode[], EnumMap<InterpretationType, Interpretation>, CommandHandler, TextFlowContext, CombinerTargetMatcher) - Constructor for class uk.ac.ed.ph.snuggletex.definitions.BuiltinCommand

BuiltinEnvironment - Class in uk.ac.ed.ph.snuggletex.definitions

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

BuiltinEnvironment(String, boolean, int, EnumSet<LaTeXMode>, LaTeXMode, EnumMap<InterpretationType, Interpretation>, EnvironmentHandler, TextFlowContext) - Constructor for class uk.ac.ed.ph.snuggletex.definitions.BuiltinEnvironment

C

CharacterCommandHandler - Class in uk.ac.ed.ph.snuggletex.dombuilding

This handles simple commands that essentially just stand in for single-character identifiers that don't have any particular meaning when used in MATH mode (e.g. '$').

CharacterCommandHandler(String) - Constructor for class uk.ac.ed.ph.snuggletex.dombuilding.CharacterCommandHandler

CharacterSource(WorkingDocument.SourceContext) - Constructor for class uk.ac.ed.ph.snuggletex.internal.WorkingDocument.CharacterSource

CharacterSource(WorkingDocument.SourceContext, WorkingDocument.CharacterSource, int, CharSequence) - Constructor for class uk.ac.ed.ph.snuggletex.internal.WorkingDocument.CharacterSource

charAt(int) - Method in interface uk.ac.ed.ph.snuggletex.InputContext

Returns the character at the given index in the input document, or -1 if the index is not contained within the document.

charAt(int) - Method in class uk.ac.ed.ph.snuggletex.internal.WorkingDocument

CIRCUMFLEX - Static variable in interface uk.ac.ed.ph.snuggletex.definitions.AccentMaps

ClassPathURIResolver - Class in uk.ac.ed.ph.snuggletex.utilities

Trivial implementation of URIResolver that looks for resources via the ClassLoader.

clone() - Method in class uk.ac.ed.ph.snuggletex.DOMOutputOptions

clone() - Method in class uk.ac.ed.ph.snuggletex.SessionConfiguration

clone() - Method in class uk.ac.ed.ph.snuggletex.utilities.SerializationOptions

closeStyle() - Method in class uk.ac.ed.ph.snuggletex.internal.DOMBuilder

CMD_CHAR_BACKSLASH - Static variable in class uk.ac.ed.ph.snuggletex.definitions.CorePackageDefinitions

CMD_FRAC - Static variable in class uk.ac.ed.ph.snuggletex.definitions.CorePackageDefinitions

CMD_HLINE - Static variable in class uk.ac.ed.ph.snuggletex.definitions.CorePackageDefinitions

CMD_ITEM - Static variable in class uk.ac.ed.ph.snuggletex.definitions.CorePackageDefinitions

CMD_LEFT - Static variable in class uk.ac.ed.ph.snuggletex.definitions.CorePackageDefinitions

CMD_LIST_ITEM - Static variable in class uk.ac.ed.ph.snuggletex.definitions.CorePackageDefinitions

CMD_MROW - Static variable in class uk.ac.ed.ph.snuggletex.definitions.CorePackageDefinitions

CMD_MSUB_OR_MUNDER - Static variable in class uk.ac.ed.ph.snuggletex.definitions.CorePackageDefinitions

CMD_MSUBSUP_OR_MUNDEROVER - Static variable in class uk.ac.ed.ph.snuggletex.definitions.CorePackageDefinitions

CMD_MSUP_OR_MOVER - Static variable in class uk.ac.ed.ph.snuggletex.definitions.CorePackageDefinitions

CMD_NEWCOMMAND - Static variable in class uk.ac.ed.ph.snuggletex.definitions.CorePackageDefinitions

CMD_NEWENVIRONMENT - Static variable in class uk.ac.ed.ph.snuggletex.definitions.CorePackageDefinitions

CMD_OVER - Static variable in class uk.ac.ed.ph.snuggletex.definitions.CorePackageDefinitions

CMD_PAR - Static variable in class uk.ac.ed.ph.snuggletex.definitions.CorePackageDefinitions

CMD_PARAGRAPH - Static variable in class uk.ac.ed.ph.snuggletex.definitions.CorePackageDefinitions

CMD_RENEWCOMMAND - Static variable in class uk.ac.ed.ph.snuggletex.definitions.CorePackageDefinitions

CMD_RENEWENVIRONMENT - Static variable in class uk.ac.ed.ph.snuggletex.definitions.CorePackageDefinitions

CMD_RIGHT - Static variable in class uk.ac.ed.ph.snuggletex.definitions.CorePackageDefinitions

CMD_TABLE_COLUMN - Static variable in class uk.ac.ed.ph.snuggletex.definitions.CorePackageDefinitions

CMD_TABLE_ROW - Static variable in class uk.ac.ed.ph.snuggletex.definitions.CorePackageDefinitions

CMD_VERB - Static variable in class uk.ac.ed.ph.snuggletex.definitions.CorePackageDefinitions

CMD_VERBSTAR - Static variable in class uk.ac.ed.ph.snuggletex.definitions.CorePackageDefinitions

CMD_XML_ATTR - Static variable in class uk.ac.ed.ph.snuggletex.definitions.CorePackageDefinitions

CombinerTargetMatcher - Interface in uk.ac.ed.ph.snuggletex.definitions

This interface is used to specify which FlowTokens are valid as combiner targets for Commands of type CommandType.COMBINER

Command - Interface in uk.ac.ed.ph.snuggletex.definitions

Base interface for LaTeX commands, i.e. things entered in the form \\command.

CommandHandler - Interface in uk.ac.ed.ph.snuggletex.dombuilding

Defines how a BuiltinCommand should append children to the outgoing DOM tree.

CommandLineRunner - Class in uk.ac.ed.ph.snuggletex.samples

Trivial command line interface for running SnuggleTeX on a number of inputs files (or STDIN), supporting most of the XML- and web-based output options.

CommandLineRunner(String[]) - Constructor for class uk.ac.ed.ph.snuggletex.samples.CommandLineRunner

CommandOrEnvironment - Interface in uk.ac.ed.ph.snuggletex.definitions

Base interface for LaTeX commands and environments.

CommandToken - Class in uk.ac.ed.ph.snuggletex.tokens

This token represents a LaTeX BuiltinCommand.

CommandToken(FrozenSlice, LaTeXMode, BuiltinCommand) - Constructor for class uk.ac.ed.ph.snuggletex.tokens.CommandToken

CommandToken(FrozenSlice, LaTeXMode, BuiltinCommand, ArgumentContainerToken) - Constructor for class uk.ac.ed.ph.snuggletex.tokens.CommandToken

CommandToken(FrozenSlice, LaTeXMode, BuiltinCommand, ArgumentContainerToken, ArgumentContainerToken[]) - Constructor for class uk.ac.ed.ph.snuggletex.tokens.CommandToken

CommandType - Enum in uk.ac.ed.ph.snuggletex.definitions

Enumerates different types of LaTeX commands.

componentIndexOffset - Variable in class uk.ac.ed.ph.snuggletex.internal.WorkingDocument.Slice

ComputedStyle - Class in uk.ac.ed.ph.snuggletex.definitions

This represents the computed or runtime style of a Token.

ComputedStyle(ComputedStyle, ComputedStyle.FontFamily, ComputedStyle.FontSize) - Constructor for class uk.ac.ed.ph.snuggletex.definitions.ComputedStyle

computedStyle - Variable in class uk.ac.ed.ph.snuggletex.tokens.Token

ComputedStyle.FontFamily - Enum in uk.ac.ed.ph.snuggletex.definitions

TeX "Font Family"

ComputedStyle.FontSize - Enum in uk.ac.ed.ph.snuggletex.definitions

TeX Font Size

computeLastTokenEndIndex() - Method in class uk.ac.ed.ph.snuggletex.internal.LaTeXTokeniser.ModeState

Gets the end index of the FrozenSlice corresponding to the last Token recorded, returning the start position if nothing has been recorded.

computeTableDimensions(ArgumentContainerToken) - Static method in class uk.ac.ed.ph.snuggletex.dombuilding.TabularHandler

Computes the dimensions of the table by looking at its content.

concat(E[], E[], Class<E>) - Static method in class uk.ac.ed.ph.snuggletex.internal.util.ObjectUtilities

ConstraintUtilities - Class in uk.ac.ed.ph.snuggletex.internal.util

Simple utility methods for enforcing various types of data constraints.

ConstraintUtilities() - Constructor for class uk.ac.ed.ph.snuggletex.internal.util.ConstraintUtilities

context - Variable in class uk.ac.ed.ph.snuggletex.internal.WorkingDocument.CharacterSource

Contextual information about where this data came from

convertExplicitFencesToMfenced(Document) - Static method in class uk.ac.ed.ph.snuggletex.utilities.MathMLUtilities

Converts explicit fences generated by SnuggleTeX back to mfenced.

convertLaTeXSize(DOMBuilder, Element, Token) - Method in class uk.ac.ed.ph.snuggletex.dombuilding.HSpaceHandler

convertMfencedToExplicitFences(Document) - Static method in class uk.ac.ed.ph.snuggletex.utilities.MathMLUtilities

Replaces every deprecated MathML mfenced element in the supplied document with its explicit mrow/mo equivalent.

CORE_ERROR_MESSAGES_PROPERTIES_BASENAME - Static variable in class uk.ac.ed.ph.snuggletex.definitions.CorePackageDefinitions

Location of ResourceBundle providing error messages for this bundle

CORE_MATH_CHARACTER_DEFS_RESOURCE_NAME - Static variable in class uk.ac.ed.ph.snuggletex.definitions.CorePackageDefinitions

CORE_PACKAGE_NAME - Static variable in class uk.ac.ed.ph.snuggletex.definitions.CorePackageDefinitions

Name of the core package

CoreErrorCode - Enum in uk.ac.ed.ph.snuggletex.definitions

Enumerates the various types of client-induced errors that can arise when using the functionality provided by the core SnuggleTeX module.

CoreErrorGroup - Enum in uk.ac.ed.ph.snuggletex.definitions

Defines the groupings for the various types of client-induced errors that can arise when using the functionality provided by the core SnuggleTeX module.

CorePackageDefinitions - Class in uk.ac.ed.ph.snuggletex.definitions

This defines the default SnugglePackage (containing BuiltinCommand and BuiltinEnvironment) supported by SnuggleTeX.

CorePackageDefinitions() - Constructor for class uk.ac.ed.ph.snuggletex.definitions.CorePackageDefinitions

createEmptyContainer(Token, LaTeXMode, ComputedStyle) - Static method in class uk.ac.ed.ph.snuggletex.tokens.ArgumentContainerToken

createFromContiguousTokens(Token, LaTeXMode, List<? extends FlowToken>, ComputedStyle) - Static method in class uk.ac.ed.ph.snuggletex.tokens.ArgumentContainerToken

createFromContiguousTokens(Token, LaTeXMode, List<? extends FlowToken>, int, int, ComputedStyle) - Static method in class uk.ac.ed.ph.snuggletex.tokens.ArgumentContainerToken

createFromSingleToken(LaTeXMode, FlowToken) - Static method in class uk.ac.ed.ph.snuggletex.tokens.ArgumentContainerToken

createFromSingleToken(LaTeXMode, FlowToken, ComputedStyle) - Static method in class uk.ac.ed.ph.snuggletex.tokens.ArgumentContainerToken

createHTML4Options() - Static method in class uk.ac.ed.ph.snuggletex.WebPageOutputOptionsBuilder

Creates WebPageOutputOptions used to serve up an HTML 4 page, possibly including MathML and other XML islands.

createHTML5MathJaxOptions() - Static method in class uk.ac.ed.ph.snuggletex.WebPageOutputOptionsBuilder

Creates WebPageOutputOptions suitable for creating an HTML 5 web page with embedded MathML, using MathJax for cross-browser rendering of the MathML.

createHTML5MathJaxOptions(String) - Static method in class uk.ac.ed.ph.snuggletex.WebPageOutputOptionsBuilder

Creates WebPageOutputOptions suitable for creating an HTML 5 web page with embedded MathML, using MathJax for cross-browser rendering of the MathML.

createHTML5Options() - Static method in class uk.ac.ed.ph.snuggletex.WebPageOutputOptionsBuilder

Creates WebPageOutputOptions used to serve up an HTML 5 page, with MathML and any other XML islands "adopted" into HTML 4 by having their namespace details removed.

createIEMathPlayerSpecificOptions() - Static method in class uk.ac.ed.ph.snuggletex.WebPageOutputOptionsBuilder

Creates WebPageOutputOptions suitable for deploying solely in Internet Explorer having the MathPlayer plug-in installed.

createJAXPTransformerFactory() - Static method in class uk.ac.ed.ph.snuggletex.internal.util.XMLUtilities

Creates an instance of the currently specified JAXP TransformerFactory, ensuring that the result supports the DOMSource.FEATURE and DOMResult.FEATURE features.

createLegacyCrossBrowserOptions() - Static method in class uk.ac.ed.ph.snuggletex.WebPageOutputOptionsBuilder

Creates WebPageOutputOptions that would previously have been considered "cross-browser" in that it works on both Mozilla (i.e.

createMozillaSpecificOptions() - Static method in class uk.ac.ed.ph.snuggletex.WebPageOutputOptionsBuilder

Creates WebPageOutputOptions suitable for deploying solely in a Mozilla-based browser, such as Firefox, using its native support for MathML.

createNSAwareDocumentBuilder() - Static method in class uk.ac.ed.ph.snuggletex.internal.util.XMLUtilities

Creates a (namespace-aware) DOM DocumentBuilder, throwing a SnuggleRuntimeException if such a thing cannot be created/configured.

createSaxonTransformerFactory() - Static method in class uk.ac.ed.ph.snuggletex.internal.util.XMLUtilities

Explicitly creates a Saxon 9 TransformerFactory, as used by the up-conversion extensions.

createSession() - Method in class uk.ac.ed.ph.snuggletex.SnuggleEngine

Creates a new SnuggleSession using the default SessionConfiguration or a fresh SessionConfiguration if no default has been set.

createSession(SessionConfiguration) - Method in class uk.ac.ed.ph.snuggletex.SnuggleEngine

Creates a new SnuggleSession using the given SessionConfiguration

createSession() - Method in class uk.ac.ed.ph.snuggletex.SnuggleSnapshot

Creates a new SnuggleSession with exactly the same state as the SnuggleSession that created this SnuggleSnapshot.

createSimpleMathRunner() - Method in class uk.ac.ed.ph.snuggletex.SnuggleEngine

createSimpleMathRunner(SessionConfiguration) - Method in class uk.ac.ed.ph.snuggletex.SnuggleEngine

createSnapshot() - Method in class uk.ac.ed.ph.snuggletex.SnuggleSession

Creates a SnuggleSnapshot Object holding the current state of this session that can be later used to recreate a session having exactly the same state.

createUniversalStylesheetOptions(String) - Static method in class uk.ac.ed.ph.snuggletex.WebPageOutputOptionsBuilder

Create "Cross-browser" XHTML + MathML suitable for deploying to Mozilla and Internet Explorer + MathPlayer using a client-side XSLT often called the "Universal StyleSheet".

createUniversalStylesheetOptions(String, String) - Static method in class uk.ac.ed.ph.snuggletex.WebPageOutputOptionsBuilder

createWebPage(WebPageOutputOptions) - Method in class uk.ac.ed.ph.snuggletex.SnuggleSession

Deprecated.

createWebPageOptions(WebPageOutputOptions.WebPageType) - Static method in class uk.ac.ed.ph.snuggletex.WebPageOutputOptionsTemplates

Deprecated.

This was deprecated in SnuggleTeX 1.3.0 and will be removed in 1.4. Use WebPageOutputOptionsBuilder instead.

createWorkingDocument() - Method in class uk.ac.ed.ph.snuggletex.internal.SnuggleInputReader

createXHTMLMathJaxOptions() - Static method in class uk.ac.ed.ph.snuggletex.WebPageOutputOptionsBuilder

Creates WebPageOutputOptions suitable for creating an XHTML + MathML web page, using MathJax for cross-browser rendering of the MathML.

createXHTMLMathJaxOptions(String) - Static method in class uk.ac.ed.ph.snuggletex.WebPageOutputOptionsBuilder

Creates WebPageOutputOptions suitable for creating an XHTML + MathML web page, using MathJax for cross-browser rendering of the MathML.

createXHTMLOptions() - Static method in class uk.ac.ed.ph.snuggletex.WebPageOutputOptionsBuilder

Creates WebPageOutputOptions used to serve up an XHTML page, possibly including MathML and other XML islands.

CSS_PROPERTIES_DOCUMENT_URN - Static variable in class uk.ac.ed.ph.snuggletex.definitions.Globals

URN used in MathML -> XHTML to call up XML containing current CSS Properties

CSS_PROPERTIES_NAME - Static variable in class uk.ac.ed.ph.snuggletex.definitions.Globals

CSSPropertiesURIResolver(Document) - Constructor for class uk.ac.ed.ph.snuggletex.utilities.MathMLDownConverter.CSSPropertiesURIResolver

CSSUtilities - Class in uk.ac.ed.ph.snuggletex.utilities

Some handy utility methods for managing SnuggleTeX CSS.

CSSUtilities() - Constructor for class uk.ac.ed.ph.snuggletex.utilities.CSSUtilities

D

DecimalFormatNumberMatcher - Class in uk.ac.ed.ph.snuggletex

Implementation of NumberMatcher that uses a standard Java DecimalFormat to match numbers.

DecimalFormatNumberMatcher() - Constructor for class uk.ac.ed.ph.snuggletex.DecimalFormatNumberMatcher

DecimalFormatNumberMatcher(Locale) - Constructor for class uk.ac.ed.ph.snuggletex.DecimalFormatNumberMatcher

DecimalFormatNumberMatcher(DecimalFormat) - Constructor for class uk.ac.ed.ph.snuggletex.DecimalFormatNumberMatcher

DEFAULT_CONTENT_TYPE - Static variable in class uk.ac.ed.ph.snuggletex.WebPageOutputOptions

Default content type

DEFAULT_CONTENT_TYPE - Static variable in class uk.ac.ed.ph.snuggletex.WebPageOutputOptionsTemplates

Deprecated.

DEFAULT_ENCODING - Static variable in interface uk.ac.ed.ph.snuggletex.SerializationSpecifier

Default encoding to use

DEFAULT_EXPANSION_LIMIT - Static variable in class uk.ac.ed.ph.snuggletex.SessionConfiguration

DEFAULT_INDENT - Static variable in interface uk.ac.ed.ph.snuggletex.SerializationSpecifier

Default indent to use when SerializationSpecifier.isIndenting() returns true

DEFAULT_INDENT_WIDTH - Static variable in class uk.ac.ed.ph.snuggletex.internal.util.ObjectDumper

DEFAULT_INDENT_WIDTH - Static variable in class uk.ac.ed.ph.snuggletex.utilities.LaTeXIndenter

Default indent width

DEFAULT_LANG - Static variable in class uk.ac.ed.ph.snuggletex.WebPageOutputOptions

Default language

DEFAULT_LANG - Static variable in class uk.ac.ed.ph.snuggletex.WebPageOutputOptionsTemplates

Deprecated.

DEFAULT_MATHJAX_URL - Static variable in class uk.ac.ed.ph.snuggletex.internal.WebPageBuilder

Default URL and config to use when MathJax configuration option has been enabled.

DEFAULT_MATHML_PREFIX - Static variable in class uk.ac.ed.ph.snuggletex.DOMOutputOptions

Default prefix to use if/when prefixing MathML elements

DEFAULT_MAX_DEPTH - Static variable in class uk.ac.ed.ph.snuggletex.internal.util.ObjectDumper

DEFAULT_MAX_INDENT_LEVEL - Static variable in class uk.ac.ed.ph.snuggletex.utilities.LaTeXIndenter

Default maximum indent level

DEFAULT_SNUGGLETEX_XML_PREFIX - Static variable in class uk.ac.ed.ph.snuggletex.DOMOutputOptions

Default prefix to use if/when prefixing SnuggleTeX XML elements

DEFAULT_STYLE - Static variable in class uk.ac.ed.ph.snuggletex.definitions.ComputedStyle

Default style

DEFAULT_XHTML_PREFIX - Static variable in class uk.ac.ed.ph.snuggletex.DOMOutputOptions

Default prefix to use if/when prefixing XHTML elements

DefaultTransformerFactoryChooser - Class in uk.ac.ed.ph.snuggletex.utilities

Default implementation of TransformerFactoryChooser that uses the usual JAXP factory lookup mechanisms for XSLT 1.0 stylesheets, and hard-codes to SAXON for XSLT 2.0 stylesheets.

DefaultTransformerFactoryChooser() - Constructor for class uk.ac.ed.ph.snuggletex.utilities.DefaultTransformerFactoryChooser

document - Variable in class uk.ac.ed.ph.snuggletex.internal.FrozenSlice

doMathInput(String) - Method in class uk.ac.ed.ph.snuggletex.SnuggleSimpleMathRunner

doMathInput(String, DOMOutputOptions) - Method in class uk.ac.ed.ph.snuggletex.SnuggleSimpleMathRunner

doMathInput(String, XMLStringOutputOptions) - Method in class uk.ac.ed.ph.snuggletex.SnuggleSimpleMathRunner

DOMBuilder - Class in uk.ac.ed.ph.snuggletex.internal

This takes a List of (fixed) Tokens and builds a (raw) XHTML + MathML DOM tree branch from them.

DOMBuilder(SessionContext, Element, DOMOutputOptions) - Constructor for class uk.ac.ed.ph.snuggletex.internal.DOMBuilder

DOMBuilder.MathContentBuilderCallback - Interface in uk.ac.ed.ph.snuggletex.internal

Internal callback interface that specifies how to build the real content of a MathML element.

DOMBuilder.OutputContext - Enum in uk.ac.ed.ph.snuggletex.internal

Trivial enumeration to keep track of where we are in the outgoing DOM.

DOMBuildingController - Class in uk.ac.ed.ph.snuggletex.internal

This is the main entry point into the DOM generation process.

DOMBuildingController(SessionContext, DOMOutputOptions) - Constructor for class uk.ac.ed.ph.snuggletex.internal.DOMBuildingController

DOMOutputOptions - Class in uk.ac.ed.ph.snuggletex

This class is used to specify how you want DOM trees to be built when calling relevant methods in SnuggleSession (e.g.

DOMOutputOptions() - Constructor for class uk.ac.ed.ph.snuggletex.DOMOutputOptions

DOMOutputOptions.ErrorOutputOptions - Enum in uk.ac.ed.ph.snuggletex

Enumerates the various options for representing InputErrors in the resulting DOM.

DOMPostProcessor - Interface in uk.ac.ed.ph.snuggletex

This interface allows you to hook into the SnuggleTeX process immediately after the raw DOM tree has been built.

DoNothingHandler - Class in uk.ac.ed.ph.snuggletex.dombuilding

Trivial "do nothing" handler for commands and environments that don't add anything to the resulting DOM.

DoNothingHandler() - Constructor for class uk.ac.ed.ph.snuggletex.dombuilding.DoNothingHandler

DoNothingStylesheetCache - Class in uk.ac.ed.ph.snuggletex.utilities

Trivial implementation of StylesheetCache that actually doesn't cache anything at all.

DoNothingStylesheetCache() - Constructor for class uk.ac.ed.ph.snuggletex.utilities.DoNothingStylesheetCache

DOUBLE_STRUCK - Static variable in interface uk.ac.ed.ph.snuggletex.definitions.MathVariantMaps

These are defined from the MathML Double Struck characters page, omitting those in Unicode plane 1.

downConvertDOM(Document) - Method in class uk.ac.ed.ph.snuggletex.utilities.MathMLDownConverter

DownConvertingPostProcessor - Class in uk.ac.ed.ph.snuggletex

Trivial implementation of DOMPostProcessor that hooks into the MathMLDownConverter.

DownConvertingPostProcessor() - Constructor for class uk.ac.ed.ph.snuggletex.DownConvertingPostProcessor

DumpMode - Enum in uk.ac.ed.ph.snuggletex.internal.util

Enumerates the different options that can be used when specifying how to dump out properties or types in ObjectDumper.

dumpObject(Object, DumpMode) - Static method in class uk.ac.ed.ph.snuggletex.internal.util.ObjectDumper

Convenience method to do a DumpMode.DEEP dump of a single Object and return the resulting String.

dumpScoreboard() - Method in class uk.ac.ed.ph.snuggletex.internal.WorkingDocument

E

EMPTY_ARRAY - Static variable in class uk.ac.ed.ph.snuggletex.tokens.ArgumentContainerToken

EMPTY_OBJECT_ARRAY - Static variable in class uk.ac.ed.ph.snuggletex.internal.util.ObjectUtilities

Shared instance of an empty array of Objects, which is sometimes useful!

EMPTY_STRING_ARRAY - Static variable in class uk.ac.ed.ph.snuggletex.internal.util.StringUtilities

Shared instance of an empty array of Strings, which is sometimes useful!

emptyIfNull(String) - Static method in class uk.ac.ed.ph.snuggletex.internal.util.StringUtilities

Convenience method that turns a String to an empty String ("") if it is null.

endIndex - Variable in class uk.ac.ed.ph.snuggletex.internal.FrozenSlice

endIndex - Variable in class uk.ac.ed.ph.snuggletex.internal.WorkingDocument.Slice

ensureClose(Closeable...) - Static method in class uk.ac.ed.ph.snuggletex.internal.util.IOUtilities

Ensures that as many of the given Closeables are closed.

ensureDirectoryCreated(File) - Static method in class uk.ac.ed.ph.snuggletex.internal.util.IOUtilities

Simple method to ensure that a given directory exists.

ensureFileCreated(File) - Static method in class uk.ac.ed.ph.snuggletex.internal.util.IOUtilities

Simple method to ensure that a given File exists.

EnsureMathHandler - Class in uk.ac.ed.ph.snuggletex.dombuilding

This handles the \\ensuremath command.

EnsureMathHandler() - Constructor for class uk.ac.ed.ph.snuggletex.dombuilding.EnsureMathHandler

ensureMathMLContainer(Element) - Static method in class uk.ac.ed.ph.snuggletex.utilities.MathMLUtilities

ensureMathMLDocument(Document) - Static method in class uk.ac.ed.ph.snuggletex.utilities.MathMLUtilities

Checks that the given DOM Document contains a single MathML math Element.

ensureNotNull(Object) - Static method in class uk.ac.ed.ph.snuggletex.internal.util.ConstraintUtilities

ensureNotNull(Object, String) - Static method in class uk.ac.ed.ph.snuggletex.internal.util.ConstraintUtilities

Checks that the given object is non-null, throwing an IllegalArgumentException if the check fails.

ensureSharesDocumentWith(FrozenSlice) - Method in class uk.ac.ed.ph.snuggletex.internal.FrozenSlice

ENV_BRACKETED - Static variable in class uk.ac.ed.ph.snuggletex.definitions.CorePackageDefinitions

ENV_DISPLAYMATH - Static variable in class uk.ac.ed.ph.snuggletex.definitions.CorePackageDefinitions

ENV_ENUMERATE - Static variable in class uk.ac.ed.ph.snuggletex.definitions.CorePackageDefinitions

ENV_ITEMIZE - Static variable in class uk.ac.ed.ph.snuggletex.definitions.CorePackageDefinitions

ENV_MATH - Static variable in class uk.ac.ed.ph.snuggletex.definitions.CorePackageDefinitions

ENV_STYLE - Static variable in class uk.ac.ed.ph.snuggletex.definitions.CorePackageDefinitions

ENV_VERBATIM - Static variable in class uk.ac.ed.ph.snuggletex.definitions.CorePackageDefinitions

Environment - Interface in uk.ac.ed.ph.snuggletex.definitions

Base interface for LaTeX environment, i.e. constructs defined like \\begin{environment} ...

EnvironmentHandler - Interface in uk.ac.ed.ph.snuggletex.dombuilding

Defines how a BuiltinEnvironment should append children to the outgoing DOM.

EnvironmentToken - Class in uk.ac.ed.ph.snuggletex.tokens

Represents a BuiltinEnvironment.

EnvironmentToken(FrozenSlice, LaTeXMode, BuiltinEnvironment, ArgumentContainerToken) - Constructor for class uk.ac.ed.ph.snuggletex.tokens.EnvironmentToken

EnvironmentToken(FrozenSlice, LaTeXMode, BuiltinEnvironment, ArgumentContainerToken, ArgumentContainerToken[], ArgumentContainerToken) - Constructor for class uk.ac.ed.ph.snuggletex.tokens.EnvironmentToken

EqnArrayHandler - Class in uk.ac.ed.ph.snuggletex.dombuilding

Handles the eqnarray* environment.

EqnArrayHandler() - Constructor for class uk.ac.ed.ph.snuggletex.dombuilding.EqnArrayHandler

ErrorCode - Interface in uk.ac.ed.ph.snuggletex

Interface representing a code for an Error caused by client input.

ErrorGroup - Interface in uk.ac.ed.ph.snuggletex

Interface representing a grouping for a set of related ErrorCodes.

ErrorToken - Class in uk.ac.ed.ph.snuggletex.tokens

Special token encapsulating a client error in parsing.

ErrorToken(InputError, LaTeXMode) - Constructor for class uk.ac.ed.ph.snuggletex.tokens.ErrorToken

evaluateStyles(RootToken) - Method in class uk.ac.ed.ph.snuggletex.internal.StyleEvaluator

execute() - Method in class uk.ac.ed.ph.snuggletex.samples.CommandLineRunner

extract() - Method in interface uk.ac.ed.ph.snuggletex.InputContext

Extracts a copy of the current entire content of the input as a CharSequence

extract(int, int) - Method in interface uk.ac.ed.ph.snuggletex.InputContext

Extracts a copy of a slice of the current entire content of the input as a CharSequence, including all characters with startIndex <= index < endIndex.

extract() - Method in class uk.ac.ed.ph.snuggletex.internal.FrozenSlice

extract() - Method in class uk.ac.ed.ph.snuggletex.internal.WorkingDocument

extract(int, int) - Method in class uk.ac.ed.ph.snuggletex.internal.WorkingDocument

EXTRACT_CHILD_NODES_XSL_RESOURCE_NAME - Static variable in class uk.ac.ed.ph.snuggletex.definitions.Globals

Specifies the ClassPath location of the Stylesheet used by XMLUtilities.serializeNodeChildren(uk.ac.ed.ph.snuggletex.utilities.StylesheetManager, org.w3c.dom.Node, SerializationSpecifier)

extractAnnotationString(Element, String) - Static method in class uk.ac.ed.ph.snuggletex.utilities.MathMLUtilities

Extracts the first textual annotation found having the given encoding attribute from the given MathML math element, if such an annotation is found.

extractAnnotationXML(Element, String) - Static method in class uk.ac.ed.ph.snuggletex.utilities.MathMLUtilities

Extracts the first XML-based annotation having the given encoding attribute from the given MathML math element, if such an annotation is found.

extractFirstSemanticsBranch(Element) - Static method in class uk.ac.ed.ph.snuggletex.utilities.MathMLUtilities

extractNodeListValue(ArgumentContainerToken) - Method in class uk.ac.ed.ph.snuggletex.internal.DOMBuilder

extractSnuggleTeXAnnotation(Element) - Static method in class uk.ac.ed.ph.snuggletex.utilities.SnuggleUtilities

Extracts a SnuggleTeX annotation from a MathML math element, if found.

extractStringValue(ArgumentContainerToken) - Method in class uk.ac.ed.ph.snuggletex.internal.DOMBuilder

This "converts" the given token to a String by performing {DOMBuilder.handleTokens(Element, ArgumentContainerToken, boolean)} with a fake root element and then extracting the String value of the resulting Text Node(s).

extractTextElementValue(Element) - Static method in class uk.ac.ed.ph.snuggletex.internal.util.XMLUtilities

Trivial convenience method to extract the value of a (text) Element, coping with the possibility that text child Nodes may not have been coalesced.

F

findNearestXHTMLAncestorOrSelf(Element) - Method in class uk.ac.ed.ph.snuggletex.internal.DOMBuilder

fixTokenTree(RootToken) - Method in class uk.ac.ed.ph.snuggletex.internal.TokenFixer

FlowToken - Class in uk.ac.ed.ph.snuggletex.tokens

Base class for Tokens which represent the main "flow" of content, rather than things like command arguments.

FlowToken(FrozenSlice, TokenType, LaTeXMode, TextFlowContext, Interpretation...) - Constructor for class uk.ac.ed.ph.snuggletex.tokens.FlowToken

FlowToken(FrozenSlice, TokenType, LaTeXMode, TextFlowContext, EnumMap<InterpretationType, Interpretation>) - Constructor for class uk.ac.ed.ph.snuggletex.tokens.FlowToken

formatErrorAsString(InputError) - Static method in class uk.ac.ed.ph.snuggletex.utilities.MessageFormatter

Creates a full diagnosis of the given error

formatErrorAsXHTML(Document, InputError) - Static method in class uk.ac.ed.ph.snuggletex.utilities.MessageFormatter

formatErrorAsXML(Document, InputError, boolean) - Static method in class uk.ac.ed.ph.snuggletex.utilities.MessageFormatter

Creates a DOM Element containing information about the given error, including either just the ErrorCode or full details.

formatErrorAsXML(Document, DOMOutputOptions, InputError, boolean) - Static method in class uk.ac.ed.ph.snuggletex.utilities.MessageFormatter

Creates a DOM Element containing information about the given error, including either just the ErrorCode or full details.

formatErrorCodeName(ErrorCode) - Static method in class uk.ac.ed.ph.snuggletex.utilities.MessageFormatter

formatErrorGroup(ErrorGroup) - Static method in class uk.ac.ed.ph.snuggletex.utilities.MessageFormatter

foundTerminator - Variable in class uk.ac.ed.ph.snuggletex.internal.LaTeXTokeniser.ModeState

If terminator is not null, then this indicates whether the terminator was found when parsing in this mode ended.

FRAKTUR - Static variable in interface uk.ac.ed.ph.snuggletex.definitions.MathVariantMaps

These are defined from the Fraktur characters page, omitting those in Unicode plane 1.

freezeSlice(int, int) - Method in class uk.ac.ed.ph.snuggletex.internal.WorkingDocument

fromBinaryValues(String, String, String) - Static method in class uk.ac.ed.ph.snuggletex.internal.util.StringUtilities

Converts the given String argument to a boolean using the scheme trueValue => true, falseValue => false.

fromTrueFalse(String) - Static method in class uk.ac.ed.ph.snuggletex.internal.util.StringUtilities

Converts the given String argument to a boolean using the scheme "true"=>true, "false"=>false.

fromYesNo(String) - Static method in class uk.ac.ed.ph.snuggletex.internal.util.StringUtilities

Converts the given String argument to a boolean using the scheme "yes"=>true, "no"=>false.

FrozenSlice - Class in uk.ac.ed.ph.snuggletex.internal

Represents a finished "segment" of text in the WorkingDocument.

FrozenSlice(WorkingDocument, int, int) - Constructor for class uk.ac.ed.ph.snuggletex.internal.FrozenSlice

G

GENERAL_MESSAGE_BUNDLE - Static variable in class uk.ac.ed.ph.snuggletex.utilities.MessageFormatter

ResourceBundle providing templates for message bodies

GENERAL_MESSAGES_PROPERTIES_BASENAME - Static variable in class uk.ac.ed.ph.snuggletex.definitions.Globals

getAccentedChar(char) - Method in class uk.ac.ed.ph.snuggletex.definitions.MathVariantMap

getAccentedMathChar(int) - Method in class uk.ac.ed.ph.snuggletex.definitions.AccentMap

getAccentedTextChar(int) - Method in class uk.ac.ed.ph.snuggletex.definitions.AccentMap

getArgumentCount() - Method in interface uk.ac.ed.ph.snuggletex.definitions.CommandOrEnvironment

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

getArgumentCount() - Method in class uk.ac.ed.ph.snuggletex.definitions.UserDefinedCommandOrEnvironment

getArgumentMode(int) - Method in class uk.ac.ed.ph.snuggletex.definitions.BuiltinCommand

getArgumentMode(int) - Method in class uk.ac.ed.ph.snuggletex.definitions.BuiltinEnvironment

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

getArgumentMode(int) - Method in interface uk.ac.ed.ph.snuggletex.definitions.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.

getArgumentMode(int) - Method in class uk.ac.ed.ph.snuggletex.definitions.UserDefinedCommandOrEnvironment

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

getArguments() - Method in class uk.ac.ed.ph.snuggletex.InputError

Returns any additional arguments providing information about the error.

getArguments() - Method in class uk.ac.ed.ph.snuggletex.tokens.CommandToken

getArguments() - Method in class uk.ac.ed.ph.snuggletex.tokens.EnvironmentToken

getBeginDefinitionSlice() - Method in class uk.ac.ed.ph.snuggletex.definitions.UserDefinedEnvironment

getBracketType() - Method in class uk.ac.ed.ph.snuggletex.semantics.MathBracketInterpretation

getBuiltinCommandByTeXName(String) - Method in interface uk.ac.ed.ph.snuggletex.internal.SessionContext

getBuiltinCommandByTeXName(String) - Method in class uk.ac.ed.ph.snuggletex.SnuggleEngine

Returns the BuiltinCommand corresponding to LaTeX command called \texName, or null if this command is not defined.

getBuiltinCommandByTeXName(String) - Method in class uk.ac.ed.ph.snuggletex.SnugglePackage

Returns the BuiltinCommand corresponding to LaTeX command called \texName defined by this package, or null if this command is not defined.

getBuiltinCommandByTeXName(String) - Method in class uk.ac.ed.ph.snuggletex.SnuggleSession

Returns the BuiltinCommand corresponding to LaTeX command called \texName, or null if this command is not defined.

getBuiltinCommandMap() - Method in class uk.ac.ed.ph.snuggletex.SnugglePackage

Returns a read-only Map of all BuiltinCommands defined in this package, keyed on the name texName of the command (\texName).

getBuiltinEnvironmentByTeXName(String) - Method in interface uk.ac.ed.ph.snuggletex.internal.SessionContext

getBuiltinEnvironmentByTeXName(String) - Method in class uk.ac.ed.ph.snuggletex.SnuggleEngine

Returns the BuiltinEnvironment corresponding to LaTeX environment called texName, or null if this environment is not defined.

getBuiltinEnvironmentByTeXName(String) - Method in class uk.ac.ed.ph.snuggletex.SnugglePackage

Returns the BuiltinEnvironment corresponding to LaTeX environment called texName defined by this package, or null if this environment is not defined.

getBuiltinEnvironmentByTeXName(String) - Method in class uk.ac.ed.ph.snuggletex.SnuggleSession

Returns the BuiltinEnvironment corresponding to LaTeX environment called texName, or null if this environment is not defined.

getBuiltinEnvironmentMap() - Method in class uk.ac.ed.ph.snuggletex.SnugglePackage

Returns a read-only Map of all BuiltinEnvironments defined in this package, keyed on the name of the environment.

getChars() - Method in class uk.ac.ed.ph.snuggletex.definitions.MathCharacter

getClientSideXSLTStylesheetURLs() - Method in class uk.ac.ed.ph.snuggletex.WebPageOutputOptions

Returns specified array of relative URLs specifying client-side XSLT stylesheets to be referenced in the resulting page.

getCodePoint() - Method in class uk.ac.ed.ph.snuggletex.definitions.MathCharacter

getCombinerTarget() - Method in class uk.ac.ed.ph.snuggletex.tokens.CommandToken

getCombinerTargetMatcher() - Method in class uk.ac.ed.ph.snuggletex.definitions.BuiltinCommand

getCommand() - Method in class uk.ac.ed.ph.snuggletex.tokens.CommandToken

getCompiledStylesheet(String) - Method in class uk.ac.ed.ph.snuggletex.utilities.StylesheetManager

Obtains the XSLT stylesheet at the given ClassPathURI, using the StylesheetCache (if set) to cache stylesheets for efficiency.

getCompiledStylesheet(String, boolean) - Method in class uk.ac.ed.ph.snuggletex.utilities.StylesheetManager

Obtains the XSLT stylesheet at the given ClassPathURI, using the StylesheetCache (if set) to cache stylesheets for efficiency.

getCompiledStylesheetDriver(List<String>, boolean) - Method in class uk.ac.ed.ph.snuggletex.utilities.StylesheetManager

Obtains a "driver" XSLT stylesheet that imports the stylesheets having the given ClassPath URIs, using the StylesheetCache (if set) to cache the resulting driver for efficiency.

getComputedStyle() - Method in class uk.ac.ed.ph.snuggletex.tokens.Token

getConfiguration() - Method in interface uk.ac.ed.ph.snuggletex.internal.SessionContext

getConfiguration() - Method in class uk.ac.ed.ph.snuggletex.SnuggleSession

getContent() - Method in class uk.ac.ed.ph.snuggletex.tokens.EnvironmentToken

getContentMode() - Method in class uk.ac.ed.ph.snuggletex.definitions.BuiltinEnvironment

getContentMode() - Method in interface uk.ac.ed.ph.snuggletex.definitions.Environment

Specifies which mode to parse content in.

getContentMode() - Method in class uk.ac.ed.ph.snuggletex.definitions.UserDefinedEnvironment

Use existing content mode

getContents() - Method in class uk.ac.ed.ph.snuggletex.tokens.ArgumentContainerToken

getContents() - Method in class uk.ac.ed.ph.snuggletex.tokens.BraceContainerToken

getContents() - Method in class uk.ac.ed.ph.snuggletex.tokens.RootToken

getContentType() - Method in class uk.ac.ed.ph.snuggletex.WebPageOutputOptions

Returns the MIME type for the resulting page.

getCSSStylesheetURLs() - Method in class uk.ac.ed.ph.snuggletex.WebPageOutputOptions

Returns specified array of relative URLs specifying client-side CSS stylesheets to be referenced in the resulting page.

getCustomMathJaxUrl() - Method in class uk.ac.ed.ph.snuggletex.WebPageOutputOptions

getDecimalFormat() - Method in class uk.ac.ed.ph.snuggletex.DecimalFormatNumberMatcher

getDefaultDOMOptions() - Method in class uk.ac.ed.ph.snuggletex.SnuggleEngine

Deprecated.

Use SnuggleEngine.getDefaultDOMOutputOptions()

getDefaultDOMOutputOptions() - Method in class uk.ac.ed.ph.snuggletex.SnuggleEngine

Gets the default DOMOutputOptions for this SnuggleEngine, which will not be null.

getDefaultSessionConfiguration() - Method in class uk.ac.ed.ph.snuggletex.SnuggleEngine

Gets the selected default SessionConfiguration for this SnuggleEngine, which will not be null.

getDefaultXMLStringOutputOptions() - Method in class uk.ac.ed.ph.snuggletex.SnuggleEngine

Gets the default XMLStringOutputOptions for this SnuggleEngine, which will not be null.

getDefinitionSlice() - Method in class uk.ac.ed.ph.snuggletex.definitions.UserDefinedCommand

getDoctypePublic() - Method in interface uk.ac.ed.ph.snuggletex.SerializationSpecifier

Gets the public identifier to use in the resulting DOCTYPE declaration, as described in OutputKeys.DOCTYPE_PUBLIC.

getDoctypePublic() - Method in class uk.ac.ed.ph.snuggletex.utilities.SerializationOptions

Gets the public identifier to use in the resulting DOCTYPE declaration, as described in OutputKeys.DOCTYPE_PUBLIC.

getDoctypePublic() - Method in class uk.ac.ed.ph.snuggletex.XMLStringOutputOptions

Gets the public identifier to use in the resulting DOCTYPE declaration, as described in OutputKeys.DOCTYPE_PUBLIC.

getDoctypeSystem() - Method in interface uk.ac.ed.ph.snuggletex.SerializationSpecifier

Gets the system identifier to use in the resulting DOCTYPE declaration, as described in OutputKeys.DOCTYPE_SYSTEM.

getDoctypeSystem() - Method in class uk.ac.ed.ph.snuggletex.utilities.SerializationOptions

Gets the system identifier to use in the resulting DOCTYPE declaration, as described in OutputKeys.DOCTYPE_SYSTEM.

getDoctypeSystem() - Method in class uk.ac.ed.ph.snuggletex.XMLStringOutputOptions

Gets the system identifier to use in the resulting DOCTYPE declaration, as described in OutputKeys.DOCTYPE_SYSTEM.

getDocument() - Method in class uk.ac.ed.ph.snuggletex.internal.DOMBuilder

Gets at the underlying DOM Document.

getDocument() - Method in class uk.ac.ed.ph.snuggletex.internal.FrozenSlice

getDOMPostProcessors() - Method in class uk.ac.ed.ph.snuggletex.DOMOutputOptions

Returns the array of DOMPostProcessor that will be called in turn to "fix up" or modify the raw DOM produced by SnuggleTeX immediately after it has been built.

getEncoding() - Method in interface uk.ac.ed.ph.snuggletex.SerializationSpecifier

Gets the encoding for the resulting serialized XML.

getEncoding() - Method in class uk.ac.ed.ph.snuggletex.SnuggleInput

getEncoding() - Method in class uk.ac.ed.ph.snuggletex.utilities.SerializationOptions

Gets the encoding for the resulting serialized XML.

getEncoding() - Method in class uk.ac.ed.ph.snuggletex.XMLStringOutputOptions

Gets the encoding for the resulting serialized XML.

getEndDefinitionSlice() - Method in class uk.ac.ed.ph.snuggletex.definitions.UserDefinedEnvironment

getEndIndex() - Method in class uk.ac.ed.ph.snuggletex.internal.FrozenSlice

getEnvironment() - Method in class uk.ac.ed.ph.snuggletex.tokens.EnvironmentToken

getError() - Method in exception uk.ac.ed.ph.snuggletex.internal.SnuggleParseException

getError() - Method in class uk.ac.ed.ph.snuggletex.tokens.ErrorToken

getErrorCode() - Method in class uk.ac.ed.ph.snuggletex.InputError

Returns the ErrorCode for this error.

getErrorCodes(ErrorGroup) - Method in class uk.ac.ed.ph.snuggletex.SnugglePackage

Returns an unmodifiable view of the ErrorCodes corresponding to the given ErrorGroup.

getErrorGroup() - Method in enum uk.ac.ed.ph.snuggletex.definitions.CoreErrorCode

getErrorGroup() - Method in interface uk.ac.ed.ph.snuggletex.ErrorCode

ErrorGroup owning this code

getErrorGroups() - Method in class uk.ac.ed.ph.snuggletex.SnugglePackage

Returns an unmodifiable view of all of the ErrorGroups declared for this package.

getErrorMessage(InputError) - Static method in class uk.ac.ed.ph.snuggletex.utilities.MessageFormatter

Constructs an error message for the given InputError.

getErrorMessage(ErrorCode, Object...) - Static method in class uk.ac.ed.ph.snuggletex.utilities.MessageFormatter

Constructs an error message for the given ErrorCode and arguments.

getErrorMessageBundle() - Method in class uk.ac.ed.ph.snuggletex.SnugglePackage

Returns the ResourceBundle used to format error messages.

getErrorOutputOptions() - Method in class uk.ac.ed.ph.snuggletex.DOMOutputOptions

Gets the current DOMOutputOptions.ErrorOutputOptions, specifying how (and whether) error details should be embedded into the resulting XML.

getErrors() - Method in interface uk.ac.ed.ph.snuggletex.internal.SessionContext

getErrors() - Method in class uk.ac.ed.ph.snuggletex.SnuggleSession

getExpansionLimit() - Method in class uk.ac.ed.ph.snuggletex.SessionConfiguration

Gets the maximum depth when expanding out user-defined commands and environments.

getFile() - Method in class uk.ac.ed.ph.snuggletex.SnuggleInput

Returns the File that provided this input if type is SnuggleInput.InputType.FILE, null otherwise.

getFirstBranch() - Method in class uk.ac.ed.ph.snuggletex.utilities.UnwrappedParallelMathMLDOM

Returns the first branch of the top <semantics/> element.

getFontFamily() - Method in class uk.ac.ed.ph.snuggletex.definitions.ComputedStyle

getFontFamily() - Method in enum uk.ac.ed.ph.snuggletex.semantics.StyleDeclarationInterpretation

getFontSize() - Method in class uk.ac.ed.ph.snuggletex.definitions.ComputedStyle

getFontSize() - Method in enum uk.ac.ed.ph.snuggletex.semantics.StyleDeclarationInterpretation

getIdentifier() - Method in class uk.ac.ed.ph.snuggletex.SnuggleInput

Returns the "identifier" for this input.

getIndent() - Method in interface uk.ac.ed.ph.snuggletex.SerializationSpecifier

Returns the indentation level to use when SerializationSpecifier.isIndenting() returns true.

getIndent() - Method in class uk.ac.ed.ph.snuggletex.utilities.SerializationOptions

Returns the indentation level to use when SerializationOptions.isIndenting() returns true.

getIndent() - Method in class uk.ac.ed.ph.snuggletex.XMLStringOutputOptions

Returns the indentation level to use when XMLStringOutputOptions.isIndenting() returns true.

getIndentWidth() - Method in class uk.ac.ed.ph.snuggletex.internal.util.ObjectDumper

getIndentWidth() - Method in class uk.ac.ed.ph.snuggletex.utilities.LaTeXIndenter

getInlineCSSProperties() - Method in class uk.ac.ed.ph.snuggletex.DOMOutputOptions

Gets the Properties Object that will be used to determine inline CSS properties, if used.

getInput() - Method in interface uk.ac.ed.ph.snuggletex.InputContext

Accesses the underlying SnuggleInput

getInput() - Method in class uk.ac.ed.ph.snuggletex.internal.SnuggleInputReader

getInput() - Method in class uk.ac.ed.ph.snuggletex.internal.WorkingDocument

getInputCommandName() - Method in class uk.ac.ed.ph.snuggletex.definitions.MathCharacter

getInputStream() - Method in class uk.ac.ed.ph.snuggletex.SnuggleInput

Returns the InputStream that provided this input if type is SnuggleInput.InputType.INPUT_STREAM, null otherwise.

getInstance() - Static method in class uk.ac.ed.ph.snuggletex.utilities.ClassPathURIResolver

getInstance() - Static method in class uk.ac.ed.ph.snuggletex.utilities.DefaultTransformerFactoryChooser

getInstance() - Static method in class uk.ac.ed.ph.snuggletex.utilities.SaxonTransformerFactoryChooser

getInterpretation(InterpretationType) - Method in class uk.ac.ed.ph.snuggletex.tokens.Token

getInterpretationMap() - Method in class uk.ac.ed.ph.snuggletex.definitions.MathCharacter

getInterpretationMap() - Method in class uk.ac.ed.ph.snuggletex.tokens.Token

getLang() - Method in class uk.ac.ed.ph.snuggletex.WebPageOutputOptions

Returns the language of the resulting page, null if not set.

getLastErrors() - Method in class uk.ac.ed.ph.snuggletex.SnuggleSimpleMathRunner

getLatexMode() - Method in class uk.ac.ed.ph.snuggletex.tokens.Token

getLineAndColumn(int) - Method in class uk.ac.ed.ph.snuggletex.internal.SnuggleInputReader

getLinkResolver() - Method in class uk.ac.ed.ph.snuggletex.DOMOutputOptions

Gets the currently specified "link resolver" which can fix up any XHTML links created by certain LaTeX inputs.

getMathCharacter() - Method in class uk.ac.ed.ph.snuggletex.definitions.BuiltinCommand

getMathCharacter(int) - Method in interface uk.ac.ed.ph.snuggletex.internal.SessionContext

getMathCharacter() - Method in class uk.ac.ed.ph.snuggletex.semantics.MathCharacterInterpretation

getMathCharacter(int) - Method in class uk.ac.ed.ph.snuggletex.SnugglePackage

Returns the MathCharacter corresponding to the Unicode character at the given input codePoint, or null if no MathCharacter is defined for this codepoint.

getMathCharacter(int) - Method in class uk.ac.ed.ph.snuggletex.SnuggleSession

getMathCharacter() - Method in class uk.ac.ed.ph.snuggletex.tokens.MathCharacterToken

getMathCharacter() - Method in class uk.ac.ed.ph.snuggletex.tokens.Token

getMathCharacterCodePoint() - Method in class uk.ac.ed.ph.snuggletex.definitions.BuiltinCommand

getMathCharacterCodePoint() - Method in class uk.ac.ed.ph.snuggletex.tokens.Token

getMathCharacterInterpretation() - Method in class uk.ac.ed.ph.snuggletex.definitions.MathCharacter

getMathCharacterMap() - Method in class uk.ac.ed.ph.snuggletex.SnugglePackage

Returns a read-only Map of all MathCharacters defined in this package, keyed on input Unicode code point.

getMathElement() - Method in class uk.ac.ed.ph.snuggletex.utilities.UnwrappedParallelMathMLDOM

Returns the containing <math/> element

getMathMLOperatorContent() - Method in class uk.ac.ed.ph.snuggletex.semantics.MathOperatorInterpretation

getMathMLPrefix() - Method in class uk.ac.ed.ph.snuggletex.DOMOutputOptions

Gets the prefix to use for MathML elements when DOMOutputOptions.isPrefixingMathML() returns true.

getMathPrefRenderer() - Method in class uk.ac.ed.ph.snuggletex.WebPageOutputOptions

Gets the value of the optional pref:renderer attribute (in the W3CConstants.MATHML_PREF_NAMESPACE) that can be added to the HTML root element to control certain aspects of the client-side Universal StyleSheets for MathML The default is null, indicating that no attribute will be added

getMathVariantMapStack() - Method in class uk.ac.ed.ph.snuggletex.internal.DOMBuilder

getMathVariantName() - Method in class uk.ac.ed.ph.snuggletex.definitions.MathVariantMap

getMaxDepth() - Method in class uk.ac.ed.ph.snuggletex.internal.util.ObjectDumper

getMaxIndentLevel() - Method in class uk.ac.ed.ph.snuggletex.utilities.LaTeXIndenter

getMfencedAttributeCharacter() - Method in class uk.ac.ed.ph.snuggletex.semantics.MathBracketInterpretation

getName() - Method in enum uk.ac.ed.ph.snuggletex.definitions.CoreErrorCode

getName() - Method in enum uk.ac.ed.ph.snuggletex.definitions.CoreErrorGroup

getName() - Method in interface uk.ac.ed.ph.snuggletex.ErrorCode

Short name for this code, used as a key when formatting error messages via SnugglePackage.getErrorMessageBundle()

getName() - Method in interface uk.ac.ed.ph.snuggletex.ErrorGroup

Short name for this group, used as a key when formatting error messages via SnugglePackage.getErrorMessageBundle()

getName() - Method in class uk.ac.ed.ph.snuggletex.semantics.MathFunctionInterpretation

getName() - Method in class uk.ac.ed.ph.snuggletex.semantics.MathIdentifierInterpretation

getName() - Method in enum uk.ac.ed.ph.snuggletex.SerializationMethod

getName() - Method in class uk.ac.ed.ph.snuggletex.SnugglePackage

Returns the name for this package.

getNegatedCharacter() - Method in class uk.ac.ed.ph.snuggletex.semantics.MathNegatableInterpretation

getNumber() - Method in class uk.ac.ed.ph.snuggletex.semantics.MathNumberInterpretation

getNumberEnd(InputContext, int) - Method in class uk.ac.ed.ph.snuggletex.DecimalFormatNumberMatcher

getNumberEnd(InputContext, int) - Method in interface uk.ac.ed.ph.snuggletex.NumberMatcher

Implementations should analyse the given InputContext starting at the given index to see if it looks like an (unsigned) number.

getNumberEnd(InputContext, int) - Method in class uk.ac.ed.ph.snuggletex.SimpleNumberMatcher

getNumberMatcher() - Method in class uk.ac.ed.ph.snuggletex.SessionConfiguration

Gets the NumberMatcher used to identify numbers in Math mode input.

getOptionalArgument() - Method in class uk.ac.ed.ph.snuggletex.definitions.UserDefinedCommandOrEnvironment

getOptionalArgument() - Method in class uk.ac.ed.ph.snuggletex.tokens.CommandToken

getOptionalArgument() - Method in class uk.ac.ed.ph.snuggletex.tokens.EnvironmentToken

getOptions() - Method in class uk.ac.ed.ph.snuggletex.internal.DOMBuilder

getOutputContext() - Method in class uk.ac.ed.ph.snuggletex.internal.DOMBuilder

getPackage() - Method in enum uk.ac.ed.ph.snuggletex.definitions.CoreErrorGroup

getPackage() - Static method in class uk.ac.ed.ph.snuggletex.definitions.CorePackageDefinitions

getPackage() - Method in interface uk.ac.ed.ph.snuggletex.ErrorGroup

SnugglePackage defining this group

getPackages() - Method in class uk.ac.ed.ph.snuggletex.SnuggleEngine

Returns a synchronized List of all SnugglePackages registered with this engine.

getParentStyle() - Method in class uk.ac.ed.ph.snuggletex.definitions.ComputedStyle

getParsedTokens() - Method in class uk.ac.ed.ph.snuggletex.SnuggleSession

getReader() - Method in class uk.ac.ed.ph.snuggletex.SnuggleInput

Returns the Reader that provided this input if type is SnuggleInput.InputType.READER, null otherwise.

getSaxonTransformerFactory() - Method in class uk.ac.ed.ph.snuggletex.utilities.SaxonTransformerFactoryChooser

getSerializationMethod() - Method in interface uk.ac.ed.ph.snuggletex.SerializationSpecifier

Gets the SerializationMethod to use when generating the final output.

getSerializationMethod() - Method in class uk.ac.ed.ph.snuggletex.utilities.SerializationOptions

Gets the SerializationMethod to use when generating the final output.

getSerializationMethod() - Method in class uk.ac.ed.ph.snuggletex.XMLStringOutputOptions

Gets the SerializationMethod to use when generating the final output.

getSerializer(String, SerializationSpecifier) - Method in class uk.ac.ed.ph.snuggletex.utilities.StylesheetManager

Obtains a serializer stylesheet based on the stylesheet at the given URI, configured as per the given SerializationSpecifier.

getSessionContext() - Method in class uk.ac.ed.ph.snuggletex.internal.DOMBuilder

getSessionContext() - Method in class uk.ac.ed.ph.snuggletex.internal.SnuggleInputReader

getSlice() - Method in class uk.ac.ed.ph.snuggletex.InputError

Returns the FrozenSlice indicating where the error occurred in the original SnuggleInput.

getSlice() - Method in class uk.ac.ed.ph.snuggletex.tokens.Token

getSnuggleXMLPrefix() - Method in class uk.ac.ed.ph.snuggletex.DOMOutputOptions

Gets the prefix to use for custom SnuggleTeX XML elements when DOMOutputOptions.isPrefixingSnuggleXML() returns true.

getStartIndex() - Method in class uk.ac.ed.ph.snuggletex.internal.FrozenSlice

getString() - Method in class uk.ac.ed.ph.snuggletex.SnuggleInput

Returns the String that provided this input if type is SnuggleInput.InputType.STRING, null otherwise.

getStylesheet(String) - Method in class uk.ac.ed.ph.snuggletex.utilities.DoNothingStylesheetCache

getStylesheet(String) - Method in class uk.ac.ed.ph.snuggletex.utilities.SimpleStylesheetCache

getStylesheet(String) - Method in interface uk.ac.ed.ph.snuggletex.utilities.StylesheetCache

Tries to retrieve an XSLT stylesheet from the cache having the given key.

getStylesheetCache() - Method in class uk.ac.ed.ph.snuggletex.utilities.StylesheetManager

Returns the current StylesheetCache for this manager, which may be null.

getStylesheetManager() - Method in interface uk.ac.ed.ph.snuggletex.internal.SessionContext

getStylesheetManager() - Method in class uk.ac.ed.ph.snuggletex.SnuggleEngine

Convenience method to extract the underlying StylesheetManager used by this engine.

getStylesheetManager() - Method in class uk.ac.ed.ph.snuggletex.SnuggleSession

Gets the StylesheetManager being used by the underlying SnuggleEngine

getStylesheets() - Method in class uk.ac.ed.ph.snuggletex.WebPageOutputOptions

Returns an array of specified JAXP Transformers representing XSLT stylesheet(s) that will be applied to the resulting web page once it has been built but before it is serialised.

getSubstitutionDepth(int) - Method in class uk.ac.ed.ph.snuggletex.internal.WorkingDocument

getSuitableXSLT10TransformerFactory() - Method in class uk.ac.ed.ph.snuggletex.utilities.DefaultTransformerFactoryChooser

getSuitableXSLT10TransformerFactory() - Method in class uk.ac.ed.ph.snuggletex.utilities.SaxonTransformerFactoryChooser

getSuitableXSLT10TransformerFactory() - Method in interface uk.ac.ed.ph.snuggletex.utilities.TransformerFactoryChooser

Implementors of this interface should return an XSLT 1.0-compatible TransformerFactory that SnuggleTeX is free to mess around with and is capable of handling DOMSource and DOMResults.

getSuitableXSLT20TransformerFactory() - Method in class uk.ac.ed.ph.snuggletex.utilities.DefaultTransformerFactoryChooser

getSuitableXSLT20TransformerFactory() - Method in class uk.ac.ed.ph.snuggletex.utilities.SaxonTransformerFactoryChooser

getSuitableXSLT20TransformerFactory() - Method in interface uk.ac.ed.ph.snuggletex.utilities.TransformerFactoryChooser

Implementors of this interface should return an XSLT 2.0-compatible TransformerFactory that SnuggleTeX is free to mess around with and is capable of handling DOMSource and DOMResults.

getTargetBlockCSSClassName() - Method in enum uk.ac.ed.ph.snuggletex.definitions.ComputedStyle.FontFamily

getTargetBlockXHTMLElementName() - Method in enum uk.ac.ed.ph.snuggletex.definitions.ComputedStyle.FontFamily

getTargetCSSClassName() - Method in enum uk.ac.ed.ph.snuggletex.definitions.ComputedStyle.FontSize

getTargetInlineCSSClassName() - Method in enum uk.ac.ed.ph.snuggletex.definitions.ComputedStyle.FontFamily

getTargetInlineXHTMLElementName() - Method in enum uk.ac.ed.ph.snuggletex.definitions.ComputedStyle.FontFamily

getTargetMathMLMathVariantName() - Method in enum uk.ac.ed.ph.snuggletex.definitions.ComputedStyle.FontFamily

getTeXName() - Method in interface uk.ac.ed.ph.snuggletex.definitions.CommandOrEnvironment

Returns the TeX name for this command or environment.

getTeXName() - Method in class uk.ac.ed.ph.snuggletex.definitions.UserDefinedCommandOrEnvironment

getTextAnnotations() - Method in class uk.ac.ed.ph.snuggletex.utilities.UnwrappedParallelMathMLDOM

Returns a Map of <annotation/> elements, keyed on the "encoding" attribute with the text content as values.

getTextFlowContext() - Method in class uk.ac.ed.ph.snuggletex.tokens.FlowToken

For Tokens appearing inside TEXT flow, this indicates how this Token should flow against its siblings.

getTitle() - Method in class uk.ac.ed.ph.snuggletex.WebPageOutputOptions

Returns the title for the resulting page, null if not set.

getTransformerFactory(boolean) - Method in class uk.ac.ed.ph.snuggletex.utilities.StylesheetManager

Uses the current TransformerFactoryChooser to obtain a TransformerFactory suitable for either XSLT 1.0 or XSLT 2.0 (as specified), and configured to use a ClassPathURIResolver to make it easy to find internal stylesheets.

getTransformerFactoryChooser() - Method in class uk.ac.ed.ph.snuggletex.utilities.StylesheetManager

Returns the current TransformerFactoryChooser for this StylesheetManager, which is used to initialise TransformerFactory instances.

getType() - Method in class uk.ac.ed.ph.snuggletex.definitions.BuiltinCommand

getType() - Method in class uk.ac.ed.ph.snuggletex.definitions.MathCharacter

getType() - Method in interface uk.ac.ed.ph.snuggletex.semantics.Interpretation

getType() - Method in class uk.ac.ed.ph.snuggletex.semantics.Interpretation.MarkerInterpretation

getType() - Method in class uk.ac.ed.ph.snuggletex.semantics.MathBigLimitOwnerInterpretation

getType() - Method in class uk.ac.ed.ph.snuggletex.semantics.MathBracketInterpretation

getType() - Method in class uk.ac.ed.ph.snuggletex.semantics.MathCharacterInterpretation

getType() - Method in class uk.ac.ed.ph.snuggletex.semantics.MathFunctionInterpretation

getType() - Method in class uk.ac.ed.ph.snuggletex.semantics.MathIdentifierInterpretation

getType() - Method in class uk.ac.ed.ph.snuggletex.semantics.MathNegatableInterpretation

getType() - Method in class uk.ac.ed.ph.snuggletex.semantics.MathNumberInterpretation

getType() - Method in class uk.ac.ed.ph.snuggletex.semantics.MathOperatorInterpretation

getType() - Method in enum uk.ac.ed.ph.snuggletex.semantics.StyleDeclarationInterpretation

getType() - Method in class uk.ac.ed.ph.snuggletex.SnuggleInput

Returns the "type" of input, represented by an instance of the SnuggleInput.InputType enumeration.

getType() - Method in class uk.ac.ed.ph.snuggletex.tokens.Token

getURI() - Method in class uk.ac.ed.ph.snuggletex.SnuggleInput

Returns an (optional) URI for this input.

getUserCommandMap() - Method in interface uk.ac.ed.ph.snuggletex.internal.SessionContext

getUserCommandMap() - Method in class uk.ac.ed.ph.snuggletex.SnuggleSession

Gets the Map of all user-defined commands created in this session.

getUserEnvironmentMap() - Method in interface uk.ac.ed.ph.snuggletex.internal.SessionContext

getUserEnvironmentMap() - Method in class uk.ac.ed.ph.snuggletex.SnuggleSession

Gets the Map of all user-defined environments created in this session.

GetVarHandler - Class in uk.ac.ed.ph.snuggletex.dombuilding

Handles the \\getvar macro.

GetVarHandler() - Constructor for class uk.ac.ed.ph.snuggletex.dombuilding.GetVarHandler

getVariable(String, String) - Method in class uk.ac.ed.ph.snuggletex.internal.VariableManager

getVariableManager() - Method in class uk.ac.ed.ph.snuggletex.internal.DOMBuilder

getVariableMapForNamespace(String) - Method in class uk.ac.ed.ph.snuggletex.internal.VariableManager

getWebPageType() - Method in class uk.ac.ed.ph.snuggletex.WebPageOutputOptions

Deprecated.

Use various methods in WebPageOutputOptionsBuilder to generate suitable options for various types of pages, which you can then tweak.

getWorkingDocument() - Method in class uk.ac.ed.ph.snuggletex.tokens.RootToken

getXHTMLPrefix() - Method in class uk.ac.ed.ph.snuggletex.DOMOutputOptions

Gets the prefix to use for XHTML elements when DOMOutputOptions.isPrefixingXHTML() returns true.

getXmlAnnotations() - Method in class uk.ac.ed.ph.snuggletex.utilities.UnwrappedParallelMathMLDOM

Returns a Map of <annotation-xml/> elements, keyed on the "encoding" attribute with the NodeList content as values.

Globals - Class in uk.ac.ed.ph.snuggletex.definitions

Lists various useful (but internal) constants and helper methods.

Globals() - Constructor for class uk.ac.ed.ph.snuggletex.definitions.Globals

GRAVE - Static variable in interface uk.ac.ed.ph.snuggletex.definitions.AccentMaps

H

handleCommand(DOMBuilder, Element, CommandToken) - Method in class uk.ac.ed.ph.snuggletex.dombuilding.AbstractCustomXMLElementHandler

handleCommand(DOMBuilder, Element, CommandToken) - Method in class uk.ac.ed.ph.snuggletex.dombuilding.AccentHandler

handleCommand(DOMBuilder, Element, CommandToken) - Method in class uk.ac.ed.ph.snuggletex.dombuilding.AnchorHandler

handleCommand(DOMBuilder, Element, CommandToken) - Method in class uk.ac.ed.ph.snuggletex.dombuilding.BoxHandler

handleCommand(DOMBuilder, Element, CommandToken) - Method in class uk.ac.ed.ph.snuggletex.dombuilding.CharacterCommandHandler

handleCommand(DOMBuilder, Element, CommandToken) - Method in interface uk.ac.ed.ph.snuggletex.dombuilding.CommandHandler

Called when a CommandToken is being handled by the DOMBuilder.

handleCommand(DOMBuilder, Element, CommandToken) - Method in class uk.ac.ed.ph.snuggletex.dombuilding.DoNothingHandler

handleCommand(DOMBuilder, Element, CommandToken) - Method in class uk.ac.ed.ph.snuggletex.dombuilding.EnsureMathHandler

handleCommand(DOMBuilder, Element, CommandToken) - Method in class uk.ac.ed.ph.snuggletex.dombuilding.GetVarHandler

handleCommand(DOMBuilder, Element, CommandToken) - Method in class uk.ac.ed.ph.snuggletex.dombuilding.HrefHandler

handleCommand(DOMBuilder, Element, CommandToken) - Method in class uk.ac.ed.ph.snuggletex.dombuilding.HSpaceHandler

handleCommand(DOMBuilder, Element, CommandToken) - Method in class uk.ac.ed.ph.snuggletex.dombuilding.InsertUnicodeHandler

handleCommand(DOMBuilder, Element, CommandToken) - Method in class uk.ac.ed.ph.snuggletex.dombuilding.InterpretableSimpleMathHandler

handleCommand(DOMBuilder, Element, CommandToken) - Method in class uk.ac.ed.ph.snuggletex.dombuilding.LineBreakHandler

handleCommand(DOMBuilder, Element, CommandToken) - Method in class uk.ac.ed.ph.snuggletex.dombuilding.ListEnvironmentHandler

handleCommand(DOMBuilder, Element, CommandToken) - Method in class uk.ac.ed.ph.snuggletex.dombuilding.LiteralHandler

handleCommand(DOMBuilder, Element, CommandToken) - Method in class uk.ac.ed.ph.snuggletex.dombuilding.MathComplexCommandHandler

handleCommand(DOMBuilder, Element, CommandToken) - Method in class uk.ac.ed.ph.snuggletex.dombuilding.MathLimitsHandler

handleCommand(DOMBuilder, Element, CommandToken) - Method in class uk.ac.ed.ph.snuggletex.dombuilding.MathNotHandler

handleCommand(DOMBuilder, Element, CommandToken) - Method in class uk.ac.ed.ph.snuggletex.dombuilding.MathRootHandler

handleCommand(DOMBuilder, Element, CommandToken) - Method in class uk.ac.ed.ph.snuggletex.dombuilding.MathUnderOrOverHandler

handleCommand(DOMBuilder, Element, CommandToken) - Method in class uk.ac.ed.ph.snuggletex.dombuilding.MathVariantMapHandler

handleCommand(DOMBuilder, Element, CommandToken) - Method in class uk.ac.ed.ph.snuggletex.dombuilding.ModeDelegatingHandler

handleCommand(DOMBuilder, Element, CommandToken) - Method in class uk.ac.ed.ph.snuggletex.dombuilding.MrowHandler

handleCommand(DOMBuilder, Element, CommandToken) - Method in class uk.ac.ed.ph.snuggletex.dombuilding.ParagraphHandler

handleCommand(DOMBuilder, Element, CommandToken) - Method in class uk.ac.ed.ph.snuggletex.dombuilding.SetVarHandler

handleCommand(DOMBuilder, Element, CommandToken) - Method in class uk.ac.ed.ph.snuggletex.dombuilding.SimpleXHTMLContainerBuildingHandler

handleCommand(DOMBuilder, Element, CommandToken) - Method in class uk.ac.ed.ph.snuggletex.dombuilding.SpaceHandler

handleCommand(DOMBuilder, Element, CommandToken) - Method in class uk.ac.ed.ph.snuggletex.dombuilding.TabularHandler

The command matched here is \\hline.

handleCommand(DOMBuilder, Element, CommandToken) - Method in class uk.ac.ed.ph.snuggletex.dombuilding.TagHandler

handleCommand(DOMBuilder, Element, CommandToken) - Method in class uk.ac.ed.ph.snuggletex.dombuilding.TextClassHandler

handleCommand(DOMBuilder, Element, CommandToken) - Method in class uk.ac.ed.ph.snuggletex.dombuilding.TextHandler

handleCommand(DOMBuilder, Element, CommandToken) - Method in class uk.ac.ed.ph.snuggletex.dombuilding.TextSafeInterpretableMathIdentifierHandler

handleCommand(DOMBuilder, Element, CommandToken) - Method in class uk.ac.ed.ph.snuggletex.dombuilding.UnitsHandler

handleCommand(DOMBuilder, Element, CommandToken) - Method in class uk.ac.ed.ph.snuggletex.dombuilding.VerbatimHandler

handleCommand(DOMBuilder, Element, CommandToken) - Method in class uk.ac.ed.ph.snuggletex.dombuilding.XMLAttrHandler

handleCommand(DOMBuilder, Element, CommandToken) - Method in class uk.ac.ed.ph.snuggletex.dombuilding.XMLNameOrIdHandler

handleCommand(DOMBuilder, Element, CommandToken) - Method in class uk.ac.ed.ph.snuggletex.dombuilding.XMLUnparseHandler

handleCommandMathMode(DOMBuilder, Element, CommandToken) - Method in class uk.ac.ed.ph.snuggletex.dombuilding.AccentHandler

Handles accents in MATH mode.

handleCommandTextMode(DOMBuilder, Element, CommandToken) - Method in class uk.ac.ed.ph.snuggletex.dombuilding.AccentHandler

LaTeX only adds an accent to the first character of the first token, and only if it is text.

handleContent(DOMBuilder, Element, ArgumentContainerToken) - Method in class uk.ac.ed.ph.snuggletex.dombuilding.SimpleXHTMLContainerBuildingHandler

handleEnvironment(DOMBuilder, Element, EnvironmentToken) - Method in class uk.ac.ed.ph.snuggletex.dombuilding.AbstractCustomXMLElementHandler

handleEnvironment(DOMBuilder, Element, EnvironmentToken) - Method in class uk.ac.ed.ph.snuggletex.dombuilding.AlignHandler

handleEnvironment(DOMBuilder, Element, EnvironmentToken) - Method in class uk.ac.ed.ph.snuggletex.dombuilding.ArrayHandler

handleEnvironment(DOMBuilder, Element, EnvironmentToken) - Method in class uk.ac.ed.ph.snuggletex.dombuilding.DoNothingHandler

handleEnvironment(DOMBuilder, Element, EnvironmentToken) - Method in interface uk.ac.ed.ph.snuggletex.dombuilding.EnvironmentHandler

Called when a CommandToken is being handled by the DOMBuilder.

handleEnvironment(DOMBuilder, Element, EnvironmentToken) - Method in class uk.ac.ed.ph.snuggletex.dombuilding.EqnArrayHandler

handleEnvironment(DOMBuilder, Element, EnvironmentToken) - Method in class uk.ac.ed.ph.snuggletex.dombuilding.ListEnvironmentHandler

Builds the actual List environment

handleEnvironment(DOMBuilder, Element, EnvironmentToken) - Method in class uk.ac.ed.ph.snuggletex.dombuilding.MathEnvironmentHandler

handleEnvironment(DOMBuilder, Element, EnvironmentToken) - Method in class uk.ac.ed.ph.snuggletex.dombuilding.MathFenceHandler

handleEnvironment(DOMBuilder, Element, EnvironmentToken) - Method in class uk.ac.ed.ph.snuggletex.dombuilding.MatrixHandler

handleEnvironment(DOMBuilder, Element, EnvironmentToken) - Method in class uk.ac.ed.ph.snuggletex.dombuilding.SimpleXHTMLContainerBuildingHandler

handleEnvironment(DOMBuilder, Element, EnvironmentToken) - Method in class uk.ac.ed.ph.snuggletex.dombuilding.StyleHandler

handleEnvironment(DOMBuilder, Element, EnvironmentToken) - Method in class uk.ac.ed.ph.snuggletex.dombuilding.TabularHandler

handleEnvironment(DOMBuilder, Element, EnvironmentToken) - Method in class uk.ac.ed.ph.snuggletex.dombuilding.VerbatimHandler

handleEnvironment(DOMBuilder, Element, EnvironmentToken) - Method in class uk.ac.ed.ph.snuggletex.dombuilding.XMLUnparseHandler

handleMathMLIsland(Element, Document, Node, int) - Method in class uk.ac.ed.ph.snuggletex.utilities.MathMLPostProcessor

This method is called for each MathML math element discovered, in document order.

handleMathTokensAsSingleElement(Element, ArgumentContainerToken) - Method in class uk.ac.ed.ph.snuggletex.internal.DOMBuilder

handleMathTokensAsSingleElement(Element, List<FlowToken>) - Method in class uk.ac.ed.ph.snuggletex.internal.DOMBuilder

handleTextToken(Element, SimpleToken) - Method in class uk.ac.ed.ph.snuggletex.internal.DOMBuilder

handleToken(Element, FlowToken) - Method in class uk.ac.ed.ph.snuggletex.internal.DOMBuilder

Creates a single Node from the given token.

handleTokens(Element, ArgumentContainerToken, boolean) - Method in class uk.ac.ed.ph.snuggletex.internal.DOMBuilder

handleTokens(Element, List<FlowToken>, boolean) - Method in class uk.ac.ed.ph.snuggletex.internal.DOMBuilder

hasInterpretationType(InterpretationType...) - Method in class uk.ac.ed.ph.snuggletex.tokens.Token

HrefHandler - Class in uk.ac.ed.ph.snuggletex.dombuilding

Handles the SnuggleTeX-specific \\href command for easily creating web links.

HrefHandler() - Constructor for class uk.ac.ed.ph.snuggletex.dombuilding.HrefHandler

HSpaceHandler - Class in uk.ac.ed.ph.snuggletex.dombuilding

Handles the \\hspace and \\hspace* commands.

HSpaceHandler() - Constructor for class uk.ac.ed.ph.snuggletex.dombuilding.HSpaceHandler

HTML5_DOCTYPE_HEADER - Static variable in interface uk.ac.ed.ph.snuggletex.definitions.W3CConstants

I

ID - Static variable in class uk.ac.ed.ph.snuggletex.dombuilding.XMLNameOrIdHandler

indexInComponent - Variable in class uk.ac.ed.ph.snuggletex.internal.WorkingDocument.IndexResolution

indexOf(int, char) - Method in interface uk.ac.ed.ph.snuggletex.InputContext

Returns the first index of the given character, starting the search at the given index.

indexOf(int, String) - Method in interface uk.ac.ed.ph.snuggletex.InputContext

Returns the first index of the given String, starting the search at the given index.

indexOf(int, char) - Method in class uk.ac.ed.ph.snuggletex.internal.WorkingDocument

indexOf(int, String) - Method in class uk.ac.ed.ph.snuggletex.internal.WorkingDocument

IndexResolution(int, WorkingDocument.Slice, int) - Constructor for class uk.ac.ed.ph.snuggletex.internal.WorkingDocument.IndexResolution

InputContext - Interface in uk.ac.ed.ph.snuggletex

Read-only view of the current document being parsed, which will change shape as user-defined macros and environments are being expanded.

InputError - Class in uk.ac.ed.ph.snuggletex

Encapsulates an error in the LaTeX input, providing information about what the error is and where it occurred.

InputError(ErrorCode, FrozenSlice, Object...) - Constructor for class uk.ac.ed.ph.snuggletex.InputError

InsertUnicodeHandler - Class in uk.ac.ed.ph.snuggletex.dombuilding

Handles the non-standard \\ux command to insert a Unicode character into the output.

InsertUnicodeHandler() - Constructor for class uk.ac.ed.ph.snuggletex.dombuilding.InsertUnicodeHandler

interpretableSimpleMathBuilder - Static variable in class uk.ac.ed.ph.snuggletex.SnugglePackage

Share instance of InterpretableSimpleMathHandler since it is stateless

InterpretableSimpleMathHandler - Class in uk.ac.ed.ph.snuggletex.dombuilding

This builder calls back directly to the DOMBuilder to handle mathematical tokens with certain types of simple semantic interpretations.

InterpretableSimpleMathHandler() - Constructor for class uk.ac.ed.ph.snuggletex.dombuilding.InterpretableSimpleMathHandler

Interpretation - Interface in uk.ac.ed.ph.snuggletex.semantics

This base interface allows some kind of "semantic interpretation" to be associated with a particular Token.

Interpretation.MarkerInterpretation - Class in uk.ac.ed.ph.snuggletex.semantics

interpretationMap - Variable in class uk.ac.ed.ph.snuggletex.tokens.Token

Interpretation(s) of this token, if it can be readily deduced from the input.

InterpretationType - Enum in uk.ac.ed.ph.snuggletex.semantics

Defines the different types of interpretations handled by the Interpretation class hierarchy.

IOUtilities - Class in uk.ac.ed.ph.snuggletex.internal.util

A collection of vaguely useful utilities for doing common I/O and File-related tasks.

IOUtilities() - Constructor for class uk.ac.ed.ph.snuggletex.internal.util.IOUtilities

isAddingMathAnnotations() - Method in class uk.ac.ed.ph.snuggletex.DOMOutputOptions

Deprecated.

Use DOMOutputOptions.isAddingMathSourceAnnotations() instead

isAddingMathPlayerImport() - Method in class uk.ac.ed.ph.snuggletex.WebPageOutputOptions

Returns whether to include the necessary processing instruction and object element required to explicitly trigger the MathPlayer plugin.

isAddingMathSourceAnnotations() - Method in class uk.ac.ed.ph.snuggletex.DOMOutputOptions

Returns whether the MathML math elements generated by SnuggleTeX should be annotated with the LaTeX input used to generate them.

isAddingTitleHeading() - Method in class uk.ac.ed.ph.snuggletex.WebPageOutputOptions

Returns whether page title should be inserted at the start of the web page body as an XHTML h1 element.

isAllowed(FlowToken) - Method in interface uk.ac.ed.ph.snuggletex.definitions.CombinerTargetMatcher

isAllowed(FlowToken) - Method in class uk.ac.ed.ph.snuggletex.dombuilding.MathFenceHandler.BracketCombinerTargetMatcher

isAllowingOptionalArgument() - Method in interface uk.ac.ed.ph.snuggletex.definitions.CommandOrEnvironment

Returns whether this command/environment takes an optional argument.

isAllowingOptionalArgument() - Method in class uk.ac.ed.ph.snuggletex.definitions.UserDefinedCommandOrEnvironment

isApplyingFirefox3SemanticsWorkaround() - Method in class uk.ac.ed.ph.snuggletex.DOMOutputOptions

Returns whether we should wrap "display math" MathML content within an additional <mstyle displaystyle="true">....

isBlock() - Method in class uk.ac.ed.ph.snuggletex.dombuilding.AbstractCustomXMLElementHandler

Subclasses should fill in to return true if they are building a block element or false if they are building an inline element.

isBlock() - Method in class uk.ac.ed.ph.snuggletex.dombuilding.XMLBlockElementHandler

isBlock() - Method in class uk.ac.ed.ph.snuggletex.dombuilding.XMLInlineElementHandler

isBuildingMathMLIsland() - Method in class uk.ac.ed.ph.snuggletex.internal.DOMBuilder

Returns whether or not we're building a MathML island by checking the current DOMBuilder.OutputContext.

isCommand(BuiltinCommand) - Method in class uk.ac.ed.ph.snuggletex.tokens.Token

isCompactingBlankLines() - Method in class uk.ac.ed.ph.snuggletex.utilities.LaTeXIndenter

isEnvironment(BuiltinEnvironment) - Method in class uk.ac.ed.ph.snuggletex.tokens.Token

isEquivalentTo(ComputedStyle) - Method in class uk.ac.ed.ph.snuggletex.definitions.ComputedStyle

isFailingFast() - Method in class uk.ac.ed.ph.snuggletex.SessionConfiguration

Returns whether or not the SnuggleSession will fail immediately on error, or keep going.

isHtml5() - Method in class uk.ac.ed.ph.snuggletex.WebPageOutputOptions

isIncludingStyleElement() - Method in class uk.ac.ed.ph.snuggletex.WebPageOutputOptions

Returns whether to include SnuggleTeX-related CSS as a style element within the resulting page.

isIncludingXMLDeclaration() - Method in interface uk.ac.ed.ph.snuggletex.SerializationSpecifier

Gets whether to include an XML declaration on the resulting output.

isIncludingXMLDeclaration() - Method in class uk.ac.ed.ph.snuggletex.utilities.SerializationOptions

Gets whether to include an XML declaration on the resulting output.

isIncludingXMLDeclaration() - Method in class uk.ac.ed.ph.snuggletex.XMLStringOutputOptions

Gets whether to include an XML declaration on the resulting output.

isIndenting() - Method in interface uk.ac.ed.ph.snuggletex.SerializationSpecifier

Returns whether the resulting XML will be indented or not.

isIndenting() - Method in class uk.ac.ed.ph.snuggletex.utilities.SerializationOptions

Returns whether the resulting XML will be indented or not.

isIndenting() - Method in class uk.ac.ed.ph.snuggletex.XMLStringOutputOptions

Returns whether the resulting XML will be indented or not.

isInliningCSS() - Method in class uk.ac.ed.ph.snuggletex.DOMOutputOptions

Get whether CSS styling is being inlined via style attributes or not.

isInputableTeXName(String) - Static method in class uk.ac.ed.ph.snuggletex.SnugglePackage

Tests whether the name of a command or environment is "inputable".

isMathJax() - Method in class uk.ac.ed.ph.snuggletex.WebPageOutputOptions

isMathMLElement(Node) - Static method in class uk.ac.ed.ph.snuggletex.utilities.MathMLUtilities

Convenience method to test whether the given DOM Node node is a MathML element having any localName.

isMathMLElement(Node, String) - Static method in class uk.ac.ed.ph.snuggletex.utilities.MathMLUtilities

Convenience method to test whether the given DOM Node node is a MathML element having the given localName.

isMathVariantMapping() - Method in class uk.ac.ed.ph.snuggletex.DOMOutputOptions

Returns whether we should perform automatic mappings of (safe) Unicode characters when applying "stylings" like \\mathcal and \\mathbb.

isNoCharsetInContentTypeHeader() - Method in class uk.ac.ed.ph.snuggletex.WebPageOutputOptions

isNullOrEmpty(Object[]) - Static method in class uk.ac.ed.ph.snuggletex.internal.util.ObjectUtilities

isNullOrEmpty(String) - Static method in class uk.ac.ed.ph.snuggletex.internal.util.StringUtilities

Tests whether the given String is null or empty ("").

isolateAnnotationXML(Element, String) - Static method in class uk.ac.ed.ph.snuggletex.utilities.MathMLUtilities

"Isolates" the XML annotation having the given encoding by producing a copy of the MathML element with only the given annotation contents as children.

isolateAnnotationXML(UnwrappedParallelMathMLDOM, String) - Static method in class uk.ac.ed.ph.snuggletex.utilities.MathMLUtilities

Version of MathMLUtilities.isolateAnnotationXML(Element, String) that works on an UnwrappedParallelMathMLDOM.

isolateFirstSemanticsBranch(Element) - Static method in class uk.ac.ed.ph.snuggletex.utilities.MathMLUtilities

"Isolates" the first <semantics/> branch of an annotation MathML element by producing a copy of the MathML element with a single child containing only the first child of the <semantics/> element.

isolateFirstSemanticsBranch(UnwrappedParallelMathMLDOM) - Static method in class uk.ac.ed.ph.snuggletex.utilities.MathMLUtilities

Version of MathMLUtilities.isolateFirstSemanticsBranch(Element) that works on an UnwrappedParallelMathMLDOM.

isPairingInferencePossible() - Method in class uk.ac.ed.ph.snuggletex.semantics.MathBracketInterpretation

isParentElement(Element, String, String...) - Method in class uk.ac.ed.ph.snuggletex.internal.DOMBuilder

isPrefixingMathML() - Method in class uk.ac.ed.ph.snuggletex.DOMOutputOptions

Returns whether MathML elements should be prefixed or not.

isPrefixingSnuggleXML() - Method in class uk.ac.ed.ph.snuggletex.DOMOutputOptions

Returns whether custom SnuggleTeX XML elements should be prefixed or not.

isPrefixingXHTML() - Method in class uk.ac.ed.ph.snuggletex.DOMOutputOptions

Returns whether XHTML elements should be prefixed or not.

isRegionWhitespace(int, int) - Method in interface uk.ac.ed.ph.snuggletex.InputContext

Tests whether all characters in the document with index satisfying startIndex <= index < endIndex are whitespace.

isRegionWhitespace(int, int) - Method in class uk.ac.ed.ph.snuggletex.internal.WorkingDocument

isSaxonAvailable() - Static method in class uk.ac.ed.ph.snuggletex.internal.util.XMLUtilities

isUsingNamedEntities() - Method in interface uk.ac.ed.ph.snuggletex.SerializationSpecifier

Returns whether to use named entities for certain MathML symbols rather than numeric character references.

isUsingNamedEntities() - Method in class uk.ac.ed.ph.snuggletex.utilities.SerializationOptions

Returns whether to use named entities for certain MathML symbols rather than numeric character references.

isUsingNamedEntities() - Method in class uk.ac.ed.ph.snuggletex.XMLStringOutputOptions

Returns whether to use named entities for certain MathML symbols rather than numeric character references.

isWhitespace() - Method in class uk.ac.ed.ph.snuggletex.internal.FrozenSlice

isXMLName(String) - Static method in class uk.ac.ed.ph.snuggletex.internal.util.XMLUtilities

isXMLNCName(String) - Static method in class uk.ac.ed.ph.snuggletex.internal.util.XMLUtilities

isXSLT20SupportAvailable() - Method in class uk.ac.ed.ph.snuggletex.utilities.DefaultTransformerFactoryChooser

isXSLT20SupportAvailable() - Method in class uk.ac.ed.ph.snuggletex.utilities.SaxonTransformerFactoryChooser

isXSLT20SupportAvailable() - Method in interface uk.ac.ed.ph.snuggletex.utilities.TransformerFactoryChooser

Implementors of this interface should indicate whether support for XSLT 2.0 is available.

iterator() - Method in class uk.ac.ed.ph.snuggletex.tokens.ArgumentContainerToken

iterator() - Method in class uk.ac.ed.ph.snuggletex.tokens.BraceContainerToken

iterator() - Method in class uk.ac.ed.ph.snuggletex.tokens.RootToken

J

join(Iterable<? extends Object>, CharSequence) - Static method in class uk.ac.ed.ph.snuggletex.internal.util.StringUtilities

Joins the given collection of Objects using the given separator and each Object's normal toString() method.

join(Object[], CharSequence) - Static method in class uk.ac.ed.ph.snuggletex.internal.util.StringUtilities

Same as StringUtilities.join(Iterable, CharSequence) but simply takes an array of Objects.

join(StringBuilder, Object[], CharSequence) - Static method in class uk.ac.ed.ph.snuggletex.internal.util.StringUtilities

Version of StringUtilities.join(Object[], CharSequence) that allows you to pass in a StringBuilder that the result will be built up in.

join(Object[], CharSequence, int, int) - Static method in class uk.ac.ed.ph.snuggletex.internal.util.StringUtilities

Version of StringUtilities.join(Object[], CharSequence) that allows you to specify a range of indices in the array to join.

join(StringBuilder, Object[], CharSequence, int, int) - Static method in class uk.ac.ed.ph.snuggletex.internal.util.StringUtilities

Version of StringUtilities.join(Object[], CharSequence, int, int) that allows you to pass in a StringBuilder that the result will be built up in.

L

LaTeXIndenter - Class in uk.ac.ed.ph.snuggletex.utilities

Simple utility class that does very basic indenting of LaTeX.

LaTeXIndenter(Writer) - Constructor for class uk.ac.ed.ph.snuggletex.utilities.LaTeXIndenter

Creates a new indenter that will output to LaTeXIndenter.outputWriter.

LaTeXMode - Enum in uk.ac.ed.ph.snuggletex.definitions

Enumerates the various modes of LaTeX input.

latexMode - Variable in class uk.ac.ed.ph.snuggletex.internal.LaTeXTokeniser.ModeState

Current LaTeX mode we are parsing in

latexMode - Variable in class uk.ac.ed.ph.snuggletex.tokens.Token

LaTeX Mode that this token was parsed in

LaTeXTokeniser - Class in uk.ac.ed.ph.snuggletex.internal

This class reads in SnuggleTeX input and builds a tree of literal parsed Tokens.

LaTeXTokeniser(SessionContext) - Constructor for class uk.ac.ed.ph.snuggletex.internal.LaTeXTokeniser

LaTeXTokeniser.ModeState - Class in uk.ac.ed.ph.snuggletex.internal

Trivial "struct" encapsulating information about the state of a tokenisation mode.

LaTeXTokeniser.PatternTerminator - Class in uk.ac.ed.ph.snuggletex.internal

This implementation of Terminator represents terminators specified as regular expressions.

LaTeXTokeniser.StringTerminator - Class in uk.ac.ed.ph.snuggletex.internal

This implementation of Terminator is used to handle fixed Strings as terminators.

LaTeXTokeniser.Terminator - Interface in uk.ac.ed.ph.snuggletex.internal

Represents the "terminator" characters that signify the end of a parsing mode.

LaTeXTokeniser.TokenisationMode - Enum in uk.ac.ed.ph.snuggletex.internal

Enumeration of the various "tokenisation modes" we will be running in.

length() - Method in interface uk.ac.ed.ph.snuggletex.InputContext

Current length of this input

length() - Method in class uk.ac.ed.ph.snuggletex.internal.WorkingDocument

LineBreakHandler - Class in uk.ac.ed.ph.snuggletex.dombuilding

Handles instances of \\\\, which forces a line break at the given point.

LineBreakHandler() - Constructor for class uk.ac.ed.ph.snuggletex.dombuilding.LineBreakHandler

LinkResolver - Interface in uk.ac.ed.ph.snuggletex

This interface allows clients to have control over handling any hypertext links encountered in commands like HrefHandler, making it possible to remap links as required.

LIST - Static variable in interface uk.ac.ed.ph.snuggletex.semantics.Interpretation

ListEnvironmentHandler - Class in uk.ac.ed.ph.snuggletex.dombuilding

This handles LaTeX list environments (i.e.

ListEnvironmentHandler() - Constructor for class uk.ac.ed.ph.snuggletex.dombuilding.ListEnvironmentHandler

LiteralHandler - Class in uk.ac.ed.ph.snuggletex.dombuilding

Handler for the custom \\literal command, which allows literal input to be entered, similar to \\verb with output without changing style.

LiteralHandler() - Constructor for class uk.ac.ed.ph.snuggletex.dombuilding.LiteralHandler

loadMathCharacterAliases(String) - Method in class uk.ac.ed.ph.snuggletex.SnugglePackage

loadMathCharacterBigLimitTargets(String) - Method in class uk.ac.ed.ph.snuggletex.SnugglePackage

loadMathCharacterBrackets(String) - Method in class uk.ac.ed.ph.snuggletex.SnugglePackage

loadMathCharacterDefinitions(String) - Method in class uk.ac.ed.ph.snuggletex.SnugglePackage

loadMathCharacterNegations(String) - Method in class uk.ac.ed.ph.snuggletex.SnugglePackage

loadMathFunctionDefinitions(String) - Method in class uk.ac.ed.ph.snuggletex.SnugglePackage

M

main(String[]) - Static method in class uk.ac.ed.ph.snuggletex.internal.util.MakeCharacterDefinitions

main(String[]) - Static method in class uk.ac.ed.ph.snuggletex.samples.CommandLineRunner

main(String[]) - Static method in class uk.ac.ed.ph.snuggletex.samples.MinimalExample

main(String[]) - Static method in class uk.ac.ed.ph.snuggletex.samples.WebPageExample

main(String[]) - Static method in class uk.ac.ed.ph.snuggletex.samples.XMLStringOutputExample

main(String[]) - Static method in class uk.ac.ed.ph.snuggletex.utilities.CSSUtilities

Main method is used by the build process to write out the default CSS stylesheet.

MakeCharacterDefinitions - Class in uk.ac.ed.ph.snuggletex.internal.util

This is used during the build process to create the SnuggleTeX all-math-characters.txt from the unicode-math-table.tex from the unicode-math LaTeX package.

MakeCharacterDefinitions() - Constructor for class uk.ac.ed.ph.snuggletex.internal.util.MakeCharacterDefinitions

makeInterpretationMap(Interpretation) - Static method in class uk.ac.ed.ph.snuggletex.SnugglePackage

makeInterpretationMap(Interpretation...) - Static method in class uk.ac.ed.ph.snuggletex.SnugglePackage

mapLink(URI, URI) - Method in interface uk.ac.ed.ph.snuggletex.LinkResolver

Called when a link URI has been encountered.

MarkerInterpretation(InterpretationType) - Constructor for class uk.ac.ed.ph.snuggletex.semantics.Interpretation.MarkerInterpretation

matchesAt(int, char) - Method in interface uk.ac.ed.ph.snuggletex.InputContext

Tests whether the character at the given index is equal to that specified.

matchesAt(int, String) - Method in interface uk.ac.ed.ph.snuggletex.InputContext

Tests whether the characters at the given index are equal to the String specified.

matchesAt(WorkingDocument, int) - Method in class uk.ac.ed.ph.snuggletex.internal.LaTeXTokeniser.PatternTerminator

matchesAt(WorkingDocument, int) - Method in class uk.ac.ed.ph.snuggletex.internal.LaTeXTokeniser.StringTerminator

matchesAt(WorkingDocument, int) - Method in interface uk.ac.ed.ph.snuggletex.internal.LaTeXTokeniser.Terminator

Tests whether this Terminator matches the WorkingDocument at the given index.

matchesAt(int, char) - Method in class uk.ac.ed.ph.snuggletex.internal.WorkingDocument

matchesAt(int, String) - Method in class uk.ac.ed.ph.snuggletex.internal.WorkingDocument

MATH_CHARACTER_ALIASES_RESOURCE_NAME - Static variable in class uk.ac.ed.ph.snuggletex.definitions.CorePackageDefinitions

MATH_CHARACTER_BIG_LIMITS_RESOURCE_NAME - Static variable in class uk.ac.ed.ph.snuggletex.definitions.CorePackageDefinitions

MATH_CHARACTER_BRACKETS_RESOURCE_NAME - Static variable in class uk.ac.ed.ph.snuggletex.definitions.CorePackageDefinitions

MATH_CHARACTER_NEGATIONS_RESOURCE_NAME - Static variable in class uk.ac.ed.ph.snuggletex.definitions.CorePackageDefinitions

MATH_FUNCTION_DEFINITIONS_RESOURCE_NAME - Static variable in class uk.ac.ed.ph.snuggletex.definitions.CorePackageDefinitions

MATH_MODE_ONLY - Static variable in class uk.ac.ed.ph.snuggletex.definitions.Globals

MathBigLimitOwnerInterpretation - Class in uk.ac.ed.ph.snuggletex.semantics

Supplementary marker interpretation to be attached to operators which can "own big limits", in the sense that they should be rendered in MathML using munder/mover/munderover rather than msub/msup/msubsup.

MathBigLimitOwnerInterpretation() - Constructor for class uk.ac.ed.ph.snuggletex.semantics.MathBigLimitOwnerInterpretation

MathBracketInterpretation - Class in uk.ac.ed.ph.snuggletex.semantics

Supplementary interpretation indicating that a certain operator is a MathML bracket.

MathBracketInterpretation(MathCharacter, MathBracketInterpretation.BracketType, boolean) - Constructor for class uk.ac.ed.ph.snuggletex.semantics.MathBracketInterpretation

MathBracketInterpretation.BracketType - Enum in uk.ac.ed.ph.snuggletex.semantics

MathCharacter - Class in uk.ac.ed.ph.snuggletex.definitions

Represents a mathematical character.

MathCharacter(int, String, MathCharacter.MathCharacterType) - Constructor for class uk.ac.ed.ph.snuggletex.definitions.MathCharacter

MathCharacter.MathCharacterType - Enum in uk.ac.ed.ph.snuggletex.definitions

MathCharacterInterpretation - Class in uk.ac.ed.ph.snuggletex.semantics

Represents a mathematical character

MathCharacterInterpretation(MathCharacter) - Constructor for class uk.ac.ed.ph.snuggletex.semantics.MathCharacterInterpretation

MathCharacterToken - Class in uk.ac.ed.ph.snuggletex.tokens

Represents a character in math mode.

MathCharacterToken(FrozenSlice, MathCharacter) - Constructor for class uk.ac.ed.ph.snuggletex.tokens.MathCharacterToken

MathComplexCommandHandler - Class in uk.ac.ed.ph.snuggletex.dombuilding

Handles complex Math commands (i.e. ones taking arguments) that map very easily onto MathML elements where each argument becomes a child element of the resulting MathML container.

MathComplexCommandHandler(String) - Constructor for class uk.ac.ed.ph.snuggletex.dombuilding.MathComplexCommandHandler

MathEnvironmentHandler - Class in uk.ac.ed.ph.snuggletex.dombuilding

Builds LaTeX math environments.

MathEnvironmentHandler() - Constructor for class uk.ac.ed.ph.snuggletex.dombuilding.MathEnvironmentHandler

MathFenceHandler - Class in uk.ac.ed.ph.snuggletex.dombuilding

Handles matched parentheses encapsulated within CorePackageDefinitions.ENV_BRACKETED environments.

MathFenceHandler() - Constructor for class uk.ac.ed.ph.snuggletex.dombuilding.MathFenceHandler

MathFenceHandler.BracketCombinerTargetMatcher - Class in uk.ac.ed.ph.snuggletex.dombuilding

MathFunctionInterpretation - Class in uk.ac.ed.ph.snuggletex.semantics

Represents a mathematical function like sin, cos, etc.

MathFunctionInterpretation(String) - Constructor for class uk.ac.ed.ph.snuggletex.semantics.MathFunctionInterpretation

MathIdentifierInterpretation - Class in uk.ac.ed.ph.snuggletex.semantics

Semantic interpretation for a mathematical identifier.

MathIdentifierInterpretation(String) - Constructor for class uk.ac.ed.ph.snuggletex.semantics.MathIdentifierInterpretation

MathInterpretation - Interface in uk.ac.ed.ph.snuggletex.semantics

Base for math-specific semantic interpretations.

MathLimitsHandler - Class in uk.ac.ed.ph.snuggletex.dombuilding

Handles the mathematical "limit" tokens like CorePackageDefinitions.CMD_MSUB_OR_MUNDER, generating either msub or munder as appropriate, with analogous results for CorePackageDefinitions.CMD_MSUP_OR_MOVER and CorePackageDefinitions.CMD_MSUBSUP_OR_MUNDEROVER.

MathLimitsHandler() - Constructor for class uk.ac.ed.ph.snuggletex.dombuilding.MathLimitsHandler

MATHML_ENTITIES_MAP_XSL_RESOURCE_NAME - Static variable in class uk.ac.ed.ph.snuggletex.definitions.Globals

Specifies the location of the XSLT that converts MathML symbol characters to named entities

MATHML_NAMESPACE - Static variable in class uk.ac.ed.ph.snuggletex.definitions.Globals

Deprecated.

Use W3CConstants.MATHML_NAMESPACE instead

MATHML_NAMESPACE - Static variable in interface uk.ac.ed.ph.snuggletex.definitions.W3CConstants

MATHML_PREF_NAMESPACE - Static variable in class uk.ac.ed.ph.snuggletex.definitions.Globals

Deprecated.

Use W3CConstants.MATHML_PREF_NAMESPACE instead

MATHML_PREF_NAMESPACE - Static variable in interface uk.ac.ed.ph.snuggletex.definitions.W3CConstants

MATHML_TO_XHTML_XSL_RESOURCE_NAME - Static variable in class uk.ac.ed.ph.snuggletex.definitions.Globals

Specifies the ClassPath location of the MathML -> XHTML stylesheet to use for down-transforming

MathMLDownConverter - Class in uk.ac.ed.ph.snuggletex.utilities

This utility class "down-converts" a DOM Document so that simple MathML expressions are replaced by XHTML + CSS alternatives.

MathMLDownConverter() - Constructor for class uk.ac.ed.ph.snuggletex.utilities.MathMLDownConverter

MathMLDownConverter(Properties) - Constructor for class uk.ac.ed.ph.snuggletex.utilities.MathMLDownConverter

MathMLDownConverter(StylesheetCache) - Constructor for class uk.ac.ed.ph.snuggletex.utilities.MathMLDownConverter

MathMLDownConverter(StylesheetManager, DOMOutputOptions) - Constructor for class uk.ac.ed.ph.snuggletex.utilities.MathMLDownConverter

Creates a new MathMLDownConverter which will inline CSS properties if specified by the given DOMOutputOptions.

MathMLDownConverter(StylesheetManager, Properties) - Constructor for class uk.ac.ed.ph.snuggletex.utilities.MathMLDownConverter

MathMLDownConverter.CSSPropertiesURIResolver - Class in uk.ac.ed.ph.snuggletex.utilities

Trivial URIResolver that returns an XML Document corresponding to the current session's CSS Properties when the URI Globals.CSS_PROPERTIES_DOCUMENT_URN is used.

MathMLPostProcessor - Class in uk.ac.ed.ph.snuggletex.utilities

Convenient base for DOMPostProcessors that might want to do interesting things to MathML islands, leaving everything else unchanged.

MathMLPostProcessor() - Constructor for class uk.ac.ed.ph.snuggletex.utilities.MathMLPostProcessor

MathMLUtilities - Class in uk.ac.ed.ph.snuggletex.utilities

Some general utility methods for manipulating MathML via the DOM.

MathMLUtilities() - Constructor for class uk.ac.ed.ph.snuggletex.utilities.MathMLUtilities

MathNegatableInterpretation - Class in uk.ac.ed.ph.snuggletex.semantics

Supplementary interpretation for an operator which may be negated.

MathNegatableInterpretation(MathCharacter) - Constructor for class uk.ac.ed.ph.snuggletex.semantics.MathNegatableInterpretation

MathNotHandler - Class in uk.ac.ed.ph.snuggletex.dombuilding

Handles the \\not combiner command.

MathNotHandler() - Constructor for class uk.ac.ed.ph.snuggletex.dombuilding.MathNotHandler

MathNumberInterpretation - Class in uk.ac.ed.ph.snuggletex.semantics

Represents the interpretation of a mathematical number.

MathNumberInterpretation(CharSequence) - Constructor for class uk.ac.ed.ph.snuggletex.semantics.MathNumberInterpretation

MathOperatorInterpretation - Class in uk.ac.ed.ph.snuggletex.semantics

Represents a generic Mathematical operator, associating it with the content of the resulting MathML mo element.

MathOperatorInterpretation(String) - Constructor for class uk.ac.ed.ph.snuggletex.semantics.MathOperatorInterpretation

MathRootHandler - Class in uk.ac.ed.ph.snuggletex.dombuilding

Handles the LaTeX \\sqrt command, which generates either a msqrt or mroot depending on whether an optional argument has been passed or not.

MathRootHandler() - Constructor for class uk.ac.ed.ph.snuggletex.dombuilding.MathRootHandler

MathUnderOrOverHandler - Class in uk.ac.ed.ph.snuggletex.dombuilding

Handles the \\stackrel, \\overset and \\underset commands.

MathUnderOrOverHandler(String) - Constructor for class uk.ac.ed.ph.snuggletex.dombuilding.MathUnderOrOverHandler

MathVariantMap - Class in uk.ac.ed.ph.snuggletex.definitions

This map encapsulates how to apply certain types of Mathematical character variants to "safe and plain" Unicode characters by mapping them to other characters.

MathVariantMap(String, char[]) - Constructor for class uk.ac.ed.ph.snuggletex.definitions.MathVariantMap

MathVariantMapHandler - Class in uk.ac.ed.ph.snuggletex.dombuilding

This handles changes to the current "mathvariant" caused by things like \\mathcal and friends.

MathVariantMapHandler(MathVariantMap) - Constructor for class uk.ac.ed.ph.snuggletex.dombuilding.MathVariantMapHandler

MathVariantMaps - Interface in uk.ac.ed.ph.snuggletex.definitions

Defines the (safe) mappings of characters for the different types of "mathvariants" we support.

MatrixHandler - Class in uk.ac.ed.ph.snuggletex.dombuilding

Handles the AMSLaTeX cases and the various matrix environments.

MatrixHandler() - Constructor for class uk.ac.ed.ph.snuggletex.dombuilding.MatrixHandler

MatrixHandler(String, String) - Constructor for class uk.ac.ed.ph.snuggletex.dombuilding.MatrixHandler

MatrixHandler(int, String, String) - Constructor for class uk.ac.ed.ph.snuggletex.dombuilding.MatrixHandler

MAX_TEXT_STREAM_SIZE - Static variable in class uk.ac.ed.ph.snuggletex.internal.util.IOUtilities

Maximum size of characters we'll read from a text stream before complaining

MessageFormatter - Class in uk.ac.ed.ph.snuggletex.utilities

Utility class that formats an InputError in various ways.

MessageFormatter() - Constructor for class uk.ac.ed.ph.snuggletex.utilities.MessageFormatter

MinimalExample - Class in uk.ac.ed.ph.snuggletex.samples

Example demonstrating a minimal example use of SnuggleTeX.

MinimalExample() - Constructor for class uk.ac.ed.ph.snuggletex.samples.MinimalExample

ModeDelegatingHandler - Class in uk.ac.ed.ph.snuggletex.dombuilding

Trivial "meta"-builder that delegates to a CommandHandler depending on whether we are in MATH or TEXT mode.

ModeDelegatingHandler(CommandHandler, CommandHandler) - Constructor for class uk.ac.ed.ph.snuggletex.dombuilding.ModeDelegatingHandler

ModeState(LaTeXTokeniser.TokenisationMode, LaTeXMode, int, LaTeXTokeniser.Terminator) - Constructor for class uk.ac.ed.ph.snuggletex.internal.LaTeXTokeniser.ModeState

MrowHandler - Class in uk.ac.ed.ph.snuggletex.dombuilding

Builds MathML mrows.

MrowHandler() - Constructor for class uk.ac.ed.ph.snuggletex.dombuilding.MrowHandler

N

NAME - Static variable in class uk.ac.ed.ph.snuggletex.dombuilding.XMLNameOrIdHandler

nextMatchFrom(WorkingDocument, int) - Method in class uk.ac.ed.ph.snuggletex.internal.LaTeXTokeniser.PatternTerminator

nextMatchFrom(WorkingDocument, int) - Method in class uk.ac.ed.ph.snuggletex.internal.LaTeXTokeniser.StringTerminator

nextMatchFrom(WorkingDocument, int) - Method in interface uk.ac.ed.ph.snuggletex.internal.LaTeXTokeniser.Terminator

Finds the next match of this Terminator in the given WorkingDocument starting at the given index.

nullIfEmpty(String) - Static method in class uk.ac.ed.ph.snuggletex.internal.util.StringUtilities

Convenience method that turns a String to null if it is empty (i.e. "") or null.

nullSafeEquals(Object, Object) - Static method in class uk.ac.ed.ph.snuggletex.internal.util.ObjectUtilities

Checks equality of two Objects, allowing the case where o1==o2==null to return true.

NumberMatcher - Interface in uk.ac.ed.ph.snuggletex

Interface for classes which identify numbers in Math mode input.

O

ObjectDumper - Class in uk.ac.ed.ph.snuggletex.internal.util

Trivial but slightly useful helper for creating deep dumps of Objects and their its properties, which can be useful for displaying status messages and debugging.

ObjectDumper(StringBuilder) - Constructor for class uk.ac.ed.ph.snuggletex.internal.util.ObjectDumper

ObjectDumperOptions - Annotation Type in uk.ac.ed.ph.snuggletex.internal.util

This annotation is used by ObjectDumper to specify how types or properties should be dumped.

ObjectUtilities - Class in uk.ac.ed.ph.snuggletex.internal.util

Some random "macros" for doing common Object-based tasks.

ObjectUtilities() - Constructor for class uk.ac.ed.ph.snuggletex.internal.util.ObjectUtilities

openStyle(Element, ComputedStyle, boolean, boolean) - Method in class uk.ac.ed.ph.snuggletex.internal.DOMBuilder

optionalArgument - Variable in class uk.ac.ed.ph.snuggletex.definitions.UserDefinedCommandOrEnvironment

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

P

PARA_MODE_ONLY - Static variable in class uk.ac.ed.ph.snuggletex.definitions.Globals

ParagraphHandler - Class in uk.ac.ed.ph.snuggletex.dombuilding

This builds the content of a (fixed) CorePackageDefinitions.CMD_PARAGRAPH token.

ParagraphHandler() - Constructor for class uk.ac.ed.ph.snuggletex.dombuilding.ParagraphHandler

parseInput(SnuggleInput) - Method in class uk.ac.ed.ph.snuggletex.SnuggleSession

Parses the data contained within the given SnuggleInput, and performs fixing on the resulting tokens.

parseMathMLDocumentString(String) - Static method in class uk.ac.ed.ph.snuggletex.utilities.MathMLUtilities

Convenience method that parses a MathML document specified as a UTF-8-encoded String.

PatternTerminator(Pattern) - Constructor for class uk.ac.ed.ph.snuggletex.internal.LaTeXTokeniser.PatternTerminator

peek() - Method in class uk.ac.ed.ph.snuggletex.internal.util.ArrayListStack

pop() - Method in class uk.ac.ed.ph.snuggletex.internal.util.ArrayListStack

postProcessDOM(Document, DOMOutputOptions, StylesheetManager) - Method in interface uk.ac.ed.ph.snuggletex.DOMPostProcessor

Implement this to post-process the raw DOM produced by SnuggleTeX.

postProcessDOM(Document, DOMOutputOptions, StylesheetManager) - Method in class uk.ac.ed.ph.snuggletex.DownConvertingPostProcessor

postProcessDOM(Document, DOMOutputOptions, StylesheetManager) - Method in class uk.ac.ed.ph.snuggletex.utilities.MathMLPostProcessor

PropertyOptions - Enum in uk.ac.ed.ph.snuggletex.internal.util

Enumerates the different options that can be used for outputting property values in ObjectUtilities.beanToString(Object).

push(E) - Method in class uk.ac.ed.ph.snuggletex.internal.util.ArrayListStack

putStylesheet(String, Templates) - Method in class uk.ac.ed.ph.snuggletex.utilities.DoNothingStylesheetCache

putStylesheet(String, Templates) - Method in class uk.ac.ed.ph.snuggletex.utilities.SimpleStylesheetCache

putStylesheet(String, Templates) - Method in interface uk.ac.ed.ph.snuggletex.utilities.StylesheetCache

Instructs the cache that it might want to store the given XSLT stylesheet corresponding to the given key.

Q

quoteTextForInput(String) - Static method in class uk.ac.ed.ph.snuggletex.utilities.SnuggleUtilities

Quotes the given (ASCII) String so that it could be safely input in TEXT Mode in LaTeX input.

R

readBuiltinInlineCSSProperties() - Static method in class uk.ac.ed.ph.snuggletex.utilities.CSSUtilities

Reads in the default CSS Properties file, which is packaged within SnuggleTeX itself.

readCharacterStream(Reader) - Static method in class uk.ac.ed.ph.snuggletex.internal.util.IOUtilities

Reads all character data from the given Reader, returning a String containing all of the data.

readInlineCSSProperties(DOMOutputOptions) - Static method in class uk.ac.ed.ph.snuggletex.utilities.CSSUtilities

Reads in the custom CSS Properties Object specified by the given DOMOutputOptions.

readUnicodeFile(File) - Static method in class uk.ac.ed.ph.snuggletex.internal.util.IOUtilities

Same as IOUtilities.readUnicodeStream(InputStream) but accepts a plain File object for convenience

readUnicodeStream(InputStream) - Static method in class uk.ac.ed.ph.snuggletex.internal.util.IOUtilities

Same as IOUtilities.readCharacterStream(Reader) but assumes the stream is encoded as UTF-8.

rebuildStyles(RootToken) - Method in class uk.ac.ed.ph.snuggletex.internal.StyleRebuilder

registerError(InputError) - Method in interface uk.ac.ed.ph.snuggletex.internal.SessionContext

registerError(InputError) - Method in class uk.ac.ed.ph.snuggletex.SnuggleSession

Records a new error, throwing a SnuggleParseException if the current SessionConfiguration deems that we should fail on the first error.

replacement - Variable in class uk.ac.ed.ph.snuggletex.internal.WorkingDocument.SubstitutionContext

The characters that replaced what was originally in the document.

requireFeature(TransformerFactory, String) - Static method in class uk.ac.ed.ph.snuggletex.internal.util.XMLUtilities

reservedCommands - Static variable in class uk.ac.ed.ph.snuggletex.internal.LaTeXTokeniser

Set of reserved commands.

reset() - Method in class uk.ac.ed.ph.snuggletex.internal.LaTeXTokeniser

Resets the parsing state of this tokeniser.

reset() - Method in class uk.ac.ed.ph.snuggletex.SnuggleSession

Resets this SnuggleSession back to an initial blank state

reset() - Method in class uk.ac.ed.ph.snuggletex.utilities.LaTeXIndenter

resolve(String, String) - Method in class uk.ac.ed.ph.snuggletex.utilities.ClassPathURIResolver

resolve(String, String) - Method in class uk.ac.ed.ph.snuggletex.utilities.MathMLDownConverter.CSSPropertiesURIResolver

resolvedComponent - Variable in class uk.ac.ed.ph.snuggletex.internal.WorkingDocument.Slice

resolveIndex(int, boolean) - Method in class uk.ac.ed.ph.snuggletex.internal.WorkingDocument

resolveLink(Element, Token, String) - Method in class uk.ac.ed.ph.snuggletex.internal.DOMBuilder

rightOuterSpan(FrozenSlice) - Method in class uk.ac.ed.ph.snuggletex.internal.FrozenSlice

RootToken - Class in uk.ac.ed.ph.snuggletex.tokens

This token represents the root of a parsed SnuggleInput

RootToken(WorkingDocument, List<FlowToken>) - Constructor for class uk.ac.ed.ph.snuggletex.tokens.RootToken

run(Reader) - Method in class uk.ac.ed.ph.snuggletex.utilities.LaTeXIndenter

Indents the TeX read from the given inputReader, sending the results to LaTeXIndenter.outputWriter.

S

safeToString(Object) - Static method in class uk.ac.ed.ph.snuggletex.internal.util.ObjectUtilities

Convenience toString() method that can be applied safely to a null Object, yielding null.

SAXON_TRANSFORMER_FACTORY_CLASS_NAME - Static variable in class uk.ac.ed.ph.snuggletex.internal.util.XMLUtilities

Explicit name of the SAXON 9.X TransformerFactoryImpl Class, as used by the up-conversion extensions

SaxonTransformerFactoryChooser - Class in uk.ac.ed.ph.snuggletex.utilities

Implementation of TransformerFactoryChooser that is hard-wired to use whichever version of Saxon can be found in the ClassPath under the net.sf.saxon package hierarchy, thus providing support for XSLT 2.0.

SaxonTransformerFactoryChooser() - Constructor for class uk.ac.ed.ph.snuggletex.utilities.SaxonTransformerFactoryChooser

scoreboardIndex - Variable in class uk.ac.ed.ph.snuggletex.internal.WorkingDocument.IndexResolution

SCRIPT - Static variable in interface uk.ac.ed.ph.snuggletex.definitions.MathVariantMaps

These are defined from the MathML Script characters page, omitting those in Unicode plane 1.

search(Object) - Method in class uk.ac.ed.ph.snuggletex.internal.util.ArrayListStack

SerializationMethod - Enum in uk.ac.ed.ph.snuggletex

Enumerates the XML serialization methods available.

SerializationOptions - Class in uk.ac.ed.ph.snuggletex.utilities

Implementation of SerializationSpecifier that can be used for some of the utility methods in MathMLUtilities.

SerializationOptions() - Constructor for class uk.ac.ed.ph.snuggletex.utilities.SerializationOptions

SerializationSpecifier - Interface in uk.ac.ed.ph.snuggletex

Interface specifying various options for serializing XML produced by SnuggleTeX and some of its utility classes.

serializeDocument(Document) - Static method in class uk.ac.ed.ph.snuggletex.utilities.MathMLUtilities

Convenience method that serializes the given DOM Document as a String (encoded in UTF-8), indenting the results and omitting the XML declaration, which is a reasonable way of serializing a MathML document.

serializeDocument(Document, SerializationSpecifier) - Static method in class uk.ac.ed.ph.snuggletex.utilities.MathMLUtilities

Convenience method that serializes the given DOM Document as a String, using the specified SerializationSpecifier, creating any XSLT stylesheet required for serialization on an ad hoc basis.

serializeDocument(Document, SerializationSpecifier, StylesheetManager) - Static method in class uk.ac.ed.ph.snuggletex.utilities.MathMLUtilities

Convenience method that serializes the given DOM Document as a String, using the specified SerializationSpecifier and given StylesheetManager to manage any XSLT stylesheets required to serialize properly.

serializeDocument(Document, String) - Static method in class uk.ac.ed.ph.snuggletex.utilities.MathMLUtilities

Convenience method that serializes the given DOM Document as a String, using the specified encoding, indenting the results and omitting the XML declaration, which is a reasonable way of serializing a MathML document.

serializeDocument(Document, String, boolean) - Static method in class uk.ac.ed.ph.snuggletex.utilities.MathMLUtilities

Convenience method that serializes the given DOM Document as a String, using the specified encoding and indentation options and omitting the XML declaration, which is a reasonable way of serializing a MathML document.

serializeDocument(Document, boolean, boolean) - Static method in class uk.ac.ed.ph.snuggletex.utilities.MathMLUtilities

Deprecated.

Use one of the alternative methods, including MathMLUtilities.serializeDocument(Document, SerializationSpecifier) for ultimate control.

serializeDocument(Document, String, boolean, boolean) - Static method in class uk.ac.ed.ph.snuggletex.utilities.MathMLUtilities

Deprecated.

Use one of the alternative methods, including MathMLUtilities.serializeDocument(Document, SerializationSpecifier) for ultimate control.

serializeElement(Element) - Static method in class uk.ac.ed.ph.snuggletex.utilities.MathMLUtilities

Convenience method that serializes the given DOM Element as a String (encoded in UTF-8), indenting the results and omitting the XML declaration, which is a reasonable way of serializing MathML.

serializeElement(Element, SerializationSpecifier) - Static method in class uk.ac.ed.ph.snuggletex.utilities.MathMLUtilities

Convenience method that serializes the given DOM Element as a String, using the given SerializationSpecifier, creating any XSLT stylesheet required for serialization on an ad hoc basis.

serializeElement(Element, SerializationSpecifier, StylesheetManager) - Static method in class uk.ac.ed.ph.snuggletex.utilities.MathMLUtilities

Convenience method that serializes the given DOM Element as a String, using the given SerializationSpecifier and given StylesheetManager to manage any XSLT stylesheets required to serialize properly.

serializeElement(Element, String) - Static method in class uk.ac.ed.ph.snuggletex.utilities.MathMLUtilities

Convenience method that serializes the given DOM Element as a String, using the given encoding, indenting the results and omitting the XML declaration, which is a reasonable way of serializing MathML.

serializeElement(Element, boolean) - Static method in class uk.ac.ed.ph.snuggletex.utilities.MathMLUtilities

Convenience method that serializes the given DOM Element as a String, indenting if specified and omitting the XML declaration which is a reasonable way of serializing MathML.

serializeElement(Element, boolean, boolean) - Static method in class uk.ac.ed.ph.snuggletex.utilities.MathMLUtilities

Deprecated.

Use one of the alternative methods, including MathMLUtilities.serializeElement(Element, SerializationSpecifier) for ultimate control.

serializeElement(Element, String, boolean, boolean) - Static method in class uk.ac.ed.ph.snuggletex.utilities.MathMLUtilities

Deprecated.

Use MathMLUtilities.serializeElement(Element, SerializationSpecifier) or MathMLUtilities.serializeElement(Element, SerializationSpecifier, StylesheetManager)

serializeElement(Element, String, boolean) - Static method in class uk.ac.ed.ph.snuggletex.utilities.MathMLUtilities

Convenience method that serializes the given DOM Element as a String, using the given parameters.

serializeNode(Node, SerializationSpecifier) - Static method in class uk.ac.ed.ph.snuggletex.internal.util.XMLUtilities

Serializes the given Node to a well-formed external parsed entity.

serializeNode(StylesheetManager, Node, SerializationSpecifier) - Static method in class uk.ac.ed.ph.snuggletex.internal.util.XMLUtilities

Serializes the given Node to a well-formed external parsed entity.

serializeNodeChildren(StylesheetManager, Node, SerializationSpecifier) - Static method in class uk.ac.ed.ph.snuggletex.internal.util.XMLUtilities

Serializes the children of given Node to a well-formed external parsed entity.

SessionConfiguration - Class in uk.ac.ed.ph.snuggletex

Specifies options for how a SnuggleSession should parse and process SnuggleInputs.

SessionConfiguration() - Constructor for class uk.ac.ed.ph.snuggletex.SessionConfiguration

SessionContext - Interface in uk.ac.ed.ph.snuggletex.internal

Provides access to session-related Objects used during the various parts of the snuggle process.

setAddingMathAnnotations(boolean) - Method in class uk.ac.ed.ph.snuggletex.DOMOutputOptions

Deprecated.

Use DOMOutputOptions.setAddingMathSourceAnnotations(boolean) instead

setAddingMathPlayerImport(boolean) - Method in class uk.ac.ed.ph.snuggletex.WebPageOutputOptions

Sets whether to include the necessary processing instruction and object element required to explicitly trigger the MathPlayer plugin.

setAddingMathSourceAnnotations(boolean) - Method in class uk.ac.ed.ph.snuggletex.DOMOutputOptions

Sets whether the MathML math elements generated by SnuggleTeX should be annotated with the LaTeX input used to generate them.

setAddingTitleHeading(boolean) - Method in class uk.ac.ed.ph.snuggletex.WebPageOutputOptions

Sets whether page title should be inserted at the start of the web page body as an XHTML h1 element.

setApplyingFirefox3SemanticsWorkaround(boolean) - Method in class uk.ac.ed.ph.snuggletex.DOMOutputOptions

Specifies whether we should wrap "display math" MathML content within an additional <mstyle displaystyle="true">....

setClientSideXSLTStylesheetURLs(String...) - Method in class uk.ac.ed.ph.snuggletex.WebPageOutputOptions

Sets an array of relative URLs specifying client-side XSLT stylesheets to be referenced in the resulting page.

setCompactingBlankLines(boolean) - Method in class uk.ac.ed.ph.snuggletex.utilities.LaTeXIndenter

setComputedStyle(ComputedStyle) - Method in class uk.ac.ed.ph.snuggletex.tokens.Token

setContentType(String) - Method in class uk.ac.ed.ph.snuggletex.WebPageOutputOptions

Sets the MIME type for the resulting page.

setCSSStylesheetURLs(String...) - Method in class uk.ac.ed.ph.snuggletex.WebPageOutputOptions

Specifies an array of relative URLs specifying client-side CSS stylesheets to be referenced in the resulting page.

setCustomMathJaxUrl(String) - Method in class uk.ac.ed.ph.snuggletex.WebPageOutputOptions

setDecimalFormat(DecimalFormat) - Method in class uk.ac.ed.ph.snuggletex.DecimalFormatNumberMatcher

setDefaultDOMOptions(DOMOutputOptions) - Method in class uk.ac.ed.ph.snuggletex.SnuggleEngine

Deprecated.

Use SnuggleEngine.setDefaultDOMOutputOptions(DOMOutputOptions)

setDefaultDOMOutputOptions(DOMOutputOptions) - Method in class uk.ac.ed.ph.snuggletex.SnuggleEngine

Sets the default DOMOutputOptions for this SnuggleEngine.

setDefaultSessionConfiguration(SessionConfiguration) - Method in class uk.ac.ed.ph.snuggletex.SnuggleEngine

Sets the default SessionConfiguration for this SnuggleEngine.

setDefaultXMLStringOutputOptions(XMLStringOutputOptions) - Method in class uk.ac.ed.ph.snuggletex.SnuggleEngine

Sets the default XMLStringOutputOptions for this SnuggleEngine.

setDoctypePublic(String) - Method in interface uk.ac.ed.ph.snuggletex.SerializationSpecifier

Sets the public identifier to use in the resulting DOCTYPE declaration, as described in OutputKeys.DOCTYPE_PUBLIC.

setDoctypePublic(String) - Method in class uk.ac.ed.ph.snuggletex.utilities.SerializationOptions

Sets the public identifier to use in the resulting DOCTYPE declaration, as described in OutputKeys.DOCTYPE_PUBLIC.

setDoctypePublic(String) - Method in class uk.ac.ed.ph.snuggletex.XMLStringOutputOptions

Sets the public identifier to use in the resulting DOCTYPE declaration, as described in OutputKeys.DOCTYPE_PUBLIC.

setDoctypeSystem(String) - Method in interface uk.ac.ed.ph.snuggletex.SerializationSpecifier

Sets the system identifier to use in the resulting DOCTYPE declaration, as described in OutputKeys.DOCTYPE_SYSTEM.

setDoctypeSystem(String) - Method in class uk.ac.ed.ph.snuggletex.utilities.SerializationOptions

Sets the system identifier to use in the resulting DOCTYPE declaration, as described in OutputKeys.DOCTYPE_SYSTEM.

setDoctypeSystem(String) - Method in class uk.ac.ed.ph.snuggletex.XMLStringOutputOptions

Sets the system identifier to use in the resulting DOCTYPE declaration, as described in OutputKeys.DOCTYPE_SYSTEM.

setDOMPostProcessors(DOMPostProcessor...) - Method in class uk.ac.ed.ph.snuggletex.DOMOutputOptions

Sets the array of DOMPostProcessor that will be called in turn to "fix up" or modify the raw DOM produced by SnuggleTeX immediately after it has been built.

setEncoding(String) - Method in interface uk.ac.ed.ph.snuggletex.SerializationSpecifier

Sets the encoding for the resulting serialized XML.

setEncoding(String) - Method in class uk.ac.ed.ph.snuggletex.SnuggleInput

setEncoding(String) - Method in class uk.ac.ed.ph.snuggletex.utilities.SerializationOptions

Sets the encoding for the resulting serialized XML.

setEncoding(String) - Method in class uk.ac.ed.ph.snuggletex.XMLStringOutputOptions

Sets the encoding for the resulting serialized XML.

setErrorMessageBundle(ResourceBundle) - Method in class uk.ac.ed.ph.snuggletex.SnugglePackage

Sets the ResourceBundle used to format error messages.

setErrorOutputOptions(DOMOutputOptions.ErrorOutputOptions) - Method in class uk.ac.ed.ph.snuggletex.DOMOutputOptions

Sets the current DOMOutputOptions.ErrorOutputOptions, specifying how (and whether) error details should be embedded into the resulting XML.

setExpansionLimit(int) - Method in class uk.ac.ed.ph.snuggletex.SessionConfiguration

Sets the maximum depth when expanding out user-defined commands and environments.

setFailingFast(boolean) - Method in class uk.ac.ed.ph.snuggletex.SessionConfiguration

Sets whether or not the SnuggleSession will fail immediately on error, or keep going.

setFirstBranch(Element) - Method in class uk.ac.ed.ph.snuggletex.utilities.UnwrappedParallelMathMLDOM

Sets the first branch of the top <semantics/> element.

setHtml5(boolean) - Method in class uk.ac.ed.ph.snuggletex.WebPageOutputOptions

setIdentifier(String) - Method in class uk.ac.ed.ph.snuggletex.SnuggleInput

Sets the "identifier" for this input.

setIncludingStyleElement(boolean) - Method in class uk.ac.ed.ph.snuggletex.WebPageOutputOptions

Sets whether to include SnuggleTeX-related CSS as a style element within the resulting page.

setIncludingXMLDeclaration(boolean) - Method in interface uk.ac.ed.ph.snuggletex.SerializationSpecifier

Sets whether to include an XML declaration on the resulting output.

setIncludingXMLDeclaration(boolean) - Method in class uk.ac.ed.ph.snuggletex.utilities.SerializationOptions

Sets whether to include an XML declaration on the resulting output.

setIncludingXMLDeclaration(boolean) - Method in class uk.ac.ed.ph.snuggletex.XMLStringOutputOptions

Sets whether to include an XML declaration on the resulting output.

setIndent(int) - Method in interface uk.ac.ed.ph.snuggletex.SerializationSpecifier

Sets the indentation level to use when SerializationSpecifier.isIndenting() returns true.

setIndent(int) - Method in class uk.ac.ed.ph.snuggletex.utilities.SerializationOptions

Sets the indentation level to use when SerializationOptions.isIndenting() returns true.

setIndent(int) - Method in class uk.ac.ed.ph.snuggletex.XMLStringOutputOptions

Sets the indentation level to use when XMLStringOutputOptions.isIndenting() returns true.

setIndentation(Transformer, int) - Static method in class uk.ac.ed.ph.snuggletex.internal.util.XMLUtilities

Helper to turn on indentation for a Transformer that works correctly for both Saxon and Xalan.

setIndenting(boolean) - Method in interface uk.ac.ed.ph.snuggletex.SerializationSpecifier

Sets whether the resulting XML will be indented or not.

setIndenting(boolean) - Method in class uk.ac.ed.ph.snuggletex.utilities.SerializationOptions

Sets whether the resulting XML will be indented or not.

setIndenting(boolean) - Method in class uk.ac.ed.ph.snuggletex.XMLStringOutputOptions

Sets whether the resulting XML will be indented or not.

setIndentWidth(int) - Method in class uk.ac.ed.ph.snuggletex.internal.util.ObjectDumper

setIndentWidth(int) - Method in class uk.ac.ed.ph.snuggletex.utilities.LaTeXIndenter

setInlineCSSProperties(Properties) - Method in class uk.ac.ed.ph.snuggletex.DOMOutputOptions

Sets the Properties Object that will be used to determine inline CSS properties, if used.

setInliningCSS(boolean) - Method in class uk.ac.ed.ph.snuggletex.DOMOutputOptions

Set whether CSS styling is to be inlined via style attributes or not.

setLang(String) - Method in class uk.ac.ed.ph.snuggletex.WebPageOutputOptions

Sets the language of the resulting page.

setLinkResolver(LinkResolver) - Method in class uk.ac.ed.ph.snuggletex.DOMOutputOptions

Sets the "link resolver" that will be given a chance to fix up any XHTML links created by certain LaTeX inputs.

setMathElement(Element) - Method in class uk.ac.ed.ph.snuggletex.utilities.UnwrappedParallelMathMLDOM

Sets the containing <math/> element

setMathJax(boolean) - Method in class uk.ac.ed.ph.snuggletex.WebPageOutputOptions

setMathMLPrefix(String) - Method in class uk.ac.ed.ph.snuggletex.DOMOutputOptions

Sets the prefix to use for MathML elements when DOMOutputOptions.isPrefixingMathML() returns true.

setMathPrefRenderer(String) - Method in class uk.ac.ed.ph.snuggletex.WebPageOutputOptions

Sets the value of the optional pref:renderer attribute (in the W3CConstants.MATHML_PREF_NAMESPACE) that can be added to the HTML root element to control certain aspects of the client-side Universal StyleSheets for MathML A null value is allowed, which prevents such an attribute being added.

setMathVariantMapping(boolean) - Method in class uk.ac.ed.ph.snuggletex.DOMOutputOptions

Sets whether we should perform automatic mappings of (safe) Unicode characters when applying "stylings" like \\mathcal and \\mathbb.

setMaxDepth(int) - Method in class uk.ac.ed.ph.snuggletex.internal.util.ObjectDumper

setMaxIndentLevel(int) - Method in class uk.ac.ed.ph.snuggletex.utilities.LaTeXIndenter

setNoCharsetInContentTypeHeader(boolean) - Method in class uk.ac.ed.ph.snuggletex.WebPageOutputOptions

setNumberMatcher(NumberMatcher) - Method in class uk.ac.ed.ph.snuggletex.SessionConfiguration

Sets the NumberMatcher used to identify numbers in Math mode input.

setOutputContext(Element, DOMBuilder.OutputContext) - Method in class uk.ac.ed.ph.snuggletex.internal.DOMBuilder

setPrefixingMathML(boolean) - Method in class uk.ac.ed.ph.snuggletex.DOMOutputOptions

Sets whether MathML elements should be prefixed or not.

setPrefixingSnuggleXML(boolean) - Method in class uk.ac.ed.ph.snuggletex.DOMOutputOptions

Sets whether custom SnuggleTeX XML elements should be prefixed or not.

setPrefixingXHTML(boolean) - Method in class uk.ac.ed.ph.snuggletex.DOMOutputOptions

Sets whether XHTML elements should be prefixed or not.

setSerializationMethod(SerializationMethod) - Method in interface uk.ac.ed.ph.snuggletex.SerializationSpecifier

Sets the SerializationMethod to use when generating the final output.

setSerializationMethod(SerializationMethod) - Method in class uk.ac.ed.ph.snuggletex.utilities.SerializationOptions

Sets the SerializationMethod to use when generating the final output.

setSerializationMethod(SerializationMethod) - Method in class uk.ac.ed.ph.snuggletex.XMLStringOutputOptions

Sets the SerializationMethod to use when generating the final output.

setSnuggleXMLPrefix(String) - Method in class uk.ac.ed.ph.snuggletex.DOMOutputOptions

Sets the prefix to use for custom SnuggleTeX XML elements when DOMOutputOptions.isPrefixingSnuggleXML() returns true.

setStylesheetCache(StylesheetCache) - Method in class uk.ac.ed.ph.snuggletex.utilities.StylesheetManager

Sets the StylesheetCache for this manager, which may be null to indicate that no caching should take place.

setStylesheets(Transformer...) - Method in class uk.ac.ed.ph.snuggletex.WebPageOutputOptions

Sets an array of JAXP Transformers representing XSLT stylesheet(s) that will be applied to the resulting web page once it has been built but before it is serialised.

setTitle(String) - Method in class uk.ac.ed.ph.snuggletex.WebPageOutputOptions

Sets the title for the resulting page.

setTransformerFactoryChooser(TransformerFactoryChooser) - Method in class uk.ac.ed.ph.snuggletex.utilities.StylesheetManager

Sets the TransformerFactoryChooser for this StylesheetManager, which is used to initialise TransformerFactory instances.

setURI(URI) - Method in class uk.ac.ed.ph.snuggletex.SnuggleInput

Sets a URI for this input.

setUsingNamedEntities(boolean) - Method in interface uk.ac.ed.ph.snuggletex.SerializationSpecifier

Sets whether to use named entities for certain MathML symbols rather than numeric character references.

setUsingNamedEntities(boolean) - Method in class uk.ac.ed.ph.snuggletex.utilities.SerializationOptions

Sets whether to use named entities for certain MathML symbols rather than numeric character references.

setUsingNamedEntities(boolean) - Method in class uk.ac.ed.ph.snuggletex.XMLStringOutputOptions

Sets whether to use named entities for certain MathML symbols rather than numeric character references.

SetVarHandler - Class in uk.ac.ed.ph.snuggletex.dombuilding

Handles the \\setvar macro.

SetVarHandler() - Constructor for class uk.ac.ed.ph.snuggletex.dombuilding.SetVarHandler

setVariable(String, String, Object) - Method in class uk.ac.ed.ph.snuggletex.internal.VariableManager

setWebPageContentType(Object) - Method in class uk.ac.ed.ph.snuggletex.internal.WebPageBuilder

Calls the setContentType method for the given Object (by reflection) to something appropriate for serving the types of web pages generated by this builder over HTTP.

setWebPageContentType(WebPageOutputOptions, Object) - Method in class uk.ac.ed.ph.snuggletex.SnuggleSession

Calls the setContentType of the given Object to something appropriate for the given WebPageOutputOptions.

setWebPageType(WebPageOutputOptions.WebPageType) - Method in class uk.ac.ed.ph.snuggletex.WebPageOutputOptions

Deprecated.

Use various methods in WebPageOutputOptionsBuilder to generate suitable options for various types of pages, which you can then tweak.

setXHTMLPrefix(String) - Method in class uk.ac.ed.ph.snuggletex.DOMOutputOptions

Sets the prefix to use for XHTML elements when DOMOutputOptions.isPrefixingXHTML() returns true.

sharesDocumentWith(FrozenSlice) - Method in class uk.ac.ed.ph.snuggletex.internal.FrozenSlice

SimpleNumberMatcher - Class in uk.ac.ed.ph.snuggletex

Very basic but fast implementation of NumberMatcher that handles western-style numeric characters, supporting Locale-specific decimal points.

SimpleNumberMatcher() - Constructor for class uk.ac.ed.ph.snuggletex.SimpleNumberMatcher

SimpleNumberMatcher(Locale) - Constructor for class uk.ac.ed.ph.snuggletex.SimpleNumberMatcher

SimpleStylesheetCache - Class in uk.ac.ed.ph.snuggletex.utilities

Trivial implementation of StylesheetCache that simply caches all stylesheets in a HashMap.

SimpleStylesheetCache() - Constructor for class uk.ac.ed.ph.snuggletex.utilities.SimpleStylesheetCache

SimpleToken - Class in uk.ac.ed.ph.snuggletex.tokens

Represents a "simple" LaTeX token.

SimpleToken(FrozenSlice, TokenType, LaTeXMode, TextFlowContext, Interpretation...) - Constructor for class uk.ac.ed.ph.snuggletex.tokens.SimpleToken

SimpleToken(FrozenSlice, TokenType, LaTeXMode, TextFlowContext, EnumMap<InterpretationType, Interpretation>) - Constructor for class uk.ac.ed.ph.snuggletex.tokens.SimpleToken

SimpleXHTMLContainerBuildingHandler - Class in uk.ac.ed.ph.snuggletex.dombuilding

This trivial handler takes an Environment or 1-argument Command and simply maps it to an XHTML element with the given name and CSS class.

SimpleXHTMLContainerBuildingHandler(String) - Constructor for class uk.ac.ed.ph.snuggletex.dombuilding.SimpleXHTMLContainerBuildingHandler

SimpleXHTMLContainerBuildingHandler(String, String) - Constructor for class uk.ac.ed.ph.snuggletex.dombuilding.SimpleXHTMLContainerBuildingHandler

slice - Variable in class uk.ac.ed.ph.snuggletex.internal.WorkingDocument.IndexResolution

Slice(int, int, WorkingDocument.CharacterSource, int) - Constructor for class uk.ac.ed.ph.snuggletex.internal.WorkingDocument.Slice

slice - Variable in class uk.ac.ed.ph.snuggletex.tokens.Token

Extent of this entire token

SnuggleConstants - Interface in uk.ac.ed.ph.snuggletex

Public SnuggleTeX-related constants.

SnuggleEngine - Class in uk.ac.ed.ph.snuggletex

This is the main entry point into SnuggleTeX.

SnuggleEngine() - Constructor for class uk.ac.ed.ph.snuggletex.SnuggleEngine

Creates a new SnuggleEngine using a very simple internal cache for any XSLT stylesheets required that simply stores them internally for the lifetime of the engine.

SnuggleEngine(StylesheetCache) - Constructor for class uk.ac.ed.ph.snuggletex.SnuggleEngine

Creates a new SnuggleEngine using the given StylesheetCache for managing stylesheets.

SnuggleEngine(TransformerFactoryChooser, StylesheetCache) - Constructor for class uk.ac.ed.ph.snuggletex.SnuggleEngine

Creates a new SnuggleEngine using the given StylesheetCache for managing stylesheets and given TransformerFactoryChooser for choosing which XSLT implementation to use.

SnuggleEngine(StylesheetManager) - Constructor for class uk.ac.ed.ph.snuggletex.SnuggleEngine

Creates a new SnuggleEngine using the given StylesheetManager for managing stylesheets.

SnuggleInput - Class in uk.ac.ed.ph.snuggletex

Simple container for an input into SnuggleTeX.

SnuggleInput(String) - Constructor for class uk.ac.ed.ph.snuggletex.SnuggleInput

SnuggleInput(String, String) - Constructor for class uk.ac.ed.ph.snuggletex.SnuggleInput

SnuggleInput(File) - Constructor for class uk.ac.ed.ph.snuggletex.SnuggleInput

SnuggleInput(File, String) - Constructor for class uk.ac.ed.ph.snuggletex.SnuggleInput

SnuggleInput(File, String, String) - Constructor for class uk.ac.ed.ph.snuggletex.SnuggleInput

SnuggleInput(InputStream) - Constructor for class uk.ac.ed.ph.snuggletex.SnuggleInput

SnuggleInput(InputStream, String) - Constructor for class uk.ac.ed.ph.snuggletex.SnuggleInput

SnuggleInput(InputStream, String, String) - Constructor for class uk.ac.ed.ph.snuggletex.SnuggleInput

SnuggleInput(Reader) - Constructor for class uk.ac.ed.ph.snuggletex.SnuggleInput

SnuggleInput(Reader, String) - Constructor for class uk.ac.ed.ph.snuggletex.SnuggleInput

SnuggleInput.InputType - Enum in uk.ac.ed.ph.snuggletex

Enumerates the various types of inputs we support.

SnuggleInputReader - Class in uk.ac.ed.ph.snuggletex.internal

Helper class that does the job of taking a SnuggleInput, checking its contents for allowed Unicode characters, working out how to map absolute offsets into (line,column) pairs and producing a WorkingDocument for later use.

SnuggleInputReader(SessionContext, SnuggleInput) - Constructor for class uk.ac.ed.ph.snuggletex.internal.SnuggleInputReader

SnuggleLogicException - Exception in uk.ac.ed.ph.snuggletex

This RuntimeException is thrown if SnuggleTeX has detected something amiss with its logic.

SnuggleLogicException() - Constructor for exception uk.ac.ed.ph.snuggletex.SnuggleLogicException

SnuggleLogicException(String, Throwable) - Constructor for exception uk.ac.ed.ph.snuggletex.SnuggleLogicException

SnuggleLogicException(String) - Constructor for exception uk.ac.ed.ph.snuggletex.SnuggleLogicException

SnuggleLogicException(Throwable) - Constructor for exception uk.ac.ed.ph.snuggletex.SnuggleLogicException

SnugglePackage - Class in uk.ac.ed.ph.snuggletex

A SnugglePackage defines a collection of BuiltinCommands, BuiltinEnvironments, and ErrorCodes/ErrorGroups that can be registered with a SnuggleEngine to add in extra functionality.

SnugglePackage(String) - Constructor for class uk.ac.ed.ph.snuggletex.SnugglePackage

SnuggleParseException - Exception in uk.ac.ed.ph.snuggletex.internal

Internal Exception thrown by SnuggleSession.registerError(InputError) when a parsing error occurs and the client has requested immediate failure in such circumstances.

SnuggleParseException(InputError) - Constructor for exception uk.ac.ed.ph.snuggletex.internal.SnuggleParseException

SnuggleRuntimeException - Exception in uk.ac.ed.ph.snuggletex

This RuntimeException is used to indicate a problem within SnuggleTeX which is due to a mis-configuration of SnuggleTeX, rather than a problem with client input or bad logic within SnuggleTeX.

SnuggleRuntimeException() - Constructor for exception uk.ac.ed.ph.snuggletex.SnuggleRuntimeException

SnuggleRuntimeException(String, Throwable) - Constructor for exception uk.ac.ed.ph.snuggletex.SnuggleRuntimeException

SnuggleRuntimeException(String) - Constructor for exception uk.ac.ed.ph.snuggletex.SnuggleRuntimeException

SnuggleRuntimeException(Throwable) - Constructor for exception uk.ac.ed.ph.snuggletex.SnuggleRuntimeException

SnuggleSession - Class in uk.ac.ed.ph.snuggletex

This represents a single "job" for SnuggleTeX.

SnuggleSession.EndOutputAction - Enum in uk.ac.ed.ph.snuggletex

Trivial enumeration which specifies the possible actions to perform once we finish writing with the various SnuggleSession.writeWebPage(WebPageOutputOptions, OutputStream) methods.

SnuggleSimpleMathRunner - Class in uk.ac.ed.ph.snuggletex

FIXME: Document this type!

SnuggleSnapshot - Class in uk.ac.ed.ph.snuggletex

A partial result of parsing one or more SnuggleInputs by a SnuggleSession, created via SnuggleSession.createSnapshot().

SNUGGLETEX_MATHML_ANNOTATION_ENCODING - Static variable in interface uk.ac.ed.ph.snuggletex.SnuggleConstants

Deprecated.

Please use SnuggleConstants.SNUGGLETEX_MATHML_SOURCE_ANNOTATION_ENCODING from now on.

SNUGGLETEX_MATHML_SOURCE_ANNOTATION_ENCODING - Static variable in interface uk.ac.ed.ph.snuggletex.SnuggleConstants

Value of the "encoding" attribute added to MathML element annotation elements, used when DOMOutputOptions.isAddingMathSourceAnnotations() returns true.

SNUGGLETEX_NAMESPACE - Static variable in interface uk.ac.ed.ph.snuggletex.SnuggleConstants

Namespace for any SnuggleTeX-specific XML elements produced

SnuggleUtilities - Class in uk.ac.ed.ph.snuggletex.utilities

A collection of occasionally useful SnuggleTeX-related utility methods, as well as some more general LaTeX stuff.

SnuggleUtilities() - Constructor for class uk.ac.ed.ph.snuggletex.utilities.SnuggleUtilities

SpaceHandler - Class in uk.ac.ed.ph.snuggletex.dombuilding

Creates preset spacing elements in MATH and/or TEXT modes.

SpaceHandler(String, String) - Constructor for class uk.ac.ed.ph.snuggletex.dombuilding.SpaceHandler

startIndex - Variable in class uk.ac.ed.ph.snuggletex.internal.FrozenSlice

startIndex - Variable in class uk.ac.ed.ph.snuggletex.internal.WorkingDocument.Slice

startPosition - Variable in class uk.ac.ed.ph.snuggletex.internal.LaTeXTokeniser.ModeState

Position within WorkingDocument where this mode started

StringTerminator(String) - Constructor for class uk.ac.ed.ph.snuggletex.internal.LaTeXTokeniser.StringTerminator

StringUtilities - Class in uk.ac.ed.ph.snuggletex.internal.util

Some vaguely useful String-related methods that are used from time to time.

StringUtilities() - Constructor for class uk.ac.ed.ph.snuggletex.internal.util.StringUtilities

STRIP_ALL_NAMESPACES_XSL_RESOURCE_NAME - Static variable in class uk.ac.ed.ph.snuggletex.definitions.Globals

Specifies the ClassPath location of the all XML -> no namespace used for serializing as legacy HTML

STRIP_XHTML_NAMESPACE_XSL_RESOURCE_NAME - Static variable in class uk.ac.ed.ph.snuggletex.definitions.Globals

Specifies the ClassPath location of the XHTML -> no namespace used for serializing as legacy HTML

STYLE_SENTINEL - Static variable in interface uk.ac.ed.ph.snuggletex.semantics.Interpretation

StyleDeclarationInterpretation - Enum in uk.ac.ed.ph.snuggletex.semantics

Represents styled text in either MATH and/or TEXT Modes.

StyleEvaluator - Class in uk.ac.ed.ph.snuggletex.internal

This calculates the ComputedStyle for each raw parsed Token.

StyleEvaluator(SessionContext) - Constructor for class uk.ac.ed.ph.snuggletex.internal.StyleEvaluator

StyleHandler - Class in uk.ac.ed.ph.snuggletex.dombuilding

Handles the internal <style> environment delimiting a branch of content to be rendered in a different style.

StyleHandler() - Constructor for class uk.ac.ed.ph.snuggletex.dombuilding.StyleHandler

StyleRebuilder - Class in uk.ac.ed.ph.snuggletex.internal

This runs after TokenFixer and groups style changes together using the pseudo-environment CorePackageDefinitions.ENV_STYLE, which makes DOM building much easier.

StyleRebuilder(SessionContext) - Constructor for class uk.ac.ed.ph.snuggletex.internal.StyleRebuilder

StylesheetCache - Interface in uk.ac.ed.ph.snuggletex.utilities

Encapsulates a simple cache for the internal XSLT stylesheets used by SnuggleTeX.

StylesheetManager - Class in uk.ac.ed.ph.snuggletex.utilities

Trivial helper class to manage the loading of SnuggleTeX's internal stylesheets, using a StylesheetCache to cache stylesheets for performance.

StylesheetManager() - Constructor for class uk.ac.ed.ph.snuggletex.utilities.StylesheetManager

Creates a new StylesheetManager using the DefaultTransformerFactoryChooser and no StylesheetCache.

StylesheetManager(StylesheetCache) - Constructor for class uk.ac.ed.ph.snuggletex.utilities.StylesheetManager

Creates a new StylesheetManager using the DefaultTransformerFactoryChooser and the given StylesheetCache.

StylesheetManager(TransformerFactoryChooser, StylesheetCache) - Constructor for class uk.ac.ed.ph.snuggletex.utilities.StylesheetManager

Creates a new StylesheetManager using the given TransformerFactoryChooser and StylesheetCache.

substitute(int, int, CharSequence) - Method in class uk.ac.ed.ph.snuggletex.internal.WorkingDocument

substitutedSource - Variable in class uk.ac.ed.ph.snuggletex.internal.WorkingDocument.CharacterSource

The block that this block was initially substituted into, or null to indicate that it is "top level" or was appended rather than substituted.

substitutedText - Variable in class uk.ac.ed.ph.snuggletex.internal.WorkingDocument.CharacterSource

The text in the parent component that this data replaced, or null if WorkingDocument.CharacterSource.substitutedSource is null.

SubstitutionContext(CharSequence) - Constructor for class uk.ac.ed.ph.snuggletex.internal.WorkingDocument.SubstitutionContext

substitutionOffset - Variable in class uk.ac.ed.ph.snuggletex.internal.WorkingDocument.CharacterSource

The offset in WorkingDocument.CharacterSource.substitutedSource where the substitution occurred, or 0 if WorkingDocument.CharacterSource.substitutedSource is null.

supportsXSLT20(TransformerFactory) - Static method in class uk.ac.ed.ph.snuggletex.internal.util.XMLUtilities

Tests whether the given TransformerFactory is known to support XSLT 2.0.

supportsXSLT20(Transformer) - Static method in class uk.ac.ed.ph.snuggletex.internal.util.XMLUtilities

supportsXSLT20() - Method in class uk.ac.ed.ph.snuggletex.utilities.StylesheetManager

Returns whether or not XSLT 2.0 is supported, by asking the underlying TransformerFactoryChooser.

T

TABULAR - Static variable in interface uk.ac.ed.ph.snuggletex.semantics.Interpretation

TabularHandler - Class in uk.ac.ed.ph.snuggletex.dombuilding

Handles the (rather complex) tabular environment.

TabularHandler() - Constructor for class uk.ac.ed.ph.snuggletex.dombuilding.TabularHandler

TagHandler - Class in uk.ac.ed.ph.snuggletex.dombuilding

TagHandler() - Constructor for class uk.ac.ed.ph.snuggletex.dombuilding.TagHandler

terminator - Variable in class uk.ac.ed.ph.snuggletex.internal.LaTeXTokeniser.ModeState

Terminator we are searching for

texName - Variable in class uk.ac.ed.ph.snuggletex.definitions.UserDefinedCommandOrEnvironment

TEXT_MODE_ONLY - Static variable in class uk.ac.ed.ph.snuggletex.definitions.Globals

TextClassHandler - Class in uk.ac.ed.ph.snuggletex.dombuilding

Handles things like the \\underline command, which are simpler than the classic LaTeX style controls.

TextClassHandler(String) - Constructor for class uk.ac.ed.ph.snuggletex.dombuilding.TextClassHandler

TextFlowContext - Enum in uk.ac.ed.ph.snuggletex.definitions

This enumeration specifies how text-based FlowTokens should be handled when being merged into the resulting XHTML DOM.

textFlowContext - Variable in class uk.ac.ed.ph.snuggletex.tokens.FlowToken

TextHandler - Class in uk.ac.ed.ph.snuggletex.dombuilding

TextHandler() - Constructor for class uk.ac.ed.ph.snuggletex.dombuilding.TextHandler

TextSafeInterpretableMathIdentifierHandler - Class in uk.ac.ed.ph.snuggletex.dombuilding

Used for things like \\ldots, which work in both Math and Text modes

TextSafeInterpretableMathIdentifierHandler() - Constructor for class uk.ac.ed.ph.snuggletex.dombuilding.TextSafeInterpretableMathIdentifierHandler

TILDE - Static variable in interface uk.ac.ed.ph.snuggletex.definitions.AccentMaps

Token - Class in uk.ac.ed.ph.snuggletex.tokens

Base interface for a parsed SnuggleTeX token.

Token(FrozenSlice, TokenType, LaTeXMode, Interpretation...) - Constructor for class uk.ac.ed.ph.snuggletex.tokens.Token

Token(FrozenSlice, TokenType, LaTeXMode, EnumMap<InterpretationType, Interpretation>) - Constructor for class uk.ac.ed.ph.snuggletex.tokens.Token

TokenFixer - Class in uk.ac.ed.ph.snuggletex.internal

This takes the parse tree after StyleEvaluator has run and performs grouping operations on the FlowTokens to convert them to a more tree-like structure that is easier to handle.

TokenFixer(SessionContext) - Constructor for class uk.ac.ed.ph.snuggletex.internal.TokenFixer

tokenisationMode - Variable in class uk.ac.ed.ph.snuggletex.internal.LaTeXTokeniser.ModeState

Mode we're tokenising in

tokenise(SnuggleInputReader) - Method in class uk.ac.ed.ph.snuggletex.internal.LaTeXTokeniser

Tokenises the input specified by the given SnuggleInputReader, returning an ArgumentContainerToken containing the roots of the parsed token tree.

tokens - Variable in class uk.ac.ed.ph.snuggletex.internal.LaTeXTokeniser.ModeState

Tokens accumulated in this mode

TokenType - Enum in uk.ac.ed.ph.snuggletex.tokens

Enumerates the various types of LaTeX tokens.

toString() - Method in class uk.ac.ed.ph.snuggletex.definitions.ComputedStyle

toString() - Method in class uk.ac.ed.ph.snuggletex.definitions.MathCharacter

toString() - Method in class uk.ac.ed.ph.snuggletex.definitions.UserDefinedCommandOrEnvironment

toString() - Method in class uk.ac.ed.ph.snuggletex.InputError

toString() - Method in class uk.ac.ed.ph.snuggletex.internal.FrozenSlice

toString() - Method in class uk.ac.ed.ph.snuggletex.internal.LaTeXTokeniser.PatternTerminator

toString() - Method in class uk.ac.ed.ph.snuggletex.internal.LaTeXTokeniser.StringTerminator

toString() - Method in class uk.ac.ed.ph.snuggletex.internal.WorkingDocument.CharacterSource

toString() - Method in class uk.ac.ed.ph.snuggletex.internal.WorkingDocument.IndexResolution

toString() - Method in class uk.ac.ed.ph.snuggletex.internal.WorkingDocument.Slice

toString() - Method in class uk.ac.ed.ph.snuggletex.internal.WorkingDocument.SubstitutionContext

toString() - Method in class uk.ac.ed.ph.snuggletex.semantics.MathBigLimitOwnerInterpretation

toString() - Method in class uk.ac.ed.ph.snuggletex.semantics.MathBracketInterpretation

toString() - Method in class uk.ac.ed.ph.snuggletex.semantics.MathCharacterInterpretation

toString() - Method in class uk.ac.ed.ph.snuggletex.semantics.MathFunctionInterpretation

toString() - Method in class uk.ac.ed.ph.snuggletex.semantics.MathIdentifierInterpretation

toString() - Method in class uk.ac.ed.ph.snuggletex.semantics.MathNegatableInterpretation

toString() - Method in class uk.ac.ed.ph.snuggletex.semantics.MathNumberInterpretation

toString() - Method in class uk.ac.ed.ph.snuggletex.semantics.MathOperatorInterpretation

toString() - Method in class uk.ac.ed.ph.snuggletex.SessionConfiguration

toString() - Method in class uk.ac.ed.ph.snuggletex.SnuggleInput

toString() - Method in class uk.ac.ed.ph.snuggletex.tokens.Token

toString() - Method in class uk.ac.ed.ph.snuggletex.utilities.SerializationOptions

toString() - Method in class uk.ac.ed.ph.snuggletex.utilities.SimpleStylesheetCache

toTrueFalse(boolean) - Static method in class uk.ac.ed.ph.snuggletex.internal.util.StringUtilities

Trivial helper method to convert a boolean into either "true" or "false" depending on its state.

toYesNo(boolean) - Static method in class uk.ac.ed.ph.snuggletex.internal.util.StringUtilities

Trivial helper method to convert a boolean into either "yes" or "no" depending on its state.

transfer(InputStream, OutputStream) - Static method in class uk.ac.ed.ph.snuggletex.internal.util.IOUtilities

"Transfers" data from the given InputStream to the given OutputStream, closing both streams once the InputStream has been exhausted.

transfer(FileInputStream, FileOutputStream) - Static method in class uk.ac.ed.ph.snuggletex.internal.util.IOUtilities

Version of IOUtilities.transfer(InputStream, OutputStream) for File streams that uses NIO to do a hopefully more efficient transfer.

transfer(InputStream, OutputStream, boolean) - Static method in class uk.ac.ed.ph.snuggletex.internal.util.IOUtilities

"Transfers" data from the given InputStream to the given OutputStream, closing the InputStream afterwards.

transfer(InputStream, OutputStream, boolean, boolean) - Static method in class uk.ac.ed.ph.snuggletex.internal.util.IOUtilities

"Transfers" data from the given InputStream to the given OutputStream, optionally closing the given input and output streams afterwards.

TransformerFactoryChooser - Interface in uk.ac.ed.ph.snuggletex.utilities

This interface allows you to specify how XSLT implementations should be instantiated.

type - Variable in class uk.ac.ed.ph.snuggletex.tokens.Token

Classifies the token

U

uk.ac.ed.ph.snuggletex - package uk.ac.ed.ph.snuggletex

Public API Package - almost all of the classes you will need for normal SnuggleTeX use are contained in here.

uk.ac.ed.ph.snuggletex.definitions - package uk.ac.ed.ph.snuggletex.definitions

Defines built-in commands, environments, accent maps, globals and related concepts.

uk.ac.ed.ph.snuggletex.dombuilding - package uk.ac.ed.ph.snuggletex.dombuilding

Contains handler classes for building DOM tree branches for various commands and environments.

uk.ac.ed.ph.snuggletex.internal - package uk.ac.ed.ph.snuggletex.internal

This package contains the guts of SnuggleTeX; classes here are responsible for the parsing process, token fixing and DOM/web building.

uk.ac.ed.ph.snuggletex.internal.util - package uk.ac.ed.ph.snuggletex.internal.util

uk.ac.ed.ph.snuggletex.samples - package uk.ac.ed.ph.snuggletex.samples

Contains sample Java code

uk.ac.ed.ph.snuggletex.semantics - package uk.ac.ed.ph.snuggletex.semantics

Internal package defining "semantic" intepretations to be attached to parsed tokens.

uk.ac.ed.ph.snuggletex.tokens - package uk.ac.ed.ph.snuggletex.tokens

Internal package defining the various types of LaTeX tokens produced by the parsing process.

uk.ac.ed.ph.snuggletex.utilities - package uk.ac.ed.ph.snuggletex.utilities

Public utility classes, plus some more general but occasionally useful helpers for dealing with LaTeX.

UMLAUT - Static variable in interface uk.ac.ed.ph.snuggletex.definitions.AccentMaps

unfreeze(int) - Method in class uk.ac.ed.ph.snuggletex.internal.WorkingDocument

This is a rather nasty method which resets the "freeze index" of this document back to the given index.

UnitsHandler - Class in uk.ac.ed.ph.snuggletex.dombuilding

Handles \\units, generating an mi element of the form: <mi mathvariant="normal" class="MathML-Unit">...

UnitsHandler() - Constructor for class uk.ac.ed.ph.snuggletex.dombuilding.UnitsHandler

unwrapParallelMathMLDOM(Element) - Static method in class uk.ac.ed.ph.snuggletex.utilities.MathMLUtilities

Convenience method to unwrap at MathML DOM Object containing top-level parallel markup, as defined Section 5.3.1 of the MathML 2.0 specification.

UnwrappedParallelMathMLDOM - Class in uk.ac.ed.ph.snuggletex.utilities

Trivial wrapper Object that encapsulates the results of MathMLUtilities.unwrapParallelMathMLDOM(Element).

UnwrappedParallelMathMLDOM() - Constructor for class uk.ac.ed.ph.snuggletex.utilities.UnwrappedParallelMathMLDOM

URI_SCHEME - Static variable in class uk.ac.ed.ph.snuggletex.utilities.ClassPathURIResolver

UserDefinedCommand - Class in uk.ac.ed.ph.snuggletex.definitions

Represents a user-defined Command, i.e. one defined in the client data using \\newcommand.

UserDefinedCommand(String, String, int, FrozenSlice) - Constructor for class uk.ac.ed.ph.snuggletex.definitions.UserDefinedCommand

UserDefinedCommandOrEnvironment - Class in uk.ac.ed.ph.snuggletex.definitions

Partial base class for UserDefinedCommands and UserDefinedEnvironments.

UserDefinedCommandOrEnvironment(String, String, int) - Constructor for class uk.ac.ed.ph.snuggletex.definitions.UserDefinedCommandOrEnvironment

UserDefinedEnvironment - Class in uk.ac.ed.ph.snuggletex.definitions

Represents a user-defined environment, created by clients using the \\newenvironment command.

UserDefinedEnvironment(String, String, int, FrozenSlice, FrozenSlice) - Constructor for class uk.ac.ed.ph.snuggletex.definitions.UserDefinedEnvironment

V

validateURI(Element, Token, String) - Method in class uk.ac.ed.ph.snuggletex.internal.DOMBuilder

Checks the given raw URI to ensure that it is valid, returning a URI Object if valid or null if not.

validateXMLId(Element, Token, String) - Method in class uk.ac.ed.ph.snuggletex.internal.DOMBuilder

Checks the given XML Name as in DOMBuilder.validateXMLName(Element, Token, String), additionally checking that an ID of the same name is not already in use in the output DOM.

validateXMLName(Element, Token, String) - Method in class uk.ac.ed.ph.snuggletex.internal.DOMBuilder

Checks the given raw XML Name to ensure that it confirms to the correct syntax, returning it unchanged if successful.

valueOf(String) - Static method in enum uk.ac.ed.ph.snuggletex.definitions.CommandType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum uk.ac.ed.ph.snuggletex.definitions.ComputedStyle.FontFamily

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum uk.ac.ed.ph.snuggletex.definitions.ComputedStyle.FontSize

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum uk.ac.ed.ph.snuggletex.definitions.CoreErrorCode

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum uk.ac.ed.ph.snuggletex.definitions.CoreErrorGroup

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum uk.ac.ed.ph.snuggletex.definitions.LaTeXMode

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum uk.ac.ed.ph.snuggletex.definitions.MathCharacter.MathCharacterType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum uk.ac.ed.ph.snuggletex.definitions.TextFlowContext

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum uk.ac.ed.ph.snuggletex.DOMOutputOptions.ErrorOutputOptions

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum uk.ac.ed.ph.snuggletex.internal.DOMBuilder.OutputContext

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum uk.ac.ed.ph.snuggletex.internal.LaTeXTokeniser.TokenisationMode

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum uk.ac.ed.ph.snuggletex.internal.util.DumpMode

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum uk.ac.ed.ph.snuggletex.internal.util.PropertyOptions

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum uk.ac.ed.ph.snuggletex.semantics.InterpretationType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum uk.ac.ed.ph.snuggletex.semantics.MathBracketInterpretation.BracketType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum uk.ac.ed.ph.snuggletex.semantics.StyleDeclarationInterpretation

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum uk.ac.ed.ph.snuggletex.SerializationMethod

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum uk.ac.ed.ph.snuggletex.SnuggleInput.InputType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum uk.ac.ed.ph.snuggletex.SnuggleSession.EndOutputAction

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum uk.ac.ed.ph.snuggletex.tokens.TokenType

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum uk.ac.ed.ph.snuggletex.WebPageOutputOptions.WebPageType

Deprecated.

Returns the enum constant of this type with the specified name.

values() - Static method in enum uk.ac.ed.ph.snuggletex.definitions.CommandType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum uk.ac.ed.ph.snuggletex.definitions.ComputedStyle.FontFamily

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum uk.ac.ed.ph.snuggletex.definitions.ComputedStyle.FontSize

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum uk.ac.ed.ph.snuggletex.definitions.CoreErrorCode

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum uk.ac.ed.ph.snuggletex.definitions.CoreErrorGroup

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum uk.ac.ed.ph.snuggletex.definitions.LaTeXMode

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum uk.ac.ed.ph.snuggletex.definitions.MathCharacter.MathCharacterType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum uk.ac.ed.ph.snuggletex.definitions.TextFlowContext

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum uk.ac.ed.ph.snuggletex.DOMOutputOptions.ErrorOutputOptions

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum uk.ac.ed.ph.snuggletex.internal.DOMBuilder.OutputContext

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum uk.ac.ed.ph.snuggletex.internal.LaTeXTokeniser.TokenisationMode

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum uk.ac.ed.ph.snuggletex.internal.util.DumpMode

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum uk.ac.ed.ph.snuggletex.internal.util.PropertyOptions

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum uk.ac.ed.ph.snuggletex.semantics.InterpretationType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum uk.ac.ed.ph.snuggletex.semantics.MathBracketInterpretation.BracketType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum uk.ac.ed.ph.snuggletex.semantics.StyleDeclarationInterpretation

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum uk.ac.ed.ph.snuggletex.SerializationMethod

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum uk.ac.ed.ph.snuggletex.SnuggleInput.InputType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum uk.ac.ed.ph.snuggletex.SnuggleSession.EndOutputAction

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum uk.ac.ed.ph.snuggletex.tokens.TokenType

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum uk.ac.ed.ph.snuggletex.WebPageOutputOptions.WebPageType

Deprecated.

Returns an array containing the constants of this enum type, in the order they are declared.

VariableManager - Class in uk.ac.ed.ph.snuggletex.internal

Manages the values of user-defined variables.

VariableManager() - Constructor for class uk.ac.ed.ph.snuggletex.internal.VariableManager

VerbatimHandler - Class in uk.ac.ed.ph.snuggletex.dombuilding

Handles the verbatim environment and \\verb command.

VerbatimHandler(boolean) - Constructor for class uk.ac.ed.ph.snuggletex.dombuilding.VerbatimHandler

W

W3C_BASE_URI - Static variable in interface uk.ac.ed.ph.snuggletex.definitions.W3CConstants

Base for W3C-related stuff

W3CConstants - Interface in uk.ac.ed.ph.snuggletex.definitions

A collection of useful constants for various W3C-related topics (e.g. system identifiers, namespaces, etc...).

WebPageBuilder - Class in uk.ac.ed.ph.snuggletex.internal

Builds a web page from a List of fixed FlowTokens, using the supplied WebPageOutputOptions to determine the exact form of the results.

WebPageBuilder(SessionContext, WebPageOutputOptions) - Constructor for class uk.ac.ed.ph.snuggletex.internal.WebPageBuilder

WebPageExample - Class in uk.ac.ed.ph.snuggletex.samples

Example demonstrating using SnuggleTeX to create an HTML 5 + MathJax web page, outputting the resulting web page content to the console.

WebPageExample() - Constructor for class uk.ac.ed.ph.snuggletex.samples.WebPageExample

WebPageOutputOptions - Class in uk.ac.ed.ph.snuggletex

Builds on XMLStringOutputOptions to add in options for configuring how to build a web page using the relevant methods in SnuggleSession (e.g.

WebPageOutputOptions() - Constructor for class uk.ac.ed.ph.snuggletex.WebPageOutputOptions

WebPageOutputOptions.WebPageType - Enum in uk.ac.ed.ph.snuggletex

Deprecated.

Use WebPageOutputOptionsBuilder to generate different types of web pages. More properties have been added to this class to control some of the finer aspects of this.

WebPageOutputOptionsBuilder - Class in uk.ac.ed.ph.snuggletex

Utility class that creates pre-configured and usable WebPageOutputOptions instances for various common scenarios.

WebPageOutputOptionsBuilder() - Constructor for class uk.ac.ed.ph.snuggletex.WebPageOutputOptionsBuilder

WebPageOutputOptionsTemplates - Class in uk.ac.ed.ph.snuggletex

Deprecated.

As of SnuggleTeX 1.3.0, use WebPageOutputOptionsBuilder. This class will be removed in SnuggleTeX 1.4.

WebPageOutputOptionsTemplates() - Constructor for class uk.ac.ed.ph.snuggletex.WebPageOutputOptionsTemplates

Deprecated.

WorkingDocument - Class in uk.ac.ed.ph.snuggletex.internal

Represents the "working view" of the current SnuggleInput document.

WorkingDocument.CharacterSource - Class in uk.ac.ed.ph.snuggletex.internal

Represents a block of text that has been imported into this document.

WorkingDocument.IndexResolution - Class in uk.ac.ed.ph.snuggletex.internal

Holds information about how a particular index in the document is resolved against the WorkingDocument.Slice in which it is contained.

WorkingDocument.Slice - Class in uk.ac.ed.ph.snuggletex.internal

Represents a contiguous portion of the document hat comes from the same WorkingDocument.CharacterSource.

WorkingDocument.SourceContext - Interface in uk.ac.ed.ph.snuggletex.internal

Marker interface that can be applied to classes that provide information for a WorkingDocument.CharacterSource.

WorkingDocument.SubstitutionContext - Class in uk.ac.ed.ph.snuggletex.internal

Implementation of WorkingDocument.SourceContext that represents the result of a substitution.

writeDefaultStylesheet() - Static method in class uk.ac.ed.ph.snuggletex.utilities.CSSUtilities

Writes out the "default" CSS stylesheet specified via CSSUtilities.readBuiltinInlineCSSProperties(), returning the result as a String.

writeDefaultStylesheet(OutputStream) - Static method in class uk.ac.ed.ph.snuggletex.utilities.CSSUtilities

Writes out the "default" CSS stylesheet specified via CSSUtilities.readBuiltinInlineCSSProperties(), saving the results to the given OutputStream.

writeStylesheet(DOMOutputOptions, OutputStream) - Static method in class uk.ac.ed.ph.snuggletex.utilities.CSSUtilities

Writes out the CSS stylesheet specified via the given DOMOutputOptions Object, using the default if nothing has been specified, saving the results to the given OutputStream.

writeStylesheet(Properties) - Static method in class uk.ac.ed.ph.snuggletex.utilities.CSSUtilities

Writes out the CSS stylesheet made from the given cssProperties, returning the result as a String.

writeStylesheet(Properties, OutputStream) - Static method in class uk.ac.ed.ph.snuggletex.utilities.CSSUtilities

Writes out the CSS stylesheet made from the given cssProperties, saving the results to the given OutputStream.

writeStylesheet(Properties, Writer) - Static method in class uk.ac.ed.ph.snuggletex.utilities.CSSUtilities

Writes out the CSS stylesheet made from the given cssProperties, saving the results to the given Writer.

writeWebPage(List<FlowToken>, Object, OutputStream, SnuggleSession.EndOutputAction) - Method in class uk.ac.ed.ph.snuggletex.internal.WebPageBuilder

Creates a web page representing the given (fixed) Tokens, and writes the results to the given OutputStream.

writeWebPage(WebPageOutputOptions, OutputStream) - Method in class uk.ac.ed.ph.snuggletex.SnuggleSession

Builds a complete web page based on the currently parsed tokens, sending the results to the given OutputStream, which is closed afterwards.

writeWebPage(WebPageOutputOptions, OutputStream, SnuggleSession.EndOutputAction) - Method in class uk.ac.ed.ph.snuggletex.SnuggleSession

Builds a complete web page based on the currently parsed tokens, sending the results to the given OutputStream and performing the given SnuggleSession.EndOutputAction to it afterwards (i.e. close, flush or do nothing).

writeWebPage(WebPageOutputOptions, Object, OutputStream) - Method in class uk.ac.ed.ph.snuggletex.SnuggleSession

Builds a complete web page based on the currently parsed tokens, sending the results to the given OutputStream, which is closed afterwards.

writeWebPage(WebPageOutputOptions, Object, OutputStream, SnuggleSession.EndOutputAction) - Method in class uk.ac.ed.ph.snuggletex.SnuggleSession

Builds a complete web page based on the currently parsed tokens, sending the results to the given OutputStream and performing the given SnuggleSession.EndOutputAction to it afterwards (i.e. close, flush or do nothing).

X

XHTML_10_STRICT_PUBLIC_IDENTIFIER - Static variable in interface uk.ac.ed.ph.snuggletex.definitions.W3CConstants

XHTML_10_STRICT_SYSTEM_IDENTIFIER - Static variable in interface uk.ac.ed.ph.snuggletex.definitions.W3CConstants

XHTML_10_TRANSITIONAL_PUBLIC_IDENTIFIER - Static variable in interface uk.ac.ed.ph.snuggletex.definitions.W3CConstants

XHTML_10_TRANSITIONAL_SYSTEM_IDENTIFIER - Static variable in interface uk.ac.ed.ph.snuggletex.definitions.W3CConstants

XHTML_11_MATHML_20_PUBLIC_IDENTIFIER - Static variable in interface uk.ac.ed.ph.snuggletex.definitions.W3CConstants

XHTML_11_MATHML_20_SYSTEM_IDENTIFIER - Static variable in interface uk.ac.ed.ph.snuggletex.definitions.W3CConstants

XHTML_NAMESPACE - Static variable in class uk.ac.ed.ph.snuggletex.definitions.Globals

Deprecated.

Use W3CConstants.XHTML_NAMESPACE instead

XHTML_NAMESPACE - Static variable in interface uk.ac.ed.ph.snuggletex.definitions.W3CConstants

XLINK_NAMESPACE - Static variable in interface uk.ac.ed.ph.snuggletex.definitions.W3CConstants

XML_NAMESPACE - Static variable in class uk.ac.ed.ph.snuggletex.definitions.Globals

Deprecated.

Use XMLConstants.XML_NS_URI instead

XMLAttrHandler - Class in uk.ac.ed.ph.snuggletex.dombuilding

Handles lonely instances of \\xmlAttr, which results in CoreErrorCode.TDEX02 being emitted.

XMLAttrHandler() - Constructor for class uk.ac.ed.ph.snuggletex.dombuilding.XMLAttrHandler

XMLBlockElementHandler - Class in uk.ac.ed.ph.snuggletex.dombuilding

Builds custom block XML elements.

XMLBlockElementHandler() - Constructor for class uk.ac.ed.ph.snuggletex.dombuilding.XMLBlockElementHandler

XMLInlineElementHandler - Class in uk.ac.ed.ph.snuggletex.dombuilding

Builds custom inline XML elements.

XMLInlineElementHandler() - Constructor for class uk.ac.ed.ph.snuggletex.dombuilding.XMLInlineElementHandler

XMLNameOrIdHandler - Class in uk.ac.ed.ph.snuggletex.dombuilding

Trivial handler for the \\xmlName and \\xmlId commands.

XMLNameOrIdHandler(int) - Constructor for class uk.ac.ed.ph.snuggletex.dombuilding.XMLNameOrIdHandler

XMLNS_NAMESPACE - Static variable in class uk.ac.ed.ph.snuggletex.definitions.Globals

Deprecated.

Use XMLConstants.XMLNS_ATTRIBUTE_NS_URI instead

XMLStringOutputExample - Class in uk.ac.ed.ph.snuggletex.samples

This example generalises MinimalExample to create a slightly more interesting output.

XMLStringOutputExample() - Constructor for class uk.ac.ed.ph.snuggletex.samples.XMLStringOutputExample

XMLStringOutputOptions - Class in uk.ac.ed.ph.snuggletex

Builds on DOMOutputOptions to add in options for configuring how to build an serialized output consisting of an XML (or possibly HTML) String using the relevant methods in SnuggleSession (e.g.

XMLStringOutputOptions() - Constructor for class uk.ac.ed.ph.snuggletex.XMLStringOutputOptions

XMLUnparseHandler - Class in uk.ac.ed.ph.snuggletex.dombuilding

Handles the special xmlUnparsed command and environment.

XMLUnparseHandler() - Constructor for class uk.ac.ed.ph.snuggletex.dombuilding.XMLUnparseHandler

XMLUtilities - Class in uk.ac.ed.ph.snuggletex.internal.util

Some trivial little helpers for creating suitably-configured TransformerFactory instances.

XMLUtilities() - Constructor for class uk.ac.ed.ph.snuggletex.internal.util.XMLUtilities

A B C D E F G H I J L M N O P Q R S T U V W X