IRtfTextContainer


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: IRtfTextContainer.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.IOException  ;
30  
31  /**  Interface for RtfElements that can contain RtfText elements
32   *  @author Bertrand Delacretaz bdelacretaz@codeconsult.ch
33   */
34  
35  public interface IRtfTextContainer {
36      /**
37       * Close current text element, if any, and start a new one
38       * @param str if not null, added to the RtfText created
39       * @param attr attributes for text
40       * @return new text object
41       * @throws IOException for I/O problems
42       */
43      RtfText newText(String   str, RtfAttributes attr) throws IOException  ;
44  
45      /**
46       * Close current text run, if any, and start a new one with default attributes
47       * @param str if not null, added to the RtfText created
48       * @return a new text object
49       * @throws IOException for I/O problems
50       */
51      RtfText newText(String   str) throws IOException  ;
52  
53      /**
54       * Add a line break
55       * @throws IOException for I/O problems
56       */
57      void newLineBreak() throws IOException  ;
58  
59      /**
60       * Text containers usually provide default attributes for all texts that they contain.
61       * @return a copy of the container's attributes.
62       */
63      RtfAttributes getTextContainerAttributes();
64  }
65
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags