org.apache.fop.area
Class MainReference
java.lang.Object
org.apache.fop.area.AreaTreeObject
org.apache.fop.area.Area
org.apache.fop.area.MainReference
- All Implemented Interfaces:
- java.io.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.
- See Also:
- Serialized Form
Fields inherited from class org.apache.fop.area.Area |
bpd, BT, CLASS_ABSOLUTE, CLASS_BEFORE_FLOAT, CLASS_FIXED, CLASS_FOOTNOTE, CLASS_MAX, CLASS_NORMAL, CLASS_SIDE_FLOAT, ipd, log, LR, ORIENT_0, ORIENT_180, ORIENT_270, ORIENT_90, props, RL, TB |
Methods inherited from class org.apache.fop.area.Area |
addChildArea, addTrait, addTrait, getAllocBPD, getAllocIPD, getAreaClass, getBooleanTrait, getBorderAndPaddingWidthAfter, getBorderAndPaddingWidthBefore, getBorderAndPaddingWidthEnd, getBorderAndPaddingWidthStart, getBPD, getIPD, getSpaceAfter, getSpaceBefore, getSpaceEnd, getSpaceStart, getTrait, getTraitAsInteger, getTraits, hasTrait, hasTraits, setAreaClass, setBPD, setIPD, toString |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
MainReference
public MainReference(BodyRegion parent)
- Constructor
- Parameters:
parent
- the body region this reference area is placed in.
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.
getSpans
public java.util.List getSpans()
- Get the span areas from this area.
- Returns:
- the list of span areas
getCurrentSpan
public Span getCurrentSpan()
- Get the span area currently being filled (i.e., the last span created).
- Returns:
- the active span.
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.
getColumnCount
public int getColumnCount()
- Returns:
- the number of columns
getColumnGap
public int getColumnGap()
- Returns:
- the column gap in millipoints
Copyright 1999-2008 The Apache Software Foundation. All Rights Reserved.