aboutsummaryrefslogtreecommitdiffstats
path: root/src/org/apache/fop/layoutmgr/BreakPoss.java
blob: 668348871eac89855f8823be9564ddc0b1827840 (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
197
198
199
200
201
202
/*
 * $Id$
 * Copyright (C) 2002 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.MinOptMax;
import org.apache.fop.traits.LayoutProps;

/**
 * Represents a break possibility for the layout manager.
 * Used to pass information between different levels of layout manager concerning
 * the break positions. In an inline context, before and after are interpreted as
 * start and end.
 * The m_position field is opaque represents where the break occurs. It is a
 * nested structure with one level for each layout manager involved in generating
 * the BreakPoss..
 * @author Karen Lease
 */
public class BreakPoss {


    /** Values for m_flags returned from lower level LM. */
    public static final int CAN_BREAK_AFTER= 0x01; // May break after
    public static final int ISLAST=          0x02; // Last area generated by FO
    public static final int ISFIRST=         0x04; // First area generated by FO
    public static final int FORCE=           0x08; // Forced break (ie LF)
    public static final int CAN_BREAK_BEFORE=0x10;
    public static final int NEED_IPD =       0x20;
    public static final int HAS_ANCHORS =    0x40;
    // Set this flag if all fo:character generated Areas would
    // suppressed at the end or beginning of a line
    public static final int ALL_ARE_SUPPRESS_AT_LB =    0x80;
    /** This break possibility is a hyphenation */
    public static final int HYPHENATED =    0x100;
    /** If this break possibility ends the line, all remaining characters
     * in the lowest level text LM will be suppressed.
     */
    public static final int REST_ARE_SUPPRESS_AT_LB = 0x200;

    /** The opaque position object used by m_lm to record its
     *  break position.
     */
    private Position m_position;

    /**
     * The size range in the stacking direction of the area which would be
     * generated if this BreakPoss were used.
     */
    private MinOptMax m_stackSize;

    /**
     * Max height above and below the baseline. These are cumulative.
     */
    private int       m_iMaxAscender;
    private int       m_iMaxDescender;

    /** Size in the non-stacking direction (perpendicular). */
    private MinOptMax m_nonStackSize;

    private long m_flags = 0;
    private LayoutProps m_layoutProps = new LayoutProps();

    /** Store space-after (or end) and space-before (or start) to be
     * added if this break position is used.
     */
    private SpaceSpecifier m_spaceSpecTrailing;
    private SpaceSpecifier m_spaceSpecLeading;

    public BreakPoss(Position position) {
	this(position,0);
    }

    public BreakPoss(Position position, long flags) {
        m_position = position;
	m_flags = flags;
    }

    /**
     * The top-level layout manager responsible for this break
     */
    public BPLayoutManager getLayoutManager() {
        return m_position.getLM();
    }

//     public void setLayoutManager(BPLayoutManager lm) {
//         m_lm = lm;
//     }

    /**
     * An object representing the break position in this layout manager.
     */
    public Position getPosition() {
        return m_position;
    }

    public void setPosition(Position pos) {
        m_position = pos;
    }

    public void setStackingSize(MinOptMax size) {
	this.m_stackSize = size;
    }

    public MinOptMax getStackingSize() {
	return this.m_stackSize ;
    }

    public void setNonStackingSize(MinOptMax size) {
	this.m_nonStackSize  = size;
    }

    public MinOptMax getNonStackingSize() {
	return this.m_nonStackSize ;
    }

    public long getFlags() {
	return m_flags;
    }

    public void setFlag(int flagBit) {
        setFlag(flagBit, true);
    }

    public void setFlag(int flagBit, boolean bSet) {
        if (bSet) {
            m_flags |= flagBit;
        }
        else {
            m_flags &= ~flagBit;
        }
    }

    public boolean isLastArea() {
        return ((m_flags & ISLAST) != 0);
    }

    public boolean isFirstArea() {
        return ((m_flags & ISFIRST) != 0);
    }

    public boolean canBreakAfter() {
        return ((m_flags & CAN_BREAK_AFTER) != 0);
    }

    public boolean canBreakBefore() {
        return ((m_flags & CAN_BREAK_BEFORE) != 0);
    }

    public boolean couldEndLine() {
        return ((m_flags & REST_ARE_SUPPRESS_AT_LB) != 0);
    }

    public boolean isForcedBreak() {
        return ((m_flags & FORCE) != 0);
    }

    public boolean isSuppressible() {
        return ((m_flags & ALL_ARE_SUPPRESS_AT_LB) != 0);
    }

    public SpaceSpecifier getLeadingSpace() {
	return m_spaceSpecLeading;
    }

    public MinOptMax resolveLeadingSpace() {
	if (m_spaceSpecLeading != null) {
	    return m_spaceSpecLeading.resolve(false);
	}
	else return new MinOptMax(0);
    }

    public SpaceSpecifier getTrailingSpace() {
	return m_spaceSpecTrailing;
    }

    public MinOptMax resolveTrailingSpace(boolean bEndsRefArea) {
	if (m_spaceSpecTrailing != null) {
	    return m_spaceSpecTrailing.resolve(bEndsRefArea);
	}
	else return new MinOptMax(0);
    }


    public void setLeadingSpace(SpaceSpecifier spaceSpecLeading) {
	m_spaceSpecLeading = spaceSpecLeading;
    }

    public void setTrailingSpace(SpaceSpecifier spaceSpecTrailing) {
	m_spaceSpecTrailing = spaceSpecTrailing;
    }

    public LayoutProps getLayoutProps() {
	return m_layoutProps;
    }

    public boolean checkIPD() {
	return ((m_flags & NEED_IPD) != 0);
    }
}