uk.ac.ed.ph.snuggletex.tokens

Class FlowToken

java.lang.Object

uk.ac.ed.ph.snuggletex.tokens.Token

uk.ac.ed.ph.snuggletex.tokens.FlowToken

Direct Known Subclasses:

BraceContainerToken, CommandToken, EnvironmentToken, ErrorToken, MathCharacterToken, SimpleToken

public abstract class FlowToken
extends Token

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

Version:

$Revision$

Author:

David McKain

Field Summary

Fields

Modifier and Type	Field and Description
protected TextFlowContext	textFlowContext

Fields inherited from class uk.ac.ed.ph.snuggletex.tokens.Token

computedStyle, interpretationMap, latexMode, slice, type

Constructor Summary

Constructors

Constructor and Description
FlowToken(FrozenSlice slice, TokenType type, LaTeXMode latexMode, TextFlowContext textFlowContext, EnumMap<InterpretationType,Interpretation> interpretations)
FlowToken(FrozenSlice slice, TokenType type, LaTeXMode latexMode, TextFlowContext textFlowContext, Interpretation... interpretations)

Method Summary

Modifier and Type	Method and Description
TextFlowContext	getTextFlowContext() For Tokens appearing inside TEXT flow, this indicates how this Token should flow against its siblings.

Methods inherited from class uk.ac.ed.ph.snuggletex.tokens.Token

getComputedStyle, getInterpretation, getInterpretationMap, getLatexMode, getMathCharacter, getMathCharacterCodePoint, getSlice, getType, hasInterpretationType, isCommand, isEnvironment, setComputedStyle, toString

Methods inherited from class java.lang.Object

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

Field Detail

textFlowContext

protected final TextFlowContext textFlowContext

Constructor Detail

FlowToken

public FlowToken(FrozenSlice slice,
                 TokenType type,
                 LaTeXMode latexMode,
                 TextFlowContext textFlowContext,
                 Interpretation... interpretations)

FlowToken

public FlowToken(FrozenSlice slice,
                 TokenType type,
                 LaTeXMode latexMode,
                 TextFlowContext textFlowContext,
                 EnumMap<InterpretationType,Interpretation> interpretations)

Method Detail

getTextFlowContext

public TextFlowContext getTextFlowContext()

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

For other types of Token, this returns null.