FOM Reference > Formatting > Blocks > fBlockColumn interface
  
fBlockColumn interface
Objects of this class contain settings for an individual block column.
ColumnHorizontalAlignment enumeration
These constants define horizontal alignment of the column or its contents.
The ColumnHorizontalAlignment enumeration has the following constants of type DOMString.
ALIGN_LEFT = "left"
Horizontally left aligned and justified.
ALIGN_MIDDLE = "middle"
Horizontally centered.
ALIGN_CENTER = "center"
Horizontally centered.
ALIGN_RIGHT = "right"
Horizontally right aligned.
defaultRegion attribute
PI: blockcolspec
Contains the default settings for the block regions within this column.
defaultRegion
Access
read-write
Returns
fBlockRegion
frameColumnNew attribute
PI: blockcolfcnew
Start column in new frame column. Only relevant when used in conjunction with fBlock::avoid = true. When working out how to allocate the block columns to fit into frame columns, if mode is true Arbortext APP will try and ensure that this column appears at the left hand edge of one of the frame columns.
frameColumnNew
Access
read-write
Returns
boolean
groupNext attribute
PI: blockcolgroupnext
Groups this column with the next one - used in conjunction with the 'T', 'B', 'L' and 'R' tests for cell rules.
groupNext
Access
read-write
Returns
boolean
gutter attribute
PI: blockcolgut
Specifies the block column gutter measure or relative spacing specification.
gutter
Access
read-write
Returns
fColumnWidth
horizontalAlign attribute
PI: blockcolfmth
It is possible to specify the horizontal format of each paragraph of text within this column.
horizontalAlign
Access
read-write
Returns
String
paraReference attribute
PI: blockcolpref
Assigns a column style preference tag to a particular column.
paraReference
Access
read-write
Returns
fStream
reserve attribute
PI: blockcolres
If reserve = true it specifies that this column is to be reserved and by default the table contents will flow around this column.
reserve
Access
read-write
Returns
boolean
suppress attribute
PI: blockcoldel
If true it specifies that this column is to be suppressed and not displayed in the output. When all columns in a block are deleted then the whole block is swallowed up. When specified in the preamble for a block then be careful as block.column[0].suppress = true will be propagated across all the columns - if you just want to delete the first column use: columns[0].suppress = true. The initial '+' is optional likewise the '@', see width for details.
suppress
Access
read-write
Returns
boolean
width attribute
PI: blockcolwidth
Allows you to specify the width of a column.
width
Access
read-write
Returns
fColumnWidth
fBlockColumn method
Create a new fBlockColumn.
fBlockColumn
Parameters
None
Returns
fBlockColumn. The newly created column object.
readResolve method
Return the object corresponding to the given serialized representation.
readResolveobj
Parameters
Objectobj
The serialized representation.
Returns
fBlockColumn. 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.