FOM Reference > Formatting > Paragraphs > fStyle interface
  
fStyle interface
Objects of this class provide access to the styling of text which can be applied by passing them to fFormatting::styleChange(). They can also be passed to fFormatting::paragraphStart() to specify the default styling for the new paragraph.
An instance of this class is also available as formatting.currentStyle which allows changing attributes of the paragraph that is currently being formatted. Changes made to its properties are active immediately.
A further instance of this class can be accessed using formatting.defaultStyle. This provides access to the styling properties that were in effect at the start of the paragraph and which take effect if any currentStyle properties are set to undefined.
StyleCapsMode enumeration
These constants define the capitalisation mode of text, for use with capsMode.
The StyleCapsMode enumeration has the following constants of type int.
CAPS_NORMAL = 0
Display text as typed.
CAPS_UPPER = 1
Display text in upper case.
CAPS_LOWER = 2
Display text in lower case.
CAPS_SMALL = 3
Display text in small caps, with capital letters as normal size capitals.
CAPS_SMALLER = 4
Display text in small caps.
CharacterMirrorMode enumeration
These constants define values for use with the property mirror.
The CharacterMirrorMode enumeration has the following constants of type int.
MIRROR_AUTO = 0
Use default setting.
MIRROR_YES = 1
Mirror the characters.
MIRROR_NO = 2
Prohibit mirrored characters.
CharacterRotation enumeration
These constants define values for use with the property rotate.
The CharacterRotation enumeration has the following constants of type int.
ROTATE_0 = 0
Do not rotate characters.
ROTATE_90 = 1
Rotate characters by 90°.
ROTATE_180 = 2
Rotate characters by 180°.
ROTATE_270 = 3
Rotate characters by 270°.
OverhangMode enumeration
These constants define values for use with the property overhang.
The OverhangMode enumeration has the following constants of type int.
OVERHANG_NONE = 0
Overhang off for terminating the command.
OVERHANG_RIGHT = 1
Overhangs text on the right hand side.
OVERHANG_LEFT = 2
Overhangs text on the left hand side.
OVERHANG_CENTER = 3
Overhangs text on the left and right.
CharacterVerticalFormat enumeration
Sets the vertical format for verticalFormat.
The CharacterVerticalFormat enumeration has the following constants of type int.
VERTICALFORMAT_AUTO = 0
Auto, the best logical mode, defaults to 1.
VERTICALFORMAT_CENTER = 1
Center characters vertically.
VERTICALFORMAT_TOP = 2
Vertically align top of characters.
VERTICALFORMAT_JBOTTOM = 3
Vertically align bottom of characters.
VERTICALFORMAT_BASELINE = 4
Aligns the baseline of the character on the baseline.
VERTICALFORMAT_CENTER_OUTLINE = 5
As VERTICALFORMAT_CENTER, but uses the character outline if rotated 90° or 270°.
VERTICALFORMAT_TOP_OUTLINE = 6
As VERTICALFORMAT_TOP, but uses the character outline if rotated 90° or 270°.
VERTICALFORMAT_JBOTTOM_OUTLINE = 7
As VERTICALFORMAT_JBOTTOM, but uses the character outline if rotated 90° or 270°.
VERTICALFORMAT_BOTTOM = 8
Aligns the bottom of the character on the baseline.
VERTICALFORMAT_BOTTOM_OUTLINE = 9
As VERTICALFORMAT_JBOTTOM, but uses the character outline if rotated 90° or 270°.
VerticalModes enumeration
Lets you explicitly set character vertical mode. This is particularly useful in respect to Chinese, Japanese and Korean text. When in this mode characters will sit one on top of the next.
The VerticalModes enumeration has the following constants of type int.
VERTICALMODE_AUTO = 0
Auto. Defaults to vertical mode if the frame is in CJK mode, if not horizontal mode.
VERTICALMODE_ON = 1
Vertical Mode. When in vertical mode by default characters are centred horizontally and vertically and tchrw is used as the fixed width. All characters are also rotated anti-clockwise by 90° to counteract the frame rotation. But a lot of this is overridden for individual characters - i.e. roman characters revert back to proportional width, retain the frame rotation and align back to the baseline.
VERTICALMODE_OFF = 2
Horizontal Mode. This is the normal mode for Arbortext APP - proportional widths are used, characters align on the baseline and no rotation is involved.
CharacterWidthFormat enumeration
Sets the character width format for widthFormat.
The CharacterWidthFormat enumeration has the following constants of type int.
WIDTHFORMAT_AUTO = 0
Auto. Defaults to 1 if either in vertical mode, or rotating by 90° (CW or CCW), otherwise defaults to 4.
WIDTHFORMAT_LEFT = 1
Left.
WIDTHFORMAT_CENTER = 2
Center.
WIDTHFORMAT_RIGHT = 3
Right.
WIDTHFORMAT_NONE = 4
None. Defaults to 1 if either in vertical mode, or rotating by 90° (CW or CCW), otherwise defaults to 4.
WIDTHFORMAT_OUTLINE_LEFT = 5
Left align outline.
WIDTHFORMAT_OUTLINE_CENTER = 6
Center align outline.
WIDTHFORMAT_OUTLINE_RIGHT = 7
Right align outline.
WIDTHFORMAT_USE_OUTLINE = 8
Use outline width. Instead of using the width of the character, the character width becomes the outline of the character.
FontWeights enumeration
Flag values to specify which font to use based on its weight. This selection is done in combination with the fStyle.italic and fStyle.stretch properties.
The FontWeights enumeration has the following constants of type int.
WEIGHT_NORMAL = 0
Specifies the use of the normal variant of the font.
WEIGHT_BOLD = 1
Specifies the use of the bold variant of the font.
WEIGHT_LIGHT = 2
Specifies the use of the light variant of the font.
FontStretch enumeration
Flag values to specify which font to use based on its stretch. This selection is done in combination with the fStyle.italic and fStyle.weight properties.
The FontStretch enumeration has the following constants of type int.
STRETCH_NORMAL = 0
Specifies the use of the normal variant of the font.
STRETCH_EXPANDED = 1
Specifies the use of the expanded variant of the font.
STRETCH_CONDENSED = 2
Specifies the use of the condensed variant of the font.
LigatureGroups enumeration
These constants define the ligatures groups available for use with fStyle.ligatureGroup.
The LigatureGroups enumeration has the following constants of type int.
LIGATURE_SYSTEM = 1
System ligatures: these include character access ligatures, which essentially just map characters from the font to APP, e.g. Ã is, technically, a ligature. This level of ligature is always on and cannot be turned off.
LIGATURE_DASH = 2
En dash and em dash ligatures: convert two hyphens (- -) and three hyphens (- - -) to en and em dashes respectively.
LIGATURE_FI = 4
fi and fl ligatures.
LIGATURE_FF = 8
ff, ffi, and ffl ligatures.
StyleSpaceFlags enumeration
Flag values to specify which spaces should be ignored while formatting.
The StyleSpaceFlags enumeration has the following constants of type int.
SPACE_MAP_RETURNS = 1
Specifies that all the APP returns in a given text stream should be mapped to either a space or a 'yellow bar return' depending on the usege of the MAP_TO_YBR flag.
SPACE_IGNORE_MULTIPLE = 2
Specifies that any multiple spaces in the text stream should be ignored.
SPACE_IGNORE_START = 4
Specifies that the text stream should ignore spaces at the start of a paragraph
SPACE_IGNORE_END = 8
Specifies that the text stream should ignore spaces that appear at the end of a paragraph.
SPACE_IGNORE_SPACES = 16
Specifies that all spaces in the text stream should be ignored.
SPACE_MAP_TO_YBR = 32
If return are being mapped, map them to a 'yellow bar return' rather than a space.
A yellow bar return (or spacer) is an APP-specific character that is used to space out code in the yellow edit bar. It is represented by APP-ISO character &147;.
SPACE_MAP_TABS = 64
Specifies that tab characters should be mapped to spaces.
backgroundRule attribute
PI: ttbgc
The fTextRule object to control the style of the background rule.
backgroundRule
Access
read-write
Returns
fTextRule
baselineShift attribute
PI: tvs
Moves text vertically off its baseline by a specified amount. Can also be a negative value. Can be used or thought of as a sort of superscript (<?sup>) or subscript (<?sup>) that does not change the character size.
baselineShift
Access
read-write
Returns
fLength
capsHeight attribute
PI: tscaph
Sets the height of small capitals in percent.
capsHeight
Access
read-write
Returns
float
capsMode attribute
PI: tcaps
Forces text to appear as typed, capitalised or in lower case. The conversion only takes place for display and print purposes, leaving the actual contents of the text stream unchanged. See StyleCapsMode.
capsMode
Access
read-write
Returns
int
capsWidth attribute
PI: tscapw
Sets the width of small capitals in percent.
capsWidth
Access
read-write
Returns
float
characterVerticalOffset attribute
PI: tchrvfoff
Allows Japanese and Latin characters to be offset vertically in relation to English characters. This is done by adjusting the alignment point when centering, flushing top or flushing bottom.
characterVerticalOffset
Access
read-write
Returns
fLength
characterWidth attribute
PI: tchrw
Sets the fixed width for a character to use in conjunction with tchrfixedw. Once you have set the fixed width with characterWidth, you then apply it with fixedWidth.
characterWidth
Access
read-write
Returns
fLength
color attribute
PI: tic
Sets the normal colour of text. Setting the colour to none makes the body of each character transparent. You can set an outline colour using outlineColor.
color
Access
read-write
Returns
fColor
displayHeight attribute
PI: tdh
Sets the text height without changing any other attribute that depends on the height such as text width and leading.
displayHeight
Access
read-write
Returns
fLength
displayWidth attribute
PI: tdw
Sets the text width without changing any other attribute that depends on the width (e.g. inter-word spacing). This essentially gives 'condensed' or 'expanded' type.
displayWidth
Access
read-write
Returns
fLength
doubleUnderline attribute
PI: tuld
Switches double underlining on or off. Text will be double underlined using the current lineColor,underlinePosition and lineThickness. The position of the second underline will be twice the normal underlinePosition.
doubleUnderline
Access
read-write
Returns
boolean
endSpace attribute
PI: tespace
Instructs Arbortext APP to ignore or include additional spaces that occur at the end of a text stream when formatting it.
endSpace
Access
read-write
Returns
boolean
fixedWidth attribute
PI: tchrfixedw
Determines whether to use the individual width of a character or the same width for all characters. If a fixed width is used then the value of characterWidth will be applied which defaults to width.
fixedWidth
Access
read-write
Returns
boolean
flip attribute
PI: tchrflip
Flip character vertically within the outline of the character.
flip
Access
read-write
Returns
boolean
font attribute
PI: tffamily
Specifies the font family or typeface to use for text.
font
Access
read-write
Returns
fFont
height attribute
PI: th
Sets the text height of a font. Any other attributes that depend on the text height will also change.
height
Access
read-write
Returns
fLength
hyphenationAtColumnBreak attribute
PI: thyllcdis
This property controls the hyphenation of the last word before a column break. If true(the default), the last word will be hyphenated. If false, the last word will not be hyphenated.
hyphenationAtColumnBreak
Access
read-write
Returns
boolean
hyphenationAtPageBreak attribute
PI: thyllpdis
This property controls the hyphenation of the last word before a page break. If true(the default), the last word will be hyphenated. If false, the last word will not be hyphenated.
hyphenationAtPageBreak
Access
read-write
Returns
boolean
hyphenationBreakCharacters attribute
PI: twbch
Allows you to specify additional hyphenation characters at which to break a line.
hyphenationBreakCharacters
Access
read-write
Returns
String
hyphenationCharacter attribute
PI: thych
Specifies the character that will be used to show a word has been hyphenated (Only the first character of the string is used). If the string is empty, no hyphenation character will be displayed.
hyphenationCharacter
Access
read-write
Returns
String
hyphenationCharsAfter attribute
PI: thyaft
Prevent words from hyphenating too near to the end of a word.
The minimum number of characters from a word that must be left after the hyphen when a word is hyphenated. If this were, for instance, 3, the word 'hyphenated' could not be broken as 'hyphenat-ed'.
hyphenationCharsAfter
Access
read-write
Returns
int
hyphenationCharsBefore attribute
PI: thybef
Prevents words from hyphenating too near to the start of a word.
The minimum number of characters from a word that must be left in front of a hyphen. If this were, for instance, 3, the word 'hyphenated' could notbe broken as 'hy-phenated'.
hyphenationCharsBefore
Access
read-write
Returns
int
hyphenationCharsMin attribute
PI: thymin
Sets the minimum word size that may be hyphenated.
hyphenationCharsMin
Access
read-write
Returns
int
hyphenationExceptionDictionary attribute
PI: thye
Defines a primary hyphenation exception dictionary to use. This should be the tag containing the dictionary.
hyphenationExceptionDictionary
Access
read-write
Returns
fStream
hyphenationExceptionDictionary2 attribute
PI: thye2
Defines a secondary hyphenation exception dictionary to use. This should be the tag containing the dictionary.
hyphenationExceptionDictionary2
Access
read-write
Returns
fStream
hyphenationLanguage attribute
PI: tl
Sets the current language for hyphenation.
hyphenationLanguage
Access
read-write
Returns
String
hyphenationLevel attribute
PI: thyc
Sets a basic hyphenation level. This enables you to specify how strict hyphenation should be.
Value
Description
0
Least strict. Simply fits as many characters as is possible on to the line. Hyphenation will occur whenever text reaches the end of a line, regardless of whether it looks correct or not.
1..4
Increasingly strict. Implements increasingly strict hyphenation levels.
5
Normal.
6..8
Increasingly strict. Implements increasingly strict hyphenation levels.
9
Most strict. Only the most rigorous decisions will be taken for placing hyphens. This does not necessarily mean best visually. Most strict forces Arbortext APP to miss out hyphenating opportunities which would probably result in a more evenly space line.
10
Off. No attempt at hyphenation will be made. This also disables any discretionary hyphens that you may have placed in the text.
11
Simple hyphenation. This ignores Arbortext APP's normal method of comparing each previous line to the current line to see if the lines are not too far apart in terms of loose or tight fit. Using this method Arbortext APP will scan back as far as the beginning of the last paragraph and readjust the letter, word fit and hyphenation to achieve a more aesthetic appearance. With simple hyphenation (11) each line is considered individually and no scanning of previous lines will occur. Simple hyphenation works by looking at all valid hyphenation points and choosing the last one possible, so that as much of the word as possible will still fit on the line.
12
Single word only. Only hyphenates when a single word will not fit on a line. If you set hyphenation level to 12, 'Single word only' in the Hyphenation Level dialogue box, Arbortext APP will only hyphenate a word if it is wider than the measure of the text frame or line.
hyphenationLevel
Access
read-write
Returns
int
hyphenationMaxNum attribute
PI: thyn
Sets the maximum number of hyphens that may appear consecutively down the right hand edge of a column.
hyphenationMaxNum
Access
read-write
Returns
int
hyphenationOnLastWord attribute
PI: thylwdis
This property controls the hyphenation of the last word in a paragraph. If true(the default), the last word will be hyphenated. If false, the last word will not be hyphenated.
hyphenationOnLastWord
Access
read-write
Returns
boolean
hyphenationType attribute
PI: thytype
This macro enables you to specify an alternative hyphenation type for use with Arbortext APP. If you have installed Dieckmann hyphenation algorithms you need to tell Arbortext APP that you would like to use these, instead of the default hyphenation algorithms.
hyphenationType
Access
read-write
Returns
int
hyphenationUppercaseDisable attribute
PI: thyucdis
Disables hyphenation of words which include an upper-case letter, for example, names.
hyphenationUppercaseDisable
Access
read-write
Returns
boolean
ignoreCharacters attribute
PI: tignchar
If true, all output chacaters will be ignored. Entities and Tags will still be processed.
ignoreCharacters
Access
read-write
Returns
int
inverse attribute
PI: tinv
Gives white text on a black background. Arbortext APP automatically changes the text colour, underline colour, underline thickness and underline position to achieve this effect. For example, if you need white text on a red background, or want to change the size of the background, the best thing is to use the macros for these attributes directly. You can also use fParagraph::backgroundColor as a text attribute which will affect the lines in a paragraph below it.
inverse
Access
read-write
Returns
boolean
italic attribute
PI: tfitalic
Toggle italics of the text font.
italic
Access
read-write
Returns
boolean
kerningTable attribute
PI: tk
Specifies which of the current document’s kerning tables will be used to control the automatic kerning of text.
kerningTable
Access
read-write
Returns
fStream
letterSpace attribute
PI: tlsb
Sets the basic letter spacing value. This is the basic amount of space added to the right of a letter that will be applied when formatting a line. The extra space at the end of the line is not used, providing for correctly justified or centred lines.
letterSpace
Access
read-write
Returns
fLength
letterSpaceExtra attribute
PI: tlse
Sets the maximum amount of extra space that can be added to the letter spacing when justifying a line. APP will avoid letter spacing whenever possible
letterSpaceExtra
Access
read-write
Returns
fLength
letterSpaceSquash attribute
PI: tlss
Sets the the maximum amount of space that can be removed from the letter spacing when justifying a line. APP will avoid letter spacing whenever possible.
letterSpaceSquash
Access
read-write
Returns
fLength
ligatureGroup attribute
PI: tklgp
Define a level of ligature to be applied to text by confirming which ligature group(s) are to be applied. See fStyle.LigatureGroups. APP defaults to a setting of 255, which adds together all the group numbers allowed and therefore turns all levels on.
ligatureGroup
Access
read-write
Returns
int
lineBackgroundColor attribute
PI: tubgc
Sets the background colour of underline, doubleUnderline, overline and strikethrough, used when the lineStyle is not solid.
lineBackgroundColor
Access
read-write
Returns
fColor
lineColor attribute
PI: tuc
Sets the colour of underline, doubleUnderline, overline and strikethrough.
lineColor
Access
read-write
Returns
fColor
lineEndPattern attribute
This is the pattern to use at the end of each rule segment (caused by line breaks, etc.)
This has no effect upon the backgroundRule.
lineEndPattern
Access
read-write
Returns
fRuleLinePattern
lineStartPattern attribute
This is the pattern to use at the start of each rule segment (caused by line breaks, etc.)
This has no effect upon the backgroundRule.
lineStartPattern
Access
read-write
Returns
fRuleLinePattern
lineStyle attribute
PI: tuls
The line style used by underline, doubleUnderline, overline and strikethrough.
lineStyle
Access
read-write
Returns
String
lineThickness attribute
PI: tut
Sets the line thickness of underline, doubleUnderline , overline and strikethrough. It is often a good idea to change the underline thickness to a setting that is the same as the narrowest part of the letters in a font.
lineThickness
Access
read-write
Returns
fLength
linkColor attribute
PI: tbklnkcol
Sets the colour of highlight for the hot area of a link in PDFs. If "none" (the default), the link colour specified in the PDF Printer options will be used.
linkColor
Access
read-write
Returns
fColor
lowercaseMap attribute
PI: ttolower
The map to use when converting characters to lower case with fStyle.capsMode. If this is null or undefined, a default map will be used.
If the fStream type is fTag.TYPE_JS_FUNCTION, then the function will be called with arguments[0] set to the character to be mapped, and arguments[1] set to the current fStyle.capsMode. The return value will be conveted to a string, and the first character will be used as a result of the map.
lowercaseMap
Access
read-write
Returns
fStream
mirror attribute
PI: tchrmirror
Mirror character horizontally within the outline of the character.
mirror
Access
read-write
Returns
int
opacity attribute
Specifies the percentage opacity to use on supported output drivers.
opacity
Access
read-write
Returns
float
outlineColor attribute
PI: toc
Sets the outline colour for characters. The default setting of none will not draw any outlines. Any other setting will cause the outline to be drawn. Characters drawn with outlines are considerably slower than those without. To get characters to appear in outline only, use color to set the inside colour of the characters to none.
outlineColor
Access
read-write
Returns
fColor
outlineThickness attribute
PI: tot
Sets the outline thickness for characters. The default setting of '0' will draw outlines as hairlines (as thin as possible). For outlines to appear at all, they must be given a colour with outlineColor.
outlineThickness
Access
read-write
Returns
fLength
overhang attribute
PI: overhang
This command, as its name suggests, allows text lines to overhang frames and/or columns. See OverhangMode.
overhang
Access
read-write
Returns
int
overline attribute
PI: tulo
Switches overlining on or off. Text will be overlined using the current lineColor and lineThickness.
overline
Access
read-write
Returns
boolean
overlinePosition attribute
PI: tovp
Changes the position of the overbar. The colour and thickness of the overbar are the same as those set for the underline with lineColor and lineThickness.
overlinePosition
Access
read-write
Returns
fLength
overlineRule attribute
PI: toverline
The fTextRule object to control the style of the overline rule.
This is independant of the overline property.
overlineRule
Access
read-write
Returns
fTextRule
overprint attribute
PI: tovpr
Enables you to specify overprint in composite files. Overprint can be specified on any form of colour in 3B2 by setting fColor::overprint.
overprint
Access
read-write
Returns
boolean
pseudoBold attribute
PI: twt
Sets a weight for text to create pseudo bold characters, generated by drawing a character twice, with a small horizontal distance in between. This attribute actually specifies that distance.
pseudoBold
Access
read-write
Returns
fLength
pseudoItalic attribute
PI: ts
Sets a shear percentage for text to create pseudo (fake) italic characters.
pseudoItalic
Access
read-write
Returns
float
relativeIndent attribute
PI: ri
Relative indent. Will make the subsequent lines of text align from the point of insertion.
relativeIndent
Access
read-write
Returns
fLength
rotate attribute
PI: tchrrot
Sets character rotation mode, see CharacterRotation.
rotate
Access
read-write
Returns
int
sizeMode attribute
PI: tdsz
Changes the interpretation of text sizing attributes.
0
Text sizing attributes refer to the character cell height of a font.
1
Text sizing attributes refer to the height of capital letters of a font.
sizeMode
Access
read-write
Returns
int
spaceFlags attribute
Which whitespace characters to ignore during formatting. Valid values are in fStyle-StyleSpaceFlags.
spaceFlags
Access
read-write
Returns
int
stretch attribute
PI: tfstretch
Set the stretch of the text font using one of the FontStretch constants.
stretch
Access
read-write
Returns
int
strikethrough attribute
PI: tult
Switches strike-through on or off. Text will be struck out using the current lineColor and lineThickness.
strikethrough
Access
read-write
Returns
boolean
strikethroughRule attribute
PI: tstrikethrough
The fTextRule object to control the style of the strikethrough rule.
This is independant of the strikethough property.
strikethroughRule
Access
read-write
Returns
fTextRule
triggerDisable attribute
PI: ttrigdis
In some circumstances it is preferable for Arbortext APP to handle alignment automatically, such as fixed-format sections of text, for example a table containing financial information. Tab triggers enable automatic alignment. Tab triggers are tabs which are automatically applied when Arbortext APP encounters specific trigger characters within the text stream. For more information see fTableColumn::tabs and tstd.
triggerDisable
Access
read-write
Returns
boolean
underline attribute
PI: tul
Switches underlining on or off. Text will be underlined using the current lineColor, underlinePosition and lineThickness.
underline
Access
read-write
Returns
boolean
underlinePosition attribute
PI: tup
Sets the position of an underline in relation to the baselines of characters. Using a negative value for an underline will draw the line above the baseline.
underlinePosition
Access
read-write
Returns
fLength
underlineRule attribute
PI: tunderline
The fTextRule object to control the style of the underline rule.
This is independant of the underline property.
underlineRule
Access
read-write
Returns
fTextRule
unipairTable attribute
PI: tunipar
Specifies which of the current document’s unipair tables should be used to override the global unipairs loaded at startup from the sunipair.3ad file.
unipairTable
Access
read-write
Returns
fStream
uppercaseMap attribute
PI: ttoupper
The map to use when converting characters to upper case with fStyle.capsMode. If this is null or undefined, a default map will be used.
If the fStream type is fTag.TYPE_JS_FUNCTION, then the function will be called with arguments[0] set to the character to be mapped, and arguments[1] set to the current fStyle.capsMode. The return value will be conveted to a string, and the first character will be used as a result of the map.
uppercaseMap
Access
read-write
Returns
fStream
useLigatureGroups attribute
PI: tklig
Allows you define the whether ligatures groups are used. If false it allows system ligatures only. If true it allows ligature groups 2+ to be used when defined via fStyle.ligatureGroup.
useLigatureGroups
Access
read-write
Returns
boolean
variant attribute
PI: tfqs
When using a fFontFamily, set the index of the desired variant.
variant
Access
read-write
Returns
String
verticalFormat attribute
PI: tchrvf
Sets the vertical format for characters, generally used in conjunction with rotate. When a character is rotated, uses the character's outline, whether it is above or below the baseline and aligns itself. See CharacterVerticalFormat.
verticalFormat
Access
read-write
Returns
int
verticalMode attribute
PI: tchrvmode
Lets you explicitly set character vertical mode. This is particularly useful in respect to Chinese, Japanese and Korean text. When in this mode characters will sit one on top of the next.
verticalMode
Access
read-write
Returns
int
weight attribute
PI: tfweight
Set the weight of the text font using one of the FontWeight constants.
weight
Access
read-write
Returns
int
width attribute
PI: tw
Changes the text width of a font. Any other attributes that depend on the text width will also change.
width
Access
read-write
Returns
fLength
widthFormat attribute
PI: tchrwf
Width format of character - shift the character left or right. This only tends to have an effect when a fixed width is being used, otherwise the character already fits exactly within its width and so no shifting is needed.
When the character is rotated by 90° or 270°, APP uses the outline of the character and how far it extends above and below the baseline to work out how to align it.
When the character is not rotated or rotated by 180°, APP will make its calculations with the width of the character for modes 1-3 and will use the outline for modes 5-7.
In vertical mode the baseline has been rotated, so this actually affects the vertical position of the character.
By default, opening brackets and punctuation are code 3 and closing brackets and punctuation are code 1, so that they still group their contents when a fixed width is being used.
widthFormat
Access
read-write
Returns
int
wordSpace attribute
PI: twb
Sets the basic word spacing value. This is the basic amount of space that will be substituted for every space character when formatting a line.
wordSpace
Access
read-write
Returns
fLength
wordSpaceExtra attribute
PI: twe
Sets the word spacing stretchability. This is the maximum amount of extra space that can be added to the basic word spacing when justifying a line.
wordSpaceExtra
Access
read-write
Returns
fLength
wordSpaceSquash attribute
PI: tws
Sets the word spacing 'squashability'. This is the maximum amount of space that can be removed from the basic word spacing when justifying a line.
wordSpaceSquash
Access
read-write
Returns
fLength
wordSpaceSquashMode attribute
When set, word squash is only applied to paragraphs that are being justified.
wordSpaceSquashMode
Access
read-write
Returns
int
yakumonoWidth attribute
PI: tyakw
Specifies the width used for a Yakumono character whenever it is switched to 'half' width. Therefore the default value is 0.5w, although if required you can specify an alternative measurement.
Yakumono is the name for a class of Japanese characters which includes brackets, punctuation and other symbols. These characters have the option of being set half width or full width when used in text.
yakumonoWidth
Access
read-write
Returns
fLength
fStyle method
Create a new, uninitialized instance of fStyle.
fStyle
Parameters
None
Returns
fStyle. A new object of class fStyle.
readResolve method
Return the object corresponding to the given serialized representation.
readResolveobj
Parameters
Objectobj
The serialized representation.
Returns
fStyle. 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.