org.apache.fop.area
Class Span
java.lang.Object
|
+--org.apache.fop.area.AreaTreeObject
|
+--org.apache.fop.area.Area
|
+--org.apache.fop.area.Span
- All Implemented Interfaces:
- java.io.Serializable
- public class Span
- extends Area
The span-reference-area.
This is a block-area with 0 border and padding that is stacked
within the main-reference-area
This object holds one or more normal-flow-reference-area children
based on the column-count trait in effect for this span.
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 |
Constructor Summary |
Span(int colCount,
int colGap,
int ipd)
Create a span area with the number of columns for this span area. |
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 |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Span
public Span(int colCount,
int colGap,
int ipd)
- Create a span area with the number of columns for this span area.
- Parameters:
colCount
- the number of columns in the spancolGap
- the column gap between each columnipd
- the total ipd of the span
getColumnCount
public int getColumnCount()
- Get the column count for this span area.
- Returns:
- the number of columns defined for this span area
getColumnWidth
public int getColumnWidth()
- Get the width of a single column within this Span
- Returns:
- the width of a single column
getHeight
public int getHeight()
- Get the height of this span area.
- Returns:
- the height of this span area
getNormalFlow
public NormalFlow getNormalFlow(int colRequested)
- Get the normal flow area for a particular column.
- Parameters:
colRequested
- the zero-based column number of the flow- Returns:
- the flow area for the requested column
getCurrentFlow
public NormalFlow getCurrentFlow()
- Get the NormalFlow area currently being processed
- Returns:
- the current NormalFlow
getCurrentFlowIndex
public int getCurrentFlowIndex()
- Returns:
- the index of the current normal flow
moveToNextFlow
public NormalFlow moveToNextFlow()
- Indicate to the Span that the next column is being
processed.
- Returns:
- the new NormalFlow (in the next column)
hasMoreFlows
public boolean hasMoreFlows()
- Indicates if the Span has unprocessed flows.
- Returns:
- true if Span can increment to the next flow,
false otherwise.
notifyFlowsFinished
public void notifyFlowsFinished()
- Called to notify the span that all its flows have been fully generated so it can update
its own BPD extent.
isEmpty
public boolean isEmpty()
- Indicates whether any child areas have been added to this span area.
This is achieved by looping through each flow.
- Returns:
- true if no child areas have been added yet.
toString
public java.lang.String toString()
- Overrides:
toString
in class Area
- See Also:
Object.toString()
Copyright 1999-2006 The Apache Software Foundation. All Rights Reserved.