FOM Reference > Formatting > Paragraphs > fTeX interface
  
fTeX interface
The objects of this class allow setting and retrieving formatting properties related to the TeX subsystem.
TooWideModes enumeration
Constants for use with fTeX.tooWideMode.
The TooWideModes enumeration has the following constants of type int.
TOOWIDE_CONTINUE = 0
TeX will continue to overflow the column until it finds a wider column, if possible.
TOOWIDE_SCALE = 1
Scale the whole of the inline TeX proportionally so that it fits. This will also change the height of the TeX.
This can be a legitimate way of scaling inline graphics so that they use their native size if possible, but are scaled down to the measure if they are too wide.
TOOWIDE_CLIP = 2
Clip the inline TeX, rather than scale it; so that it fits. The vertical size will be unaffected.
TOOWIDE_OVERHANG = 3
Permit the inline TeX to overhang the column and exceed the normal boundaries. The vertical size will be unaffected.
HyphenModes enumeration
Constants for use with fTeX.hyphenMode.
The HyphenModes enumeration has the following constants of type int.
HYPHEN_NORMAL = 0
Insert hyphens as usual (default setting)
HYPHEN_TRAILING = 1
Disable hyphens when breaking in front of inline TeX
HYPHEN_LEADING = 2
Disable hyphens when breaking after inline TeX
HYPHEN_NONE = 3
Disable hyphens when breaking either side of inline TeX
HorizontalAlignment enumeration
Constants for use with fTeX.horizontalAlign.
The HorizontalAlignment enumeration has the following constants of type int.
ALIGN_CENTER = 0
TeX blocks will be centered in the surrounding column. (default setting)
ALIGN_LEFT = 1
TeX blocks will be left aligned in the surrounding column.
ALIGN_RIGHT = 2
TeX blocks will be right aligned in the surrounding column.
absoluteUnits attribute
PI: tptxabs
By default any unit specified within TeX is specified assuming a point size of 10pt. This means that if the paragraph text height is not set to 10pt, all the measurements within the TeX will need to be scaled accordingly.
Previously, to override this default behavior, units needed to be preceded by true, for example 25truemm. If fTeX.absoluteUnits is true, it indicates that all TeX units will be absolute. No scaling will be performed and units will not need to be prefixed with true.
absoluteUnits
Access
read-write
Returns
boolean
accentedCharacters attribute
PI: tptxnmap
Provides support in the Maths extension for Arbortext APP's standard accented characters if the current font includes them. Setting accentedCharacters = true turns this on and is very useful if you are using a Unicode font.
accentedCharacters
Access
read-write
Returns
boolean
allowSplits attribute
PI: tptxhy
Normally, when a Maths equation is too big for a line, Arbortext APP will carry the whole equation onto the next line. By setting this property to true you can instruct Arbortext APP to split the equation. However, splitting will only occur when absolutely necessary and as long as the Maths is a word of its own. In addition to this, Maths will only split at the top level, therefore, anything within { }'s will not be split.
allowSplits
Access
read-write
Returns
boolean
autoMultiply attribute
PI: tptxdm
Sets the automaticaly generated multiplication signs options for Maths splits.
For more information see the Math manual manual.
autoMultiply
Access
read-write
Returns
int
backgroundColor attribute
PI: tptxbgc
Sets the Maths margin colour. A background colour can be used to highlight equations within the text. The background colour normally surrounds just the equation unless one of the commands \displaylines, \equaligno, \eqno etc. is used, in which case the background extends for the full width of the 'maths measure.' The border is provided to allow a margin around the equation inside the background colour. The border can be used without a background colour, to increase space around displaymode maths.
backgroundColor
Access
read-write
Returns
fColor
balanceIgnoreBottom attribute
PI: tptxvjib
Instructs Arbortext APP to ignore the Maths bottom margin when balancing.
balanceIgnoreBottom
Access
read-write
Returns
boolean
borderWidth attribute
PI: tptxbord
Defines a border around the equation using the background colour. Without the background colour defined, can be used to increase space around display Maths.
borderWidth
Access
read-write
Returns
fLength
breakBottom attribute
PI: tptxbb
When true, breaks are always measured from bottom. Instructs Arbortext APP to always measure breaks from the bottom of Maths.
breakBottom
Access
read-write
Returns
boolean
definitionStream attribute
PI: tptxdef
Specifies a TeX definition stream. This is used to define additional macros for use in TeX maths (limited to 4,000 characters).
The example shows some entries from a typical Maths definition file. This stream would be called using tex.definitionStream = template.content.streams["My_math_def"] .
\def \mbox {\hbox } \def \int {{\vint}} \def \beq {\begin{equation}} \def \dg {$^\circ$} \def \bs {$\backslash$} \def \frac#1#2{{#1 \over #2}} \def \text#1{{\tf="T001" #1\;}} \def \mathbf#1{{\tf="T005" #1}} \def \stackrel#1#2{{\lower 3#1 \atop \raise 3#2}}...
definitionStream
Access
read-write
Returns
fStream
fontBoldExtension attribute
PI: tptxbxf
Defines the Maths bold font.
fontBoldExtension
Access
read-write
Returns
fFont
fontExtension attribute
PI: tptxexf
Specifies the font Arbortext APP is to use for Maths Extensions.
fontExtension
Access
read-write
Returns
fFont
fontLetters attribute
PI: tptxlf
Sets the letters font used in Maths. The TeX command \curr automatically selects the current text font for the following characters.
fontLetters
Access
read-write
Returns
fFont
fontMathsItalic attribute
PI: tptxmif
Specifies the font Arbortext APP is to use for Maths Italics.
fontMathsItalic
Access
read-write
Returns
fFont
fontNumbers attribute
PI: tptxnf
Sets the numbers font used in Maths. The TeX command \curr automatically selects the current text font for the following characters.
fontNumbers
Access
read-write
Returns
fFont
fontRoman attribute
PI: tptxrmf
Specifies the font Arbortext APP is to use for normal text (upper and lowercase letters, numbers, punctuation etc).
fontRoman
Access
read-write
Returns
fFont
fontSlanted attribute
PI: tptxslf
Specifies the font Arbortext APP is to use for Italic text.
fontSlanted
Access
read-write
Returns
fFont
fontSymbol attribute
PI: tptxsyf
Specifies the font Arbortext APP is to use for Maths symbols (binary operators, relations etc).
fontSymbol
Access
read-write
Returns
fFont
fontText attribute
PI: tptxtf
Sets the text font used in Maths. The TeX command \curr automatically selects the current text font for the following characters.
fontText
Access
read-write
Returns
fFont
fontTextItalic attribute
PI: tptxtif
Sets the font that Arbortext APP is to use for Maths Italic Text.
fontTextItalic
Access
read-write
Returns
fFont
fontTextTypewriter attribute
PI: tptxttf
Sets the font that Arbortext APP is to use for Typewriter style Maths.
fontTextTypewriter
Access
read-write
Returns
fFont
horizontalAlign attribute
This property is used to control the placement of TeX blocks. It uses the values defined in fTex.HorizontalAlignment. This property is only used when the object is used on the fFormatting.texStart method and the block attribute is true.
horizontalAlign
Access
read-write
Returns
int
hyphenMode attribute
PI: tptxhydis
When a line is hyphenated next to inline TeX text, a hyphen is inserted in the normal manner. This command allows you to suppress these hyphens under certain conditions. See fTeX.HyphenModes.
hyphenMode
Access
read-write
Returns
int
hyphenationExtended attribute
PI: tptxhyx
When Maths splitting is not possible (e.g. no space is available to stretch) you can use this property to instruct Arbortext APP to split the Maths and leave some of it on the previous line, known as Extended mode.
Note: You will need to have allowSplits enabled for extended mode to work.
hyphenationExtended
Access
read-write
Returns
boolean
keepWithNext attribute
PI: tptxkeepn
Maths Breaks: Keep the Maths with the next line.
keepWithNext
Access
read-write
Returns
boolean
keepWithPrevious attribute
PI: tptxkeepp
Maths Breaks: Keep the Maths with previous line.
keepWithPrevious
Access
read-write
Returns
boolean
marginBottom attribute
PI: tptxb
Sets the Maths bottom margin.
marginBottom
Access
read-write
Returns
fLength
marginCellTop attribute
PI: tptxclt
Sets the Maths cell top margin.
marginCellTop
Access
read-write
Returns
fLength
marginExtended attribute
PI: tptxmext
Maths Margins: Extended Top Margins.
marginExtended
Access
read-write
Returns
boolean
marginLeft attribute
PI: tptxl
Sets the Maths left margin.
marginLeft
Access
read-write
Returns
fLength
marginRight attribute
PI: tptxr
Sets the Maths right margin.
marginRight
Access
read-write
Returns
fLength
marginTop attribute
PI: tptxt
Sets the Maths top margin.
marginTop
Access
read-write
Returns
fLength
maximumGap attribute
PI: tptxmgap
Sets a limit to the size of gap that Maths will overflow. If the space left in a column exceeds the value set in gap limit, Arbortext APP will force the Maths to fit and will overhang the column instead.
maximumGap
Access
read-write
Returns
fLength
paragraphBottom attribute
PI: tptxpb
Sets the Maths paragraph bottom margin. This is the margin used by Maths when it comes at the bottom of a column.
paragraphBottom
Access
read-write
Returns
fLength
paragraphTop attribute
PI: tptxpt
Sets the Maths paragraph top margin. This is the margin used by Maths when it comes at the top of a column.
paragraphTop
Access
read-write
Returns
fLength
penaltyBinary attribute
PI: tptxpenb
Specifies a penalty value for binary operators in Maths.
penaltyBinary
Access
read-write
Returns
int
penaltyDefault attribute
PI: tptxpend
Allocates an alternative value to the Maths splits default penalty. The default penalty value is 10000, this instructs Arbortext APP that Maths are un-splittable. If you change the default penalty value to a figure less than 10000, Arbortext APP will split Maths anywhere in an equation.
penaltyDefault
Access
read-write
Returns
int
penaltyExHyphen attribute
PI: tptxpene
Specifies a penalty value for an ExHyphen in Maths. By default the value Arbortext APP sets for an ExHyphen is 50.
penaltyExHyphen
Access
read-write
Returns
int
penaltyHyphen attribute
PI: tptxpenh
Specifies a penalty value for a Hyphen in Maths. By default the value Arbortext APP sets for a Hyphen is 50.
penaltyHyphen
Access
read-write
Returns
int
penaltyRelation attribute
PI: tptxpenr
Specifies a penalty value for relations in Maths. By default the value Arbortext APP sets for a relation is 500.
penaltyRelation
Access
read-write
Returns
int
split attribute
PI: tptxsplit
This property instructs Arbortext APP to allow TeX splits. Without this macro enabled, all other split* settings are ignored.
split
Access
read-write
Returns
boolean
splitDelimiters attribute
PI: tptxsplde
Using this property, Arbortext APP will ignore delimiters (e.g. brackets etc) and will not prioritise split points by their nesting within delimiters.
Normally, Arbortext APP will not split delimiters if there are any other points where the equation can be split. If this property is true, Arbortext APP will ignore delimiters (e.g. brackets etc) and will not priorities split points by their nesting within delimiters.
splitDelimiters
Access
read-write
Returns
boolean
splitDelineatorAlign attribute
PI: tptxsplda
When this property is true, if Arbortext APP splits in the middle of a delineator, it will be aligned on the right hand edge of the last opening delimiter.
splitDelineatorAlign
Access
read-write
Returns
boolean
splitFlush attribute
PI: tptxsplfl
Using this property, when a simple equation splits into two lines Arbortext APP will flush the top line of the equation to the left and the bottom line will be flushed right.
splitFlush
Access
read-write
Returns
boolean
splitNumbers attribute
PI: tptxsplfl
This property instructs Arbortext APP to try to split an equation before it moves equation numbers onto a new line.
Normally, Arbortext APP will assume it has the whole measure in which to fit the body of the equation, and after splitting it will then decide whether equation numbers need flushing to a new line.
If this property is true, Arbortext APP tries to split an equation before it moves equation numbers onto a new line.
splitNumbers
Access
read-write
Returns
boolean
tooWideError attribute
PI: tptxtoowideerr
This property will add a message to the formatting error log when a graphic scaling action defined by fTeX.tooWideMode is triggered.
tooWideError
Access
read-write
Returns
boolean
tooWideMode attribute
PI: tptxtoowide
When inline TeX is wide enough, it’s possible to have a situation when the resulting output is too wide to ever fit, even if it’s the only thing on the line.
This property provides options by which handle this situation using the fTeX.TeXTooWideModes values. Setting the associated fTeX.tooWideError to true command will ensure that a message is added to the formatting error log when this is triggered and not set to fTeX.TOOWIDE_CONTINUE.
tooWideMode
Access
read-write
Returns
int
verticalJustify attribute
PI: tptxvj
Instructs Arbortext APP to override the paragraph vertical justification with Maths vertical justification.
verticalJustify
Access
read-write
Returns
boolean
vjIgnoreBottom attribute
PI: tptxvjib
Instructs Arbortext APP to ignore any Maths bottom margins when vertically justifying.
vjIgnoreBottom
Access
read-write
Returns
boolean
vjMarginBottom attribute
PI: tptxvjmmb
vjMarginBottom
Access
read-write
Returns
fLength
vjMarginBottomPriority attribute
PI: tptxvjpmb
Determines the position of the bottom margin to receive extra space during vertical justification. Priority 0 is the first position to receive extra space ("highest priority"), and 9 is the last position to receive extra space ("lowest priority").
vjMarginBottomPriority
Access
read-write
Returns
int
vjMarginColumnTop attribute
PI: tptxvjmmct
vjMarginColumnTop
Access
read-write
Returns
fLength
vjMarginColumnTopPriority attribute
PI: tptxvjpmct
Determines the position of the column top margin to receive extra space during vertical justification. Priority 0 is the first position to receive extra space ("highest priority"), and 9 is the last position to receive extra space ("lowest priority").
vjMarginColumnTopPriority
Access
read-write
Returns
int
vjMarginTop attribute
PI: tptxvjmmt
vjMarginTop
Access
read-write
Returns
fLength
vjMarginTopAcross attribute
PI: tptxvjmmat
vjMarginTopAcross
Access
read-write
Returns
fLength
vjMarginTopAcrossPriority attribute
PI: tptxvjpmat
Determines the position of the top margin to receive extra space "after across." Priority 0 is the first position to receive extra space ("highest priority"), and 9 is the last position to receive extra space ("lowest priority").
vjMarginTopAcrossPriority
Access
read-write
Returns
int
vjMarginTopPriority attribute
PI: tptxvjpmt
Determines the position of the top margin to receive extra space during vertical justification. Priority 0 is the first position to receive extra space ("highest priority"), and 9 is the last position to receive extra space ("lowest priority").
vjMarginTopPriority
Access
read-write
Returns
int
vjParagraphBottom attribute
PI: tptxvjmpb
vjParagraphBottom
Access
read-write
Returns
fLength
vjParagraphBottomPriority attribute
PI: tptxvjppb
Priority 0 is the first position to receive extra space ("highest priority"), and 9 is the last position to receive extra space ("lowest priority").
vjParagraphBottomPriority
Access
read-write
Returns
int
vjParagraphCellTop attribute
PI: tptxvjmpclt
vjParagraphCellTop
Access
read-write
Returns
fLength
vjParagraphCellTopPriority attribute
PI: tptxvjppclt
Priority 0 is the first position to receive extra space ("highest priority"), and 9 is the last position to receive extra space ("lowest priority").
vjParagraphCellTopPriority
Access
read-write
Returns
int
vjParagraphColumnTop attribute
PI: tptxvjmpct
vjParagraphColumnTop
Access
read-write
Returns
fLength
vjParagraphColumnTopPriority attribute
PI: tptxvjppct
Priority 0 is the first position to receive extra space ("highest priority"), and 9 is the last position to receive extra space ("lowest priority").
vjParagraphColumnTopPriority
Access
read-write
Returns
int
vjParagraphTop attribute
PI: tptxvjmpt
vjParagraphTop
Access
read-write
Returns
fLength
vjParagraphTopAcross attribute
PI: tptxvjmpat
vjParagraphTopAcross
Access
read-write
Returns
fLength
vjParagraphTopAcrossPriority attribute
PI: tptxvjppat
Priority 0 is the first position to receive extra space ("highest priority"), and 9 is the last position to receive extra space ("lowest priority").
vjParagraphTopAcrossPriority
Access
read-write
Returns
int
vjParagraphTopPriority attribute
PI: tptxvjppt
Priority 0 is the first position to receive extra space ("highest priority"), and 9 is the last position to receive extra space ("lowest priority").
vjParagraphTopPriority
Access
read-write
Returns
int
fTeX method
Creates a new, uninitialized fTeX instance.
fTeX
Parameters
None
Returns
fTeX. A new object of class fTeX.
readResolve method
Return the object corresponding to the given serialized representation.
readResolveobj
Parameters
Objectobj
The serialized representation.
Returns
fTeX. The object corresponding to the serialized representation.
writeReplace method
Create a serializable representation of this object.
writeReplace
Parameters
None
Returns
Object. A serializable representation of this object.