Top Description Fields Constructors Methods
uk.ac.ed.ph.snuggletex.tokens

public abstract Class FlowToken

extends Token
Class Inheritance
Known Direct Subclasses
uk.ac.ed.ph.snuggletex.tokens.MathCharacterToken, uk.ac.ed.ph.snuggletex.tokens.SimpleToken, uk.ac.ed.ph.snuggletex.tokens.BraceContainerToken, uk.ac.ed.ph.snuggletex.tokens.CommandToken, uk.ac.ed.ph.snuggletex.tokens.EnvironmentToken, uk.ac.ed.ph.snuggletex.tokens.ErrorToken
Imports
uk.ac.ed.ph.snuggletex.definitions.LaTeXMode, .TextFlowContext, uk.ac.ed.ph.snuggletex.internal.FrozenSlice, uk.ac.ed.ph.snuggletex.semantics.Interpretation, .InterpretationType, java.util.EnumMap
Base class for Tokens which represent the main "flow" of content, rather than things like command arguments.
Author
David McKain
Version
$Revision$

Field Summary

Modifier and TypeField and Description
protected final TextFlowContext
textFlowContext

Inherited from uk.ac.ed.ph.snuggletex.tokens.Token:
computedStyleinterpretationMaplatexModeslicetype

Constructor Summary

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

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

Method Summary

Modifier and TypeMethod and Description
public TextFlowContext
getTextFlowContext()

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

Inherited from uk.ac.ed.ph.snuggletex.tokens.Token:
getComputedStylegetInterpretationgetInterpretationMapgetLatexModegetMathCharactergetMathCharacterCodePointgetSlicegetTypehasInterpretationTypeisCommandisEnvironmentsetComputedStyletoString

Field Detail

textFlowContextback to summary
protected final TextFlowContext textFlowContext

Constructor Detail

FlowTokenback to summary
public FlowToken(final FrozenSlice slice, final TokenType type, final LaTeXMode latexMode, final TextFlowContext textFlowContext, final Interpretation... interpretations)
FlowTokenback to summary
public FlowToken(final FrozenSlice slice, final TokenType type, final LaTeXMode latexMode, final TextFlowContext textFlowContext, final EnumMap<InterpretationType, Interpretation> interpretations)

Method Detail

getTextFlowContextback to summary
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.