org.apache.fop.area

Class MainReference

Implemented Interfaces:
Serializable

public class MainReference
extends Area

The main-reference-area generated by an fo:region-body This object holds one or more span-reference-areas (block-areas stacked in the block progression direction) See fo:region-body definition in the XSL Rec for more information.

Field Summary

Fields inherited from class org.apache.fop.area.Area

BT, CLASS_ABSOLUTE, CLASS_BEFORE_FLOAT, CLASS_FIXED, CLASS_FOOTNOTE, CLASS_MAX, CLASS_NORMAL, CLASS_SIDE_FLOAT, LR, ORIENT_0, ORIENT_180, ORIENT_270, ORIENT_90, RL, TB, bpd, ipd, log, props

Fields inherited from class org.apache.fop.area.AreaTreeObject

foreignAttributes

Constructor Summary

MainReference(BodyRegion parent)
Constructor

Method Summary

Span
createSpan(boolean spanAll)
Add a span area to this area.
int
getColumnCount()
int
getColumnGap()
Span
getCurrentSpan()
Get the span area currently being filled (i.e., the last span created).
List
getSpans()
Get the span areas from this area.
boolean
isEmpty()
Indicates whether any child areas have been added to this reference area.

Methods inherited from class org.apache.fop.area.Area

addChildArea, addTrait, addTrait, getAllocBPD, getAllocIPD, getAreaClass, getBPD, getBooleanTrait, getBorderAndPaddingWidthAfter, getBorderAndPaddingWidthBefore, getBorderAndPaddingWidthEnd, getBorderAndPaddingWidthStart, getIPD, getSpaceAfter, getSpaceBefore, getSpaceEnd, getSpaceStart, getTrait, getTraitAsInteger, getTraits, hasTrait, hasTraits, setAreaClass, setBPD, setIPD, toString

Methods inherited from class org.apache.fop.area.AreaTreeObject

getForeignAttributeValue, getForeignAttributes, setForeignAttribute, setForeignAttributes

Constructor Details

MainReference

public MainReference(BodyRegion parent)
Constructor
Parameters:
parent - the body region this reference area is placed in.

Method Details

createSpan

public Span createSpan(boolean spanAll)
Add a span area to this area.
Parameters:
spanAll - whether to make a single-column span
Returns:
the created span area.

getColumnCount

public int getColumnCount()
Returns:
the number of columns

getColumnGap

public int getColumnGap()
Returns:
the column gap in millipoints

getCurrentSpan

public Span getCurrentSpan()
Get the span area currently being filled (i.e., the last span created).
Returns:
the active span.

getSpans

public List getSpans()
Get the span areas from this area.
Returns:
the list of span areas

isEmpty

public boolean isEmpty()
Indicates whether any child areas have been added to this reference area. This is achieved by looping through each span.
Returns:
true if no child areas have been added yet.

Copyright 1999-2007 The Apache Software Foundation. All Rights Reserved.