aboutsummaryrefslogtreecommitdiffstats
path: root/src/org/apache/fop/layoutmgr/BlockStackingLayoutManager.java
blob: 423af36d350759e7dfa12b72e1d986fa17859270 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
/*
 * $Id$
 * Copyright (C) 2001 The Apache Software Foundation. All rights reserved.
 * For details on use and redistribution please refer to the
 * LICENSE file included with these sources.
 */

package org.apache.fop.layoutmgr;

import org.apache.fop.fo.FObj;
import org.apache.fop.area.Area;
import org.apache.fop.area.BlockParent;
import org.apache.fop.area.Block;
import org.apache.fop.area.MinOptMax;

import java.util.Iterator;

/**
 * Base LayoutManager class for all areas which stack their child
 * areas in the block-progression direction, such as Flow, Block, ListBlock.
 */
public abstract class BlockStackingLayoutManager extends AbstractLayoutManager {
    /** Reference to FO whose areas it's managing or to the traits
     * of the FO.
     */
    LayoutManager curChildLM = null;
    BlockParent parentArea = null;

    public BlockStackingLayoutManager(FObj fobj) {
        super(fobj);
    }



    public boolean splitArea(Area area, SplitContext splitContext) {
        // Divide area so that it will be within targetLength if possible
        // If not, it can be shorter, but not longer.
        /* Iterate over contents of the area. */

        // Need to figure out if we can do this generically
        // Logically a BlockStacking LM only handles Block-type areas
        if (!(area instanceof BlockParent)) {
            return false;
        }
        Iterator areaIter = ((BlockParent) area).getChildAreas().iterator();


        BreakCost minBreakCost = null;
        MinOptMax remainBPD = splitContext.targetBPD;
        splitContext.nextArea = area;

        while (areaIter.hasNext()) {
            Area childArea = (Area) areaIter.next();
            if (remainBPD.max < childArea.getAllocationBPD().min) {
                // Past the end point: try to break it
                // TODO: get a LayoutManager to do the split of the child
                // area, either Area => LM or Area => gen FO => LM
                LayoutManager childLM =
                  childArea.getGeneratingFObj(). getLayoutManager();
                splitContext.targetBPD = remainBPD;
                if (childLM.splitArea(childArea, splitContext) == false) {
                    // Can't split, so must split this area before childArea
                    // Can we pass the iter?
                    // If already saw several a potential break, use it
                    if (minBreakCost != null) {
                        /* Split 'area', placing all children after
                         * minBreakCost.getArea() into a new area,
                         * which we store in the splitContext.
                         */
                        // splitContext.nextArea = area.splitAfter(minBreakCost.getArea());
                    } else {
                        /* This area will be shorter than the desired minimum.
                         * Split before the current childArea (which will be
                         * the first area in the newly created Area.
                         */
                        //splitContext.nextArea = area.splitBefore(childArea);
                    }
                } else
                    return true; // childLM has done the work for us!
                // Set cost, dimension ???
                break;
            } else {
                remainBPD.subtract(childArea.getAllocationBPD());
                if (remainBPD.min < 0) {
                    // Potential breakpoint: remember break Position and
                    // break "cost" (constraint violation)
                    BreakCost breakCost =
                      evaluateBreakCost(area, childArea);
                    minBreakCost = breakCost.chooseLowest(minBreakCost);
                }
            }
            //Note: size of area when split can depend on conditional
            // space, border and padding of the split area!!!
        }
        // True if some part of area can be placed, false if none is placed
        return (splitContext.nextArea != area);

    }

    private BreakCost evaluateBreakCost(Area parent, Area child) {
        return new BreakCost(child, 0);
    }

    /** return current area being filled
     */
    protected BlockParent getCurrentArea() {
        return this.parentArea;
    }


    /**
     * Set the current area being filled.
     */
    protected void setCurrentArea(BlockParent parentArea) {
        this.parentArea = parentArea;
    }



    protected MinOptMax resolveSpaceSpecifier(Area nextArea) {
        SpaceSpecifier spaceSpec = new SpaceSpecifier();
        // 	Area prevArea = getCurrentArea().getLast();
        // 	if (prevArea != null) {
        // 	    spaceSpec.addSpace(prevArea.getSpaceAfter());
        // 	}
        // 	spaceSpec.addSpace(nextArea.getSpaceBefore());
        return spaceSpec.resolve();
    }

    /**
     * Add the childArea to the passed area.
     * Called by child LayoutManager when it has filled one of its areas.
     * The LM should already have an Area in which to put the child.
     * See if the area will fit in the current area.
     * If so, add it. Otherwise initiate breaking.
     * @param childArea the area to add: will be some block-stacked Area.
     * @param parentArea the area in which to add the childArea
     */
    protected void addChildToArea(Area childArea, BlockParent parentArea) {
        // This should be a block-level Area (Block in the generic sense)
        if (!(childArea instanceof Block)) {
            System.err.println("Child not a Block in BlockStackingLM!");
            return;
        }

        // See if the whole thing fits, including space before
        // Calculate space between last child in curFlow and childArea
        MinOptMax targetDim = parentArea.getAvailBPD();
        MinOptMax spaceBefore = resolveSpaceSpecifier(childArea);
        targetDim.subtract(spaceBefore);
        if (targetDim.max >= childArea.getAllocationBPD().min) {
            //parentArea.addBlock(new InterBlockSpace(spaceBefore));
            parentArea.addBlock((Block) childArea);
            return;
        } else {
            // Probably need something like max BPD so we don't get into
            // infinite loops with large unbreakable chunks
            SplitContext splitContext = new SplitContext(targetDim);

            LayoutManager childLM =
              childArea.getGeneratingFObj(). getLayoutManager();
            if (childLM.splitArea(childArea, splitContext)) {
                //parentArea.addBlock(new InterBlockSpace(spaceBefore));
                parentArea.addBlock((Block) childArea);
            }
            flush(); // hand off current area to parent
            getParentArea(splitContext.nextArea);
            // Check that reference IPD hasn't changed!!!
            // If it has, we must "reflow" the content
            addChild(splitContext.nextArea);
        }
    }


    /**
     * Add the childArea to the current area.
     * Called by child LayoutManager when it has filled one of its areas.
     * The LM should already have an Area in which to put the child.
     * See if the area will fit in the current area.
     * If so, add it. Otherwise initiate breaking.
     * @param childArea the area to add: will be some block-stacked Area.
     */
    public void addChild(Area childArea) {
        addChildToArea(childArea, getCurrentArea());
    }

    /**
     * Force current area to be added to parent area.
     */
    protected void flush() {
        if (getCurrentArea() != null)
            parentLM.addChild(getCurrentArea());
    }


}