123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273 |
- /*
- * $Id$
- * ============================================================================
- * The Apache Software License, Version 1.1
- * ============================================================================
- *
- * Copyright (C) 1999-2003 The Apache Software Foundation. All rights reserved.
- *
- * Redistribution and use in source and binary forms, with or without modifica-
- * tion, are permitted provided that the following conditions are met:
- *
- * 1. Redistributions of source code must retain the above copyright notice,
- * this list of conditions and the following disclaimer.
- *
- * 2. Redistributions in binary form must reproduce the above copyright notice,
- * this list of conditions and the following disclaimer in the documentation
- * and/or other materials provided with the distribution.
- *
- * 3. The end-user documentation included with the redistribution, if any, must
- * include the following acknowledgment: "This product includes software
- * developed by the Apache Software Foundation (http://www.apache.org/)."
- * Alternately, this acknowledgment may appear in the software itself, if
- * and wherever such third-party acknowledgments normally appear.
- *
- * 4. The names "FOP" and "Apache Software Foundation" must not be used to
- * endorse or promote products derived from this software without prior
- * written permission. For written permission, please contact
- * apache@apache.org.
- *
- * 5. Products derived from this software may not be called "Apache", nor may
- * "Apache" appear in their name, without prior written permission of the
- * Apache Software Foundation.
- *
- * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES,
- * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
- * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
- * APACHE SOFTWARE FOUNDATION OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
- * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLU-
- * DING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS
- * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
- * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
- * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
- * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- * ============================================================================
- *
- * This software consists of voluntary contributions made by many individuals
- * on behalf of the Apache Software Foundation and was originally created by
- * James Tauber <jtauber@jtauber.com>. For more information on the Apache
- * Software Foundation, please see <http://www.apache.org/>.
- */
-
- /*
- * This file is part of the RTF library of the FOP project, which was originally
- * created by Bertrand Delacretaz <bdelacretaz@codeconsult.ch> and by other
- * contributors to the jfor project (www.jfor.org), who agreed to donate jfor to
- * the FOP project.
- */
-
- package org.apache.fop.render.rtf.rtflib.rtfdoc;
-
- import org.apache.fop.render.rtf.rtflib.exceptions.RtfStructureException;
- import java.io.Writer;
- import java.io.IOException;
- import java.io.BufferedWriter;
- import java.io.FileWriter;
- import java.io.OutputStreamWriter;
-
- /**
- * Models the top-level structure of an RTF file.
- * @author Bertrand Delacretaz bdelacretaz@codeconsult.ch
- * @author Andreas Putz a.putz@skynamics.com
- * @author Christopher Scott scottc@westinghouse.com
- */
-
- public class RtfFile
- extends RtfContainer {
- private RtfHeader header;
- private RtfPageArea pageArea;
- private RtfListTable listTable;
- private RtfDocumentArea docArea;
- // private ConverterLogChannel m_log;
- private RtfContainer listTableContainer;
- private int listNum = 0;
-
- /**
- * Create an RTF file that outputs to the given Writer
- * @param w the Writer to write to
- * @throws IOException for I/O problems
- */
- public RtfFile(Writer w) throws IOException {
- super(null, w);
- }
-
- /** optional log channel */
- // public void setLogChannel(ConverterLogChannel log)
- // {
- // m_log = log;
- // }
-
- /**
- * Gets the log channel.
- * If logchannel not set, it will return a empty log channel.
- * @return our log channel, it is never null */
- // ConverterLogChannel getLog()
- // {
- // if (m_log == null)
- // m_log = new ConverterLogChannel (null);
- // return m_log;
- // }
-
- /**
- * If called, must be called before startDocumentArea
- * @return the new RtfHeader
- * @throws IOException for I/O problems
- */
- public RtfHeader startHeader()
- throws IOException {
- if (header != null) {
- throw new RtfStructureException("startHeader called more than once");
- }
- header = new RtfHeader(this, writer);
- listTableContainer = new RtfContainer(this, writer);
- return header;
- }
-
- /**
- * Creates the list table.
- * @param attr attributes for the RtfListTable
- * @return the new RtfListTable
- * @throws IOException for I/O problems
- */
- public RtfListTable startListTable(RtfAttributes attr)
- throws IOException {
- listNum++;
- listTable = new RtfListTable(this, writer, new Integer(listNum), attr);
- listTableContainer.addChild(listTable);
- return listTable;
- }
-
- /**
- * Closes the RtfHeader if not done yet, and starts the docment area.
- * Like startDocumentArea, is only called once. This is not optimal,
- * must be able to have multiple page definition, and corresponding
- * Document areas
- * @return the RtfPageArea
- * @throws IOException for I/O problems
- * @throws RtfStructureException for illegal RTF structure
- */
- public RtfPageArea startPageArea()
- throws IOException, RtfStructureException {
- if (pageArea != null) {
- throw new RtfStructureException("startPageArea called more than once");
- }
- // create an empty header if there was none
- if (header == null) {
- startHeader();
- }
- header.close();
- pageArea = new RtfPageArea(this, writer);
- addChild(pageArea);
- return pageArea;
- }
-
- /**
- * Call startPageArea if needed and return the page area object.
- * @return the RtfPageArea
- * @throws IOException for I/O problems
- * @throws RtfStructureException for illegal RTF structure
- */
- public RtfPageArea getPageArea()
- throws IOException, RtfStructureException {
- if (pageArea == null) {
- return startPageArea();
- }
- return pageArea;
- }
-
- /**
- * Closes the RtfHeader if not done yet, and starts the document area.
- * Must be called once only.
- * @return the RtfDocumentArea
- * @throws IOException for I/O problems
- * @throws RtfStructureException for illegal RTF structure
- */
- public RtfDocumentArea startDocumentArea()
- throws IOException, RtfStructureException {
- if (docArea != null) {
- throw new RtfStructureException("startDocumentArea called more than once");
- }
- // create an empty header if there was none
- if (header == null) {
- startHeader();
- }
- header.close();
- docArea = new RtfDocumentArea(this, writer);
- addChild(docArea);
- return docArea;
- }
-
-
-
- /**
- * Call startDocumentArea if needed and return the document area object.
- * @return the RtfDocumentArea
- * @throws IOException for I/O problems
- * @throws RtfStructureException for illegal RTF structure
- */
- public RtfDocumentArea getDocumentArea()
- throws IOException, RtfStructureException {
- if (docArea == null) {
- return startDocumentArea();
- }
- return docArea;
- }
-
- /**
- * overridden to write RTF prefix code, what comes before our children
- * @throws IOException for I/O problems
- */
- protected void writeRtfPrefix() throws IOException {
- writeGroupMark(true);
- writeControlWord("rtf1");
- }
-
- /**
- * overridden to write RTF suffix code, what comes after our children
- * @throws IOException for I/O problems
- */
- protected void writeRtfSuffix() throws IOException {
- writeGroupMark(false);
- }
-
- /**
- * must be called when done creating the document
- * @throws IOException for I/O problems
- */
- public synchronized void flush() throws IOException {
- writeRtf();
- writer.flush();
- }
-
- /**
- * minimal test and usage example
- * @param args command-line arguments
- * @throws Exception for problems
- */
- public static void main(String args[])
- throws Exception {
- Writer w = null;
- if (args.length != 0) {
- final String outFile = args[0];
- System.err.println("Outputting RTF to file '" + outFile + "'");
- w = new BufferedWriter(new FileWriter(outFile));
- } else {
- System.err.println("Outputting RTF code to standard output");
- w = new BufferedWriter(new OutputStreamWriter(System.out));
- }
-
- final RtfFile f = new RtfFile(w);
- final RtfSection sect = f.startDocumentArea().newSection();
-
- final RtfParagraph p = sect.newParagraph();
- p.newText("Hello, RTF world.\n", null);
- final RtfAttributes attr = new RtfAttributes();
- attr.set(RtfText.ATTR_BOLD);
- attr.set(RtfText.ATTR_ITALIC);
- attr.set(RtfText.ATTR_FONT_SIZE, 36);
- p.newText("This is bold, italic, 36 points", attr);
-
- f.flush();
- System.err.println("RtfFile test: all done.");
- }
- }
|