KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > fop > render > rtf > rtflib > rtfdoc > RtfPageNumberCitation


1 /*
2  * Licensed to the Apache Software Foundation (ASF) under one or more
3  * contributor license agreements. See the NOTICE file distributed with
4  * this work for additional information regarding copyright ownership.
5  * The ASF licenses this file to You under the Apache License, Version 2.0
6  * (the "License"); you may not use this file except in compliance with
7  * the License. You may obtain a copy of the License at
8  *
9  * http://www.apache.org/licenses/LICENSE-2.0
10  *
11  * Unless required by applicable law or agreed to in writing, software
12  * distributed under the License is distributed on an "AS IS" BASIS,
13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14  * See the License for the specific language governing permissions and
15  * limitations under the License.
16  */
17
18 /* $Id: RtfPageNumberCitation.java 426576 2006-07-28 15:44:37Z jeremias $ */
19
20 package org.apache.fop.render.rtf.rtflib.rtfdoc;
21
22 /*
23  * This file is part of the RTF library of the FOP project, which was originally
24  * created by Bertrand Delacretaz <bdelacretaz@codeconsult.ch> and by other
25  * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to
26  * the FOP project.
27  */
28
29 import java.io.Writer JavaDoc;
30 import java.io.IOException JavaDoc;
31
32 /**
33  * @author Christopher Scott, scottc@westinghouse.com
34  * @author Boris Pouderous, boris.pouderous@free.fr
35  */
36 public class RtfPageNumberCitation extends RtfContainer {
37     /* Page field :
38        "{\field {\*\fldinst {PAGEREF xx}} {\fldrslt}}" where xx represents the
39        'id' of the referenced page
40     */
41
42     /** constant for field */
43     public static final String JavaDoc RTF_FIELD = "field";
44     /** constant for field pageref model */
45     public static final String JavaDoc RTF_FIELD_PAGEREF_MODEL = "fldinst { PAGEREF }";
46     /** constant for field result */
47     public static final String JavaDoc RTF_FIELD_RESULT = "fldrslt";
48
49     // The 'id' of the referenced page
50 private String JavaDoc id = null;
51
52     /** Create an RTF page number citation as a child of given container with default attributes */
53     RtfPageNumberCitation (IRtfPageNumberCitationContainer parent, Writer JavaDoc w, String JavaDoc id)
54             throws IOException JavaDoc {
55         super((RtfContainer)parent, w);
56         this.id = id;
57     }
58
59     /** Create an RTF page number citation as a child of given
60      * paragraph, copying its attributes */
61     RtfPageNumberCitation (RtfParagraph parent, Writer JavaDoc w, String JavaDoc id)
62             throws IOException JavaDoc {
63         // add the attributes ant text attributes of the parent paragraph
64 super((RtfContainer)parent, w, parent.attrib);
65         if (parent.getTextAttributes() != null) {
66             attrib.set(parent.getTextAttributes());
67         }
68         this.id = id;
69     }
70
71     /**
72      * Write the content
73      * @throws IOException for I/O problems
74      */
75     protected void writeRtfContent() throws IOException JavaDoc {
76         // If we have a valid ID
77 if (isValid()) {
78             // Build page reference field
79 String JavaDoc pageRef = RTF_FIELD_PAGEREF_MODEL;
80             final int insertionIndex = pageRef.indexOf("}");
81             pageRef = pageRef.substring(0, insertionIndex)
82                 + "\"" + id
83                 + "\"" + " "
84                 + pageRef.substring(insertionIndex, pageRef.length());
85             id = null;
86
87             // Write RTF content
88 writeGroupMark(true);
89             writeControlWord(RTF_FIELD);
90             writeGroupMark(true);
91             writeAttributes(attrib, RtfText.ATTR_NAMES); // Added by Boris Poudérous
92 writeStarControlWord(pageRef);
93             writeGroupMark(false);
94             writeGroupMark(true);
95             writeControlWord(RTF_FIELD_RESULT);
96             writeGroupMark(false);
97             writeGroupMark(false);
98         }
99     }
100
101     /** checks that the 'ref-id' attribute exists */
102     private boolean isValid() {
103         return (id != null);
104     }
105
106     /**
107      * @return true if this element would generate no "useful" RTF content
108      */
109     public boolean isEmpty() {
110         return false;
111     }
112 }
Popular Tags