aboutsummaryrefslogtreecommitdiffstats
path: root/src/java/org/apache/fop/layoutmgr/Position.java
blob: 8230e64f09fb33c73f5829d6c8f847f8adc435dc (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
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/* $Id$ */

package org.apache.fop.layoutmgr;

/** A position. */
public class Position {

    private LayoutManager layoutManager;
    private int index = -1;

    /**
     * Construct a position.
     * @param lm the associated layout manager
     */
    public Position(LayoutManager lm) {
        layoutManager = lm;
    }

    /**
     * Construct a position.
     * @param lm the associated layout manager
     * @param index the index
     */
   public Position(LayoutManager lm, int index) {
        this(lm);
        setIndex(index);
    }
    /** @return associated layout manager */
    public LayoutManager getLM() {
        return layoutManager;
    }

    /**
     * @param depth the depth at which the LM in this position is found
     * @return associated layout manager
     */
    public LayoutManager getLM(int depth) {
        Position subPos = getPosition(depth);
        if (subPos == null) {
            return null;
        } else {
            return subPos.getLM();
        }
    }

    /**
     * Overridden by NonLeafPosition to return the Position of its child LM.
     * @return a position or null
     */
    public Position getPosition() {
        return null;
    }

    /**
     * Overridden by NonLeafPosition to return the Position of its child LM.
     * @param depth the depth at which the position in this position is found
     * @return a position or null
     */
    public Position getPosition(int depth) {
        Position subPos = this;
        for (int i = 0; i < depth && subPos != null; ++i, subPos = subPos.getPosition()) {
            // no-op
        }
        return subPos;
    }

    /** @return true if generates areas */
    public boolean generatesAreas() {
        return false;
    }

    /**
     * Sets the index of this position in the sequence of Position elements.
     *
     * @param value this position's index
     */
    public void setIndex(int value) {
        this.index = value;
    }

    /**
     * Returns the index of this position in the sequence of Position elements.
     *
     * @return the index of this position in the sequence of Position elements
     */
    public int getIndex() {
        return this.index;
    }

    /** @return short name of associated layout manager */
    protected String getShortLMName() {
        if (getLM() != null) {
            String lm = getLM().toString();
            int idx = lm.lastIndexOf('.');
            if (idx >= 0 && lm.indexOf('@') > 0) {
                return lm.substring(idx + 1);
            } else {
                return lm;
            }
        } else {
            return "null";
        }
    }

    /** {@inheritDoc} */
    public String toString() {
        StringBuffer sb = new StringBuffer();
        sb.append("Position:").append(getIndex()).append("(");
        sb.append(getShortLMName());
        sb.append(")");
        return sb.toString();
    }
}