aboutsummaryrefslogtreecommitdiffstats
path: root/src/org/apache/fop/fo/flow/PageNumberCitation.java
blob: b6ac87fad9fbc012848dfe32f3e4971833659abd (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
/*
 * $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.fo.flow;

// FOP
import org.apache.fop.fo.*;
import org.apache.fop.fo.pagination.*;
import org.apache.fop.datatypes.*;
import org.apache.fop.fo.properties.*;
import org.apache.fop.layout.*;
import org.apache.fop.apps.FOPException;
import org.apache.fop.layoutmgr.LeafNodeLayoutManager;
import org.apache.fop.area.inline.InlineArea;
import org.apache.fop.area.PageViewport;
import org.apache.fop.util.CharUtilities;
import org.apache.fop.apps.StructureHandler;
import org.apache.fop.layoutmgr.LayoutContext;
import org.apache.fop.layoutmgr.LayoutManager;
import org.apache.fop.layoutmgr.PositionIterator;
import org.apache.fop.area.inline.Word;
import org.apache.fop.area.inline.UnresolvedPageNumber;
import org.apache.fop.area.Resolveable;
import org.apache.fop.area.Trait;

import java.util.List;
import java.util.ArrayList;

/**
 * Page number citation.
 * This inline fo is replaced with the text for a page number.
 * The page number used is the page that contains the start of the
 * block referenced with the ref-id attribute.
 */
public class PageNumberCitation extends FObj {
    protected FontInfo fontInfo = null;
    protected FontState fontState;

    float red;
    float green;
    float blue;
    int wrapOption;
    int whiteSpaceCollapse;
    String pageNumber;
    String refId;
    TextState ts;
    InlineArea inline = null;
    boolean unresolved = false;

    public PageNumberCitation(FONode parent) {
        super(parent);
    }

    public void setStructHandler(StructureHandler st) {
        super.setStructHandler(st);
        fontInfo = st.getFontInfo();
    }

    public void addLayoutManager(List lms) {
        setup();
        lms.add(new LeafNodeLayoutManager(this) {
                    public InlineArea get(LayoutContext context) {
                        return getInlineArea(parentLM);
                    }

                    public void addAreas(PositionIterator posIter,
                                         LayoutContext context) {
                        super.addAreas(posIter, context);
                        if (unresolved) {
                            parentLM.addUnresolvedArea(refId,
                                                       (Resolveable) inline);
                        }
                    }

                    protected void offsetArea(LayoutContext context) {
                        curArea.setOffset(context.getBaseline());
                    }
                }
               );
    }

    // if id can be resolved then simply return a word, otherwise
    // return a resolveable area
    private InlineArea getInlineArea(LayoutManager parentLM) {
        if (refId.equals("")) {
            getLogger().error("page-number-citation must contain \"ref-id\"");
            return null;
        }
        PageViewport page = parentLM.resolveRefID(refId);
        if (page != null) {
            String str = page.getPageNumber();
            // get page string from parent, build area
            Word word = new Word();
            inline = word;
            int width = getStringWidth(str);
            word.setWord(str);
            inline.setIPD(width);
            inline.setHeight(fontState.getAscender() -
                             fontState.getDescender());
            inline.setOffset(fontState.getAscender());

            inline.addTrait(Trait.FONT_NAME, fontState.getFontName());
            inline.addTrait(Trait.FONT_SIZE,
                            new Integer(fontState.getFontSize()));
            unresolved = false;
        } else {
            unresolved = true;
            inline = new UnresolvedPageNumber(refId);
            String str = "MMM"; // reserve three spaces for page number
            int width = getStringWidth(str);
            inline.setIPD(width);
            inline.setHeight(fontState.getAscender() -
                             fontState.getDescender());
            inline.setOffset(fontState.getAscender());

            inline.addTrait(Trait.FONT_NAME, fontState.getFontName());
            inline.addTrait(Trait.FONT_SIZE,
                            new Integer(fontState.getFontSize()));
        }
        return inline;
    }

    protected int getStringWidth(String str) {
        int width = 0;
        for (int count = 0; count < str.length(); count++) {
            width += CharUtilities.getCharWidth(str.charAt(count),
                                                fontState);
        }
        return width;
    }

    public void setup() {

        // Common Accessibility Properties
        AccessibilityProps mAccProps = propMgr.getAccessibilityProps();

        // Common Aural Properties
        AuralProps mAurProps = propMgr.getAuralProps();

        // Common Border, Padding, and Background Properties
        BorderAndPadding bap = propMgr.getBorderAndPadding();
        BackgroundProps bProps = propMgr.getBackgroundProps();

        // Common Font Properties
        this.fontState = propMgr.getFontState(fontInfo);

        // Common Margin Properties-Inline
        MarginInlineProps mProps = propMgr.getMarginInlineProps();

        // Common Relative Position Properties
        RelativePositionProps mRelProps =
          propMgr.getRelativePositionProps();

        // this.properties.get("alignment-adjust");
        // this.properties.get("alignment-baseline");
        // this.properties.get("baseline-shift");
        // this.properties.get("dominant-baseline");
        setupID();
        // this.properties.get("keep-with-next");
        // this.properties.get("keep-with-previous");
        // this.properties.get("letter-spacing");
        // this.properties.get("line-height");
        // this.properties.get("line-height-shift-adjustment");
        // this.properties.get("ref-id");
        // this.properties.get("score-spaces");
        // this.properties.get("text-decoration");
        // this.properties.get("text-shadow");
        // this.properties.get("text-transform");
        // this.properties.get("word-spacing");

        ColorType c = this.properties.get("color").getColorType();
        this.red = c.red();
        this.green = c.green();
        this.blue = c.blue();

        this.wrapOption = this.properties.get("wrap-option").getEnum();
        this.whiteSpaceCollapse =
          this.properties.get("white-space-collapse").getEnum();

        this.refId = this.properties.get("ref-id").getString();

        if (this.refId.equals("")) {
            //throw new FOPException("page-number-citation must contain \"ref-id\"");
        }

    }

}