FOM Reference > Content > Format Controls > fAccolade interface
  
fAccolade interface
This object defines an accolade and represents the accolade control stream in APP. This object inherits from fControl.
AccoladeType enumeration
The type of accolade to create.
The AccoladeType enumeration has the following constants of type int.
TYPE_SPECIAL = 0
Create a special accolade.
TYPE_LEFT = 1
Create an accolade with a left delimiter only.
TYPE_RIGHT = 2
Create an accolade with a right delimiter only.
TYPE_BOTH = 3
Create an accolade with both left and right delimiters.
TYPE_BOXED = 4
Create a boxed rule accolade.
TYPE_INSIDE = 8
Create an accolade with inside delimiters.
TYPE_OUTSIDE = 16
Create an accolade with inside delimiters.
AccoladeDelimiter enumeration
How to draw the accolade delimiter.
The AccoladeDelimiter enumeration has the following constants of type DOMString.
DELIMITER_NONE = ""
No delimiter
DELIMITER_LEFT_BRACE = "\\{"
Left Brace
DELIMITER_LEFT_BRACE_CONDENSED = "\\lcondbr"
Left Brace (condensed)
DELIMITER_LEFT_BRACE_LIGHT = "\\llightbr"
Left Brace (light)
DELIMITER_LEFT_BRACKET = "("
Left Bracket
DELIMITER_LEFT_SQUARE_BRACKET = "["
Left Square Bracket
DELIMITER_LEFT_FLOOR = "\\lfloor"
Left Floor
DELIMITER_LEFT_CEILING = "\\lceil"
Left Ceiling
DELIMITER_LEFT_GROUP = "\\lgroup"
Left Group
DELIMITER_LEFT_GROUP_CONDENSED = "\\lgrcond"
Left Group (condensed)
DELIMITER_LEFT_GROUP_LIGHT = "\\lgrlight"
Left Group (light)
DELIMITER_LEFT_MOUSTACHE = "\\lmoustache"
Left Moustache
DELIMITER_LEFT_MOUSTACHE_CONDENSED = "\\lmoustcond"
Left Moustache (condensed)
DELIMITER_LEFT_MOUSTACHE_LIGHT = "\\lmoustlight"
Left Moustache (light)
DELIMITER_RIGHT_BRACE = "\\}"
Right Brace
DELIMITER_RIGHT_BRACE_CONDENSED = "\\rcondbr"
Right Brace (condensed)
DELIMITER_RIGHT_BRACE_LIGHT = "\\rlightbr"
Right Brace (light)
DELIMITER_RIGHT_BRACKET = ")"
Right Bracket
DELIMITER_RIGHT_SQUARE_BRACKET = "]"
Right Square Bracket
DELIMITER_RIGHT_FLOOR = "\\rfloor"
Right Floor
DELIMITER_RIGHT_CEILING = "\\rceil"
Right Ceiling
DELIMITER_RIGHT_GROUP = "\\rgroup"
Right Group
DELIMITER_RIGHT_GROUP_CONDENSED = "\\rgrcond"
Right Group (condensed)
DELIMITER_RIGHT_GROUP_LIGHT = "\\rgrlight"
Right Group (light)
DELIMITER_RIGHT_MOUSTACHE = "\\rmoustache"
Right Moustache
DELIMITER_RIGHT_MOUSTACHE_CONDENSED = "\\rmoustcond"
Right Moustache (condensed)
DELIMITER_RIGHT_MOUSTACHE_LIGHT = "\\rmoustlight"
Right Moustache (light)
DELIMITER_DOWN_ARROW = "\\downarrow"
Down Arrow
DELIMITER_DOWN_ARROW_DOUBLE = "\\Downarrow"
Down Arrow (double)
DELIMITER_UP_ARROW = "\\uparrow"
Up Arrow
DELIMITER_UP_ARROW_DOUBLE = "\\Uparrow"
Up Arrow (double)
DELIMITER_UPDOWN_ARROW = "\\updownarrow"
UpDown Arrow
DELIMITER_UPDOWN_ARROW_DOUBLE = "\\Updownarrow"
UpDown Arrow (double)
DELIMITER_VERTICAL_BAR_NORMAL = "|"
Vertical Bar (normal)
DELIMITER_VERTICAL_BAR_DOUBLE = "\\|"
Vertical Bar (double)
DELIMITER_VERTICAL_BAR_ARROW = "\\arrowvert"
Vertical Bar (arrow)
DELIMITER_VERTICAL_BAR_DOUBLE_ARROW = "\\Arrowvert"
Vertical Bar (double arrow)
DELIMITER_VERTICAL_BAR_BRACE = "\\bracevert"
Vertical Bar (brace)
DELIMITER_VERTICAL_BAR_CONDENSED = "\\brcondvert"
Vertical Bar (condensed)
DELIMITER_VERTICAL_BAR_LIGHT = "\\brlightvert"
Vertical Bar (light)
AccoladeLocation enumeration
Where to draw the accolade
The AccoladeLocation enumeration has the following constants of type int.
LOCATION_TEXT_MARGIN = 0
On Text Margin
LOCATION_COLUMN_EDGE = 1
Column Edge
LOCATION_FRAME_EDGE = 2
Frame Edge
LOCATION_PAGE_EDGE = 3
Page Edge
LOCATION_EXACT = 4
Exact
LOCATION_TEXT_EDGE = 5
Text Edge. This value is only valid on the left and right.
LOCATION_TABLE_EDGE = 6
Table Edge. This value is only valid on the left and right.
LOCATION_TABLE_COLUMN_EDGE = 7
Table Column Edge. This value is only valid on the left and right.
AccoladeDrawMode enumeration
When to draw the accolade
The AccoladeDrawMode enumeration has the following constants of type int.
DRAW_NORMAL = 0
Normal (default)
DRAW_SINGLE = 1
Only draw if a single line
DRAW_MULTIPLE = 2
Only draw if multiple lines
DRAW_PARTIAL = 3
Only draw partial lines
DRAW_COMPLETE = 4
Only draw complete lines
DRAW_SOLITARY_COMPLETE = 5
Only draw solitary complete lines
DRAW_MULTIPLE_COMPLETE = 6
Only draw multiple complete lines
AccoladeDrawLevel enumeration
When to draw the accolade
The AccoladeDrawLevel enumeration has the following constants of type int.
DRAWLEVEL_NORMAL = 0
Normal: draw at end of accolade, mid text (default)
DRAWLEVEL_BEHIND_TEXT = 1
Behind text, on top of all rules and backgrounds
DRAWLEVEL_BEHIND_RULES = 2
Behind segmented rules, on top of segmented backgrounds
DRAWLEVEL_BEHIND_BACKGROUNDS = 3
Behind segmented rules and backgrounds, on top of whole ones
DRAWLEVEL_BEHIND_WHOLE_RULES = 4
Behind whole rules, on top of whole backgrounds
DRAWLEVEL_BEHIND_ALL = 5
Behind all text and all rules and backgrounds
DRAWLEVEL_ON_TOP = 6
On top of all text and all rules and backgrounds
bottomField attribute
The percentage through the accolade to stop drawing.
bottomField
Access
read-write
Returns
int
bottomLocation attribute
The position to draw the bottom of the accolade. Value is one of fAccolade-AccoladeLocation.
bottomLocation
Access
read-write
Returns
int
bottomOffset attribute
The offset from the bottom location to draw the accolade.
bottomOffset
Access
read-write
Returns
fLength
color attribute
The color to use when drawing the accolade.
color
Access
read-write
Returns
fColor
forceAbsolute attribute
If true, absolute units will be used when drawing the accolade delimiters.
forceAbsolute
Access
read-write
Returns
boolean
leftColumn attribute
If the left position is set to Table Column Edge, which column to draw the accolade next to.
leftColumn
Access
read-write
Returns
int
leftDelimiter attribute
Which shape to use for the left delimiter. Possible values are in fAccolade-AccoladeDelimiter.
leftDelimiter
Access
read-write
Returns
String
leftDelimiterAdvanced attribute
The TeX commands used to draw the left delimiter. If this property is set, the leftDelimiter property will automatically be set to fAccolade.DELIMITER_NONE.
leftDelimiterAdvanced
Access
read-write
Returns
String
leftLocation attribute
The position to draw the left of the accolade. Value is one of fAccolade-AccoladeLocation.
leftLocation
Access
read-write
Returns
int
leftOffset attribute
The offset from the left location to draw the accolade.
leftOffset
Access
read-write
Returns
fLength
opacity attribute
The default percentage opacity to draw this accolade on supported output drivers.
opacity
Access
read-write
Returns
float
rightColumn attribute
If the right position is set to Table Column Edge, which column to draw the accolade next to.
rightColumn
Access
read-write
Returns
int
rightDelimiter attribute
Which shape to use for the right delimiter. Possible values are in fAccolade-AccoladeDelimiter.
rightDelimiter
Access
read-write
Returns
String
rightDelimiterAdvanced attribute
The TeX commands used to draw the right delimiter. If this property is set, the rightDelimiter property will automatically be set to fAccolade.DELIMITER_NONE.
rightDelimiterAdvanced
Access
read-write
Returns
String
rightLocation attribute
The position to draw the right of the accolade. Value is one of fAccolade-AccoladeLocation.
rightLocation
Access
read-write
Returns
int
rightOffset attribute
The offset from the right location to draw the accolade.
rightOffset
Access
read-write
Returns
fLength
rules attribute
If the accolade type is set to Boxed Rules, this is the rules to use.
rules
Access
read-only
Returns
fRules
topField attribute
The percentage through the accolade to start drawing.
topField
Access
read-write
Returns
int
topLocation attribute
The position to draw the top of the accolade. Value is one of fAccolade-AccoladeLocation.
topLocation
Access
read-write
Returns
int
topOffset attribute
The offset from the top location to draw the accolade.
topOffset
Access
read-write
Returns
fLength
type attribute
What type of accolade to create. Value is one of fAccolade-AccoladeType.
type
Access
read-write
Returns
int