aboutsummaryrefslogtreecommitdiffstats
path: root/src/org/apache/fop/layoutmgr/BPLayoutManager.java
blob: 32f7df9d75abcd2596596b3af7e35e7d17d949ff (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
/*
 * $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.area.Area;

/**
 * The interface for all BreakPoss LayoutManagers.
 */
public interface BPLayoutManager extends LayoutManager {

    /**
     * Return true if the next area which would be generated by this
     * LayoutManager could start a new line (or flow for block-level FO).
     */
    public boolean canBreakBefore(LayoutContext lc);

    /**
     * Generate and return the next break possibility.
     * @param context The layout context contains information about pending
     * space specifiers from ancestor areas or previous areas, reference
     * area inline-progression-dimension and various other layout-related
     * information.
     * @param prevBreakPosition If not null, gives a Position returned by
     * this layout manager on a previous call to getNextBreakPoss. It may not
     * be the previous one returned. The Layout Manager should return the next
     * potential Break Possibility after prevBreakPosition.
     * If prevBreakPosition is null, it should return the first possible
     * BreakPoss.
     */
    public BreakPoss getNextBreakPoss(LayoutContext context,
				      BreakPoss.Position prevBreakPosition);

    public BreakPoss getNextBreakPoss(LayoutContext context);

    /** CURRENTLY NOT USED
    public BreakPoss getStartBreakPoss(LayoutContext lc,
				       BreakPoss.Position bpPrevEnd);
    **/

    /**
     * Return a value indicating whether this LayoutManager has laid out
     * all its content (or generated BreakPossibilities for all content.)
     */
    public boolean isFinished() ;

    /**
     * Set a flag indicating whether the LayoutManager has laid out all
     * its content. This is generally called by the LM itself, but can
     * be called by a parentLM when backtracking.
     */
    public void setFinished(boolean isFinished) ;

    /**
     * Tell the layout manager to add all the child areas implied
     * by BreakPoss.Position objectw which will be returned by the
     * Iterator.
     */
    public void addAreas(PositionIterator posIter) ;

    public void init() ;

    public void resetPosition(BreakPoss.Position position);

}