KickJava   Java API By Example, From Geeks To Geeks.

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


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: RtfBookmarkContainerImpl.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  * RTF Bookmark container implementation.
34  * Nearly all containers or elements can have a bookmark, that is why the bookmark container is
35  * implemented as stand alone.
36  * @author <a HREF="mailto:a.putz@skynamics.com">Andreas Putz</a>
37  */
38 public class RtfBookmarkContainerImpl extends RtfContainer implements IRtfBookmarkContainer {
39     //////////////////////////////////////////////////
40 // @@ Members
41 //////////////////////////////////////////////////
42
43     /** Rtf bookmark */
44     private RtfBookmark mBookmark = null;
45
46
47     //////////////////////////////////////////////////
48 // @@ Construction
49 //////////////////////////////////////////////////
50
51     /**
52      * Constructor.
53      * Create an RTF container as a child of given container.
54      *
55      * @param parent The parent container
56      * @param w Writer
57      *
58      * @exception IOException On error
59      */
60     RtfBookmarkContainerImpl (RtfContainer parent, Writer JavaDoc w) throws IOException JavaDoc {
61         super (parent, w, null);
62     }
63
64     /**
65      * Constructor.
66      * Create an RTF container as a child of given container.
67      *
68      * @param parent The parent container
69      * @param w Writer
70      * @param attr Rtf attributes
71      *
72      * @exception IOException On error
73      */
74     RtfBookmarkContainerImpl (RtfContainer parent, Writer JavaDoc w, RtfAttributes attr) throws IOException JavaDoc
75     {
76         super (parent, w, attr);
77     }
78
79
80     //////////////////////////////////////////////////
81 // @@ Public methods
82 //////////////////////////////////////////////////
83
84     /**
85      * Create a new RTF bookmark.
86      *
87      * @param bookmark Name of the bookmark
88      *
89      * @return RTF bookmark
90      *
91      * @throws IOException On eror
92      */
93     public RtfBookmark newBookmark (String JavaDoc bookmark) throws IOException JavaDoc {
94         if (mBookmark != null) {
95             mBookmark.close ();
96         }
97
98         mBookmark = new RtfBookmark (this, writer, bookmark);
99
100         return mBookmark;
101     }
102 }
Popular Tags