FOM Reference > Formatting > Blocks > fBlockRegion interface
  
fBlockRegion interface
Objects of this class contain settings for individual block regions.
RegionHorizontalAlignment enumeration
These constants define horizontal alignment of the region or its contents.
The RegionHorizontalAlignment enumeration has the following constants of type DOMString.
ALIGN_LEFT = "nonjustify"
Horizontally left aligned.
ALIGN_NONJUSTIFY = "nonjustify"
Horizontally left aligned.
ALIGN_JUSTIFY = "justify"
Horizontally left aligned and justified.
ALIGN_CENTER = "center"
Horizontally centered.
ALIGN_RIGHT = "right"
Horizontally right aligned.
RegionVerticalAlignment enumeration
These constants define vertical alignment of the region or its contents.
The RegionVerticalAlignment enumeration has the following constants of type DOMString.
ALIGN_TOP = "top"
Vertically aligned at the top.
ALIGN_MIDDLE = "middle"
Vertically centered.
ALIGN_CENTER = "center"
Vertically centered.
ALIGN_BOTTOM = "bottom"
Vertically aligned at the bottom.
RuleGutter enumeration
When you have applied region rules to your block it is possible to make the rule span into the gutter to the right of the region.
The RuleGutter enumeration has the following constants of type DOMString.
GUTTER_FULL = "full"
Will span rules over the whole right gutter, including fBlock::gutterLeft or fBlock::gutterRight, respectively.
GUTTER_HALF = "half"
Will make the region rules span half way into the gutter to the right, including fBlock::gutterLeft or fBlock::gutterRight, respectively.
GUTTER_SPECIAL = "special"
This will make the region rule span halfway into normal gutters, but all the way into a right hand gutter that has been specified using fBlock::gutterLeft or fBlock::gutterRight, respectively. By default region backgrounds will not obey this unless backgroundSpan is true.
backgroundColor attribute
PI: blockcellbgcolor
The background color for this block region.
backgroundColor
Access
read-write
Returns
fColor
backgroundSpan attribute
PI: blockcellbgspangut
Specifices if background colours should span into block gutters. You can only make the region background colours span into gutters if you have specified that region rules span into the right or left gutters (using ruleLeftGutter and ruleRightGutter). Once you have allocated region background colours, you can make them span into either the left or right gutters. If true, the background colours span into gutters. If false, the background colours will not span into the gutters.
backgroundSpan
Access
read-write
Returns
boolean
emptyReference attribute
PI: blockcellemptyref
Specfies the reference tag you would like to be called at the occurance of an empty region in a block if any.
emptyReference
Access
read-write
Returns
fStream
horizontalAlign attribute
PI: blockcellfmth
Specifies the horizontal format of this individual block region.
horizontalAlign
Access
read-write
Returns
String
indentAbsolute attribute
PI: blockindentabs
Returns where the left edge of the block region indent is measured from.
indentAbsolute
Access
read-write
Returns
int
keepTogether attribute
PI: blockcellkeeptogether
Specifies that the contents of the block region is kept together, using the priorities in the same way other block keeps work
This is a column based keep and ensures that the item is kept within the same parent column, be it either a frame column, a slim table column or a block column.
keepTogether
Access
read-write
Returns
int
minimumHeight attribute
PI: blockcellminh
Specify the minimum height for this region.
minimumHeight
Access
read-write
Returns
fLength
paddingBottom attribute
PI: blockcellpadb
Specifies padding at the bottom of this region
paddingBottom
Access
read-write
Returns
fLength
paddingLeft attribute
PI: blockcellpadl
Specifies padding to the left of this region.
paddingLeft
Access
read-write
Returns
fLength
paddingRight attribute
PI: blockcellpadr
Specifies padding to the right of this region
paddingRight
Access
read-write
Returns
fLength
paddingTop attribute
PI: blockcellpadt
Specifies padding at the top of this region
paddingTop
Access
read-write
Returns
fLength
paraAttributes attribute
PI: blockcellattrib
This allows you to pass attributes to the reference defined by paraReference. These attributes can then modify the behaviour of your reference, by inheriting alternative properties for the block etc. This is particularly useful if your mark-up defines text properties for the block.
paraAttributes
Access
read-write
Returns
String
paraAttributesCombine attribute
PI: blockcellattribc
By default, within a region, the value of paraAttributes that is in use will be taken from either the default for the block/column as defined in fBlock::defaultRegion and fBlock::columns, with the usual precedence. When num is set to 1, then the paragraph attributes specified for the two defaults will be combined instead.
paraAttributesCombine
Access
read-write
Returns
boolean
paraReference attribute
PI: blockcellpararef
Assigns a style reference tag to this individual block region. Set paraAttributes to the attributes you wish to pass when the stream is invoked.
paraReference
Access
read-write
Returns
fStream
ruleLeftFrameGutter attribute
PI: blockcellrulelfcgut
Region rules span left into frame gutter. This works in a similar way to ruleLeftGutter but used when the gutter in question is one of the frame-column gutters rather than the normal block-column gutters.
ruleLeftFrameGutter
Access
read-write
Returns
String
ruleLeftGutter attribute
PI: blockcellrulelgut
When you have applied region rules to your block it is possible to make the rule span into the gutter to the left of the region.
ruleLeftGutter
Access
read-write
Returns
String
ruleRightFrameGutter attribute
PI: blockcellrulerfcgut
Region rules span right into frame gutter. This works in a similar way to ruleLeftGutter but used when the gutter in question is one of the frame-column gutters rather than the normal block-column gutters.
ruleRightFrameGutter
Access
read-write
Returns
String
ruleRightGutter attribute
PI: blockcellrulergut
When you have applied region rules to your block it is possible to make the rule span into the gutter to the right of the region.
ruleRightGutter
Access
read-write
Returns
String
rules attribute
PI: blockcellrules
The set of rules around this block region.
rules
Access
read-write
Returns
fRules
spanColumnsNum attribute
>PI: blockcspan
Enter the number of columns you wish to span.
Spanning columns is achieved using this property. This property specifies the number of columns that the text should span, you apply the command to the region that you want to span others. For example if you want a region to span two cells set region.spanColumnsNum = 2.
spanColumnsNum
Access
read-write
Returns
int
verticalAlign attribute
PI: blockcellfmtv
Specifies the vertical alignment of text within this individual block region.
verticalAlign
Access
read-write
Returns
String
widthOverlapMode attribute
PI: blockcellwidthoverlap
If false then when content is too wide for a block it will skip into the following cell and add a warning to the format log. If true then content for a block that is too wide, is allowed to overlap the block width instead - but the warning is still issued.
widthOverlapMode
Access
read-write
Returns
boolean
fBlockRegion method
Create a new fBlockRegion object.
fBlockRegion
Parameters
None
Returns
fBlockRegion. The newly created fBlockRegion.
readResolve method
Return the object corresponding to the given serialized representation.
readResolveobj
Parameters
Objectobj
The serialized representation.
Returns
fBlockRegion. 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.