From 6025b6016517c6d898d8957d1d7e03ba71431912 Mon Sep 17 00:00:00 2001 From: tknall Date: Fri, 1 Dec 2006 12:20:24 +0000 Subject: Initial import of release 2.2. git-svn-id: https://joinup.ec.europa.eu/svn/pdf-as/trunk@4 7b5415b0-85f9-ee4d-85bd-d5d0c3b42d1c --- .../java/com/lowagie/text/rtf/field/RtfAnchor.java | 122 ++++++ .../java/com/lowagie/text/rtf/field/RtfField.java | 445 +++++++++++++++++++++ .../com/lowagie/text/rtf/field/RtfPageNumber.java | 83 ++++ .../com/lowagie/text/rtf/field/RtfTOCEntry.java | 163 ++++++++ .../lowagie/text/rtf/field/RtfTableOfContents.java | 109 +++++ .../lowagie/text/rtf/field/RtfTotalPageNumber.java | 128 ++++++ 6 files changed, 1050 insertions(+) create mode 100644 src/main/java/com/lowagie/text/rtf/field/RtfAnchor.java create mode 100644 src/main/java/com/lowagie/text/rtf/field/RtfField.java create mode 100644 src/main/java/com/lowagie/text/rtf/field/RtfPageNumber.java create mode 100644 src/main/java/com/lowagie/text/rtf/field/RtfTOCEntry.java create mode 100644 src/main/java/com/lowagie/text/rtf/field/RtfTableOfContents.java create mode 100644 src/main/java/com/lowagie/text/rtf/field/RtfTotalPageNumber.java (limited to 'src/main/java/com/lowagie/text/rtf/field') diff --git a/src/main/java/com/lowagie/text/rtf/field/RtfAnchor.java b/src/main/java/com/lowagie/text/rtf/field/RtfAnchor.java new file mode 100644 index 0000000..3823c3d --- /dev/null +++ b/src/main/java/com/lowagie/text/rtf/field/RtfAnchor.java @@ -0,0 +1,122 @@ +/* + * $Id: RtfAnchor.java,v 1.9 2005/07/07 14:44:47 hallm Exp $ + * $Name: $ + * + * Copyright 2004 by Mark Hall + * + * The contents of this file are subject to the Mozilla Public License Version 1.1 + * (the "License"); you may not use this file except in compliance with the License. + * You may obtain a copy of the License at http://www.mozilla.org/MPL/ + * + * Software distributed under the License is distributed on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License + * for the specific language governing rights and limitations under the License. + * + * The Original Code is 'iText, a free JAVA-PDF library'. + * + * The Initial Developer of the Original Code is Bruno Lowagie. Portions created by + * the Initial Developer are Copyright (C) 1999, 2000, 2001, 2002 by Bruno Lowagie. + * All Rights Reserved. + * Co-Developer of the code is Paulo Soares. Portions created by the Co-Developer + * are Copyright (C) 2000, 2001, 2002 by Paulo Soares. All Rights Reserved. + * + * Contributor(s): all the names of the contributors are added in the source code + * where applicable. + * + * Alternatively, the contents of this file may be used under the terms of the + * LGPL license (the ?GNU LIBRARY GENERAL PUBLIC LICENSE?), in which case the + * provisions of LGPL are applicable instead of those above. If you wish to + * allow use of your version of this file only under the terms of the LGPL + * License and not to allow others to use your version of this file under + * the MPL, indicate your decision by deleting the provisions above and + * replace them with the notice and other provisions required by the LGPL. + * If you do not delete the provisions above, a recipient may use your version + * of this file under either the MPL or the GNU LIBRARY GENERAL PUBLIC LICENSE. + * + * This library is free software; you can redistribute it and/or modify it + * under the terms of the MPL as stated above or under the terms of the GNU + * Library General Public License as published by the Free Software Foundation; + * either version 2 of the License, or any later version. + * + * This library is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS + * FOR A PARTICULAR PURPOSE. See the GNU Library general Public License for more + * details. + * + * If you didn't download this code from the following link, you should check if + * you aren't using an obsolete version: + * http://www.lowagie.com/iText/ + */ + +package com.lowagie.text.rtf.field; + +import java.io.ByteArrayOutputStream; +import java.io.IOException; + +import com.lowagie.text.Anchor; +import com.lowagie.text.rtf.document.RtfDocument; +import com.lowagie.text.rtf.text.RtfPhrase; + + +/** + * + * @version $Version:$ + * @author Mark Hall (mhall@edu.uni-klu.ac.at) + * @author Werner Daehn (Werner.Daehn@BusinessObjects.com) + */ +public class RtfAnchor extends RtfField { + + /** + * Constant for a hyperlink + */ + private static final byte[] HYPERLINK = "HYPERLINK".getBytes(); + + /** + * The url of this RtfAnchor + */ + private String url = ""; + /** + * The RtfPhrase to display for the url + */ + private RtfPhrase content = null; + + /** + * Constructs a RtfAnchor based on a RtfField + * + * @param doc The RtfDocument this RtfAnchor belongs to + * @param anchor The Anchor this RtfAnchor is based on + */ + public RtfAnchor(RtfDocument doc, Anchor anchor) { + super(doc); + this.url = anchor.reference(); + this.content = new RtfPhrase(doc, anchor); + } + + /** + * Write the field instructions for this RtfAnchor. Sets the field + * type to HYPERLINK and then writes the url. + * + * @return The field instructions for this RtfAnchor + * @throws IOException + */ + protected byte[] writeFieldInstContent() throws IOException { + ByteArrayOutputStream result = new ByteArrayOutputStream(); + + result.write(HYPERLINK); + result.write(DELIMITER); + result.write(url.getBytes()); + + return result.toByteArray(); + } + + /** + * Write the field result for this RtfAnchor. Writes the content + * of the RtfPhrase. + * + * @return The field result for this RtfAnchor + * @throws IOException + */ + protected byte[] writeFieldResultContent() throws IOException { + return content.write(); + } +} diff --git a/src/main/java/com/lowagie/text/rtf/field/RtfField.java b/src/main/java/com/lowagie/text/rtf/field/RtfField.java new file mode 100644 index 0000000..6eaa525 --- /dev/null +++ b/src/main/java/com/lowagie/text/rtf/field/RtfField.java @@ -0,0 +1,445 @@ +/* + * $Id: RtfField.java,v 1.11 2005/09/05 16:02:40 hallm Exp $ + * $Name: $ + * + * Copyright 2004 by Mark Hall + * Uses code Copyright 2002 + * SMB + * Dirk.Weigenand@smb-tec.com + * + * The contents of this file are subject to the Mozilla Public License Version 1.1 + * (the "License"); you may not use this file except in compliance with the License. + * You may obtain a copy of the License at http://www.mozilla.org/MPL/ + * + * Software distributed under the License is distributed on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License + * for the specific language governing rights and limitations under the License. + * + * The Original Code is 'iText, a free JAVA-PDF library'. + * + * The Initial Developer of the Original Code is Bruno Lowagie. Portions created by + * the Initial Developer are Copyright (C) 1999, 2000, 2001, 2002 by Bruno Lowagie. + * All Rights Reserved. + * Co-Developer of the code is Paulo Soares. Portions created by the Co-Developer + * are Copyright (C) 2000, 2001, 2002 by Paulo Soares. All Rights Reserved. + * + * Contributor(s): all the names of the contributors are added in the source code + * where applicable. + * + * Alternatively, the contents of this file may be used under the terms of the + * LGPL license (the ?GNU LIBRARY GENERAL PUBLIC LICENSE?), in which case the + * provisions of LGPL are applicable instead of those above. If you wish to + * allow use of your version of this file only under the terms of the LGPL + * License and not to allow others to use your version of this file under + * the MPL, indicate your decision by deleting the provisions above and + * replace them with the notice and other provisions required by the LGPL. + * If you do not delete the provisions above, a recipient may use your version + * of this file under either the MPL or the GNU LIBRARY GENERAL PUBLIC LICENSE. + * + * This library is free software; you can redistribute it and/or modify it + * under the terms of the MPL as stated above or under the terms of the GNU + * Library General Public License as published by the Free Software Foundation; + * either version 2 of the License, or any later version. + * + * This library is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS + * FOR A PARTICULAR PURPOSE. See the GNU Library general Public License for more + * details. + * + * If you didn't download this code from the following link, you should check if + * you aren't using an obsolete version: + * http://www.lowagie.com/iText/ + */ + +package com.lowagie.text.rtf.field; + +import java.io.ByteArrayOutputStream; +import java.io.IOException; + +import com.lowagie.text.Chunk; +import com.lowagie.text.Font; +import com.lowagie.text.rtf.RtfBasicElement; +import com.lowagie.text.rtf.document.RtfDocument; +import com.lowagie.text.rtf.style.RtfFont; + + +/** + * The RtfField class is an abstract base class for all rtf field functionality. + * Subclasses only need to implement the two abstract methods writeFieldInstContent + * and writeFieldResultContent. All other field functionality is handled by the + * RtfField class. + * + * @version $Version:$ + * @author Mark Hall (mhall@edu.uni-klu.ac.at) + * @author Dirk Weigenand + */ +public abstract class RtfField extends Chunk implements RtfBasicElement { + + /** + * Constant for a rtf field + */ + private static final byte[] FIELD = "\\field".getBytes(); + /** + * Constant for a dirty field + */ + private static final byte[] FIELD_DIRTY = "\\flddirty".getBytes(); + /** + * Constant for a private field + */ + private static final byte[] FIELD_PRIVATE = "\\fldpriv".getBytes(); + /** + * Constant for a locked field + */ + private static final byte[] FIELD_LOCKED = "\\fldlock".getBytes(); + /** + * Constant for a edited field + */ + private static final byte[] FIELD_EDIT = "\\fldedit".getBytes(); + /** + * Constant for an alt field + */ + private static final byte[] FIELD_ALT = "\\fldalt".getBytes(); + /** + * Constant for the field instructions + */ + private static final byte[] FIELD_INSTRUCTIONS = "\\*\\fldinst".getBytes(); + /** + * Constant for the field result + */ + private static final byte[] FIELD_RESULT = "\\fldrslt".getBytes(); + + /** + * Is the field dirty + */ + private boolean fieldDirty = false; + /** + * Is the field edited + */ + private boolean fieldEdit = false; + /** + * Is the field locked + */ + private boolean fieldLocked = false; + /** + * Is the field private + */ + private boolean fieldPrivate = false; + /** + * Is it an alt field + */ + private boolean fieldAlt = false; + /** + * Whether this RtfField is in a table + */ + private boolean inTable = false; + /** + * Whether this RtfElement is in a header + */ + private boolean inHeader = false; + /** + * The RtfDocument this RtfField belongs to + */ + protected RtfDocument document = null; + /** + * The RtfFont of this RtfField + */ + private RtfFont font = null; + + /** + * Constructs a RtfField for a RtfDocument. This is not very usefull, + * since the RtfField by itself does not do anything. Use one of the + * subclasses instead. + * + * @param doc The RtfDocument this RtfField belongs to. + */ + protected RtfField(RtfDocument doc) { + this(doc, new Font()); + } + + /** + * Constructs a RtfField for a RtfDocument. This is not very usefull, + * since the RtfField by itself does not do anything. Use one of the + * subclasses instead. + * + * @param doc The RtfDocument this RtfField belongs to. + * @param font The Font this RtfField should use + */ + protected RtfField(RtfDocument doc, Font font) { + super("", font); + this.document = doc; + this.font = new RtfFont(this.document, font); + } + + /** + * Sets the RtfDocument this RtfElement belongs to + * + * @param doc The RtfDocument to use + */ + public void setRtfDocument(RtfDocument doc) { + this.document = doc; + this.font.setRtfDocument(this.document); + } + + /** + * Writes the field beginning. Also writes field properties. + * + * @return A byte array with the field beginning. + * @throws IOException + */ + private byte[] writeFieldBegin() throws IOException { + ByteArrayOutputStream result = new ByteArrayOutputStream(); + + result.write(OPEN_GROUP); + result.write(FIELD); + + if (fieldDirty) { + result.write(FIELD_DIRTY); + } + if (fieldEdit) { + result.write(FIELD_EDIT); + } + if (fieldLocked) { + result.write(FIELD_LOCKED); + } + if (fieldPrivate) { + result.write(FIELD_PRIVATE); + } + + return result.toByteArray(); + } + + /** + * Writes the beginning of the field instruction area. + * + * @return The beginning of the field instruction area + * @throws IOException + */ + private byte[] writeFieldInstBegin() throws IOException { + ByteArrayOutputStream result = new ByteArrayOutputStream(); + + result.write(OPEN_GROUP); + result.write(FIELD_INSTRUCTIONS); + result.write(DELIMITER); + + return result.toByteArray(); + } + + /** + * Writes the content of the field instruction area. Override this + * method in your subclasses. + * + * @return The content of the field instruction area + * @throws IOException If an error occurs. + */ + protected abstract byte[] writeFieldInstContent() throws IOException; + + /** + * Writes the end of the field instruction area. + * + * @return A byte array containing the end of the field instruction area + * @throws IOException + */ + private byte[] writeFieldInstEnd() throws IOException { + ByteArrayOutputStream result = new ByteArrayOutputStream(); + + if (fieldAlt) { + result.write(DELIMITER); + result.write(FIELD_ALT); + } + result.write(CLOSE_GROUP); + + return result.toByteArray(); + } + + /** + * Writes the beginning of the field result area + * + * @return A byte array containing the beginning of the field result area + * @throws IOException + */ + private byte[] writeFieldResultBegin() throws IOException { + ByteArrayOutputStream result = new ByteArrayOutputStream(); + + result.write(OPEN_GROUP); + result.write(FIELD_RESULT); + result.write(DELIMITER); + + return result.toByteArray(); + } + + /** + * Writes the content of the pre-calculated field result. Override this + * method in your subclasses. + * + * @return A byte array containing the field result + * @throws IOException If an error occurs + */ + protected abstract byte[] writeFieldResultContent() throws IOException; + + /** + * Writes the end of the field result area + * + * @return A byte array containing the end of the field result area + * @throws IOException + */ + private byte[] writeFieldResultEnd() throws IOException { + ByteArrayOutputStream result = new ByteArrayOutputStream(); + + result.write(DELIMITER); + result.write(CLOSE_GROUP); + + return result.toByteArray(); + } + + /** + * Writes the end of the field + * + * @return A byte array containing the end of the field + * @throws IOException + */ + private byte[] writeFieldEnd() throws IOException { + ByteArrayOutputStream result = new ByteArrayOutputStream(); + + result.write(CLOSE_GROUP); + + return result.toByteArray(); + } + + /** + * Write the content of this RtfField. + * + * @return A byte array containing the content of this RtfField + */ + public byte[] write() { + ByteArrayOutputStream result = new ByteArrayOutputStream(); + try { + result.write(this.font.writeBegin()); + result.write(writeFieldBegin()); + result.write(writeFieldInstBegin()); + result.write(writeFieldInstContent()); + result.write(writeFieldInstEnd()); + result.write(writeFieldResultBegin()); + result.write(writeFieldResultContent()); + result.write(writeFieldResultEnd()); + result.write(writeFieldEnd()); + result.write(this.font.writeEnd()); + } catch(IOException ioe) { + ioe.printStackTrace(); + } + return result.toByteArray(); + } + + /** + * Get whether this field is an alt field + * + * @return Returns whether this field is an alt field + */ + public boolean isFieldAlt() { + return fieldAlt; + } + + /** + * Set whether this field is an alt field + * + * @param fieldAlt The value to use + */ + public void setFieldAlt(boolean fieldAlt) { + this.fieldAlt = fieldAlt; + } + + /** + * Get whether this field is dirty + * + * @return Returns whether this field is dirty + */ + public boolean isFieldDirty() { + return fieldDirty; + } + + /** + * Set whether this field is dirty + * + * @param fieldDirty The value to use + */ + public void setFieldDirty(boolean fieldDirty) { + this.fieldDirty = fieldDirty; + } + + /** + * Get whether this field is edited + * + * @return Returns whether this field is edited + */ + public boolean isFieldEdit() { + return fieldEdit; + } + + /** + * Set whether this field is edited. + * + * @param fieldEdit The value to use + */ + public void setFieldEdit(boolean fieldEdit) { + this.fieldEdit = fieldEdit; + } + + /** + * Get whether this field is locked + * + * @return Returns the fieldLocked. + */ + public boolean isFieldLocked() { + return fieldLocked; + } + + /** + * Set whether this field is locked + * @param fieldLocked The value to use + */ + public void setFieldLocked(boolean fieldLocked) { + this.fieldLocked = fieldLocked; + } + + /** + * Get whether this field is private + * + * @return Returns the fieldPrivate. + */ + public boolean isFieldPrivate() { + return fieldPrivate; + } + + /** + * Set whether this field is private + * + * @param fieldPrivate The value to use + */ + public void setFieldPrivate(boolean fieldPrivate) { + this.fieldPrivate = fieldPrivate; + } + + /** + * Sets whether this RtfField is in a table + * + * @param inTable True if this RtfField is in a table, false otherwise + */ + public void setInTable(boolean inTable) { + this.inTable = inTable; + } + + /** + * Sets whether this RtfField is in a header + * + * @param inHeader True if this RtfField is in a header, false otherwise + */ + public void setInHeader(boolean inHeader) { + this.inHeader = inHeader; + } + + /** + * An RtfField is never empty. + */ + public boolean isEmpty() { + return false; + } +} diff --git a/src/main/java/com/lowagie/text/rtf/field/RtfPageNumber.java b/src/main/java/com/lowagie/text/rtf/field/RtfPageNumber.java new file mode 100644 index 0000000..3b69295 --- /dev/null +++ b/src/main/java/com/lowagie/text/rtf/field/RtfPageNumber.java @@ -0,0 +1,83 @@ +/* + * Created on Aug 10, 2004 + * + * To change the template for this generated file go to + * Window - Preferences - Java - Code Generation - Code and Comments + */ +package com.lowagie.text.rtf.field; + +import java.io.IOException; + +import com.lowagie.text.Font; +import com.lowagie.text.rtf.document.RtfDocument; + + +/** + * The RtfPageNumber provides the page number field in rtf documents. + * + * @version $Revision: 1.7 $ + * @author Mark Hall (mhall@edu.uni-klu.ac.at) + * @author Steffen.Stundzig@smb-tec.com + */ +public class RtfPageNumber extends RtfField { + + /** + * Constant for the page number + */ + private static final byte[] PAGE_NUMBER = "PAGE".getBytes(); + + /** + * Constructs a RtfPageNumber. This can be added anywhere to add a page number field. + */ + public RtfPageNumber() { + super(null); + } + + /** + * Constructs a RtfPageNumber with a specified Font. This can be added anywhere to + * add a page number field. + * @param font + */ + public RtfPageNumber(Font font) { + super(null, font); + } + + /** + * Constructs a RtfPageNumber object. + * + * @param doc The RtfDocument this RtfPageNumber belongs to + */ + public RtfPageNumber(RtfDocument doc) { + super(doc); + } + + /** + * Constructs a RtfPageNumber object with a specific font. + * + * @param doc The RtfDocument this RtfPageNumber belongs to + * @param font The Font to use + */ + public RtfPageNumber(RtfDocument doc, Font font) { + super(doc, font); + } + + /** + * Writes the field instruction content + * + * @return A byte array containing "PAGE" + * @throws IOException + */ + protected byte[] writeFieldInstContent() throws IOException { + return PAGE_NUMBER; + } + + /** + * Writes the field result content + * + * @return An empty byte array + * @throws IOException + */ + protected byte[] writeFieldResultContent() throws IOException { + return new byte[0]; + } +} diff --git a/src/main/java/com/lowagie/text/rtf/field/RtfTOCEntry.java b/src/main/java/com/lowagie/text/rtf/field/RtfTOCEntry.java new file mode 100644 index 0000000..f65e424 --- /dev/null +++ b/src/main/java/com/lowagie/text/rtf/field/RtfTOCEntry.java @@ -0,0 +1,163 @@ +/* + * $Id: RtfTOCEntry.java,v 1.9 2004/12/25 10:18:11 hallm Exp $ + * $Name: $ + * + * Copyright 2004 by Mark Hall + * Uses code Copyright 2002 + * Steffen.Stundzig@smb-tec.com + * + * The contents of this file are subject to the Mozilla Public License Version 1.1 + * (the "License"); you may not use this file except in compliance with the License. + * You may obtain a copy of the License at http://www.mozilla.org/MPL/ + * + * Software distributed under the License is distributed on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License + * for the specific language governing rights and limitations under the License. + * + * The Original Code is 'iText, a free JAVA-PDF library'. + * + * The Initial Developer of the Original Code is Bruno Lowagie. Portions created by + * the Initial Developer are Copyright (C) 1999, 2000, 2001, 2002 by Bruno Lowagie. + * All Rights Reserved. + * Co-Developer of the code is Paulo Soares. Portions created by the Co-Developer + * are Copyright (C) 2000, 2001, 2002 by Paulo Soares. All Rights Reserved. + * + * Contributor(s): all the names of the contributors are added in the source code + * where applicable. + * + * Alternatively, the contents of this file may be used under the terms of the + * LGPL license (the ?GNU LIBRARY GENERAL PUBLIC LICENSE?), in which case the + * provisions of LGPL are applicable instead of those above. If you wish to + * allow use of your version of this file only under the terms of the LGPL + * License and not to allow others to use your version of this file under + * the MPL, indicate your decision by deleting the provisions above and + * replace them with the notice and other provisions required by the LGPL. + * If you do not delete the provisions above, a recipient may use your version + * of this file under either the MPL or the GNU LIBRARY GENERAL PUBLIC LICENSE. + * + * This library is free software; you can redistribute it and/or modify it + * under the terms of the MPL as stated above or under the terms of the GNU + * Library General Public License as published by the Free Software Foundation; + * either version 2 of the License, or any later version. + * + * This library is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS + * FOR A PARTICULAR PURPOSE. See the GNU Library general Public License for more + * details. + * + * If you didn't download this code from the following link, you should check if + * you aren't using an obsolete version: + * http://www.lowagie.com/iText/ + */ + +package com.lowagie.text.rtf.field; + +import java.io.ByteArrayOutputStream; +import java.io.IOException; + +import com.lowagie.text.Font; + + +/** + * The RtfTOCEntry is used together with the RtfTableOfContents to generate a table of + * contents. Add the RtfTOCEntry in those locations in the document where table of + * contents entries should link to + * + * @version $Version:$ + * @author Mark Hall (mhall@edu.uni-klu.ac.at) + * @author Steffen.Stundzig@smb-tec.com + */ +public class RtfTOCEntry extends RtfField { + + /** + * Constant for the beginning of hidden text + */ + private static final byte[] TEXT_HIDDEN_ON = "\\v".getBytes(); + /** + * Constant for the end of hidden text + */ + private static final byte[] TEXT_HIDDEN_OFF = "\\v0".getBytes(); + /** + * Constant for a TOC entry with page numbers + */ + private static final byte[] TOC_ENTRY_PAGE_NUMBER = "\\tc".getBytes(); + /** + * Constant for a TOC entry without page numbers + */ + private static final byte[] TOC_ENTRY_NO_PAGE_NUMBER = "\\tcn".getBytes(); + + /** + * The entry text of this RtfTOCEntry + */ + private String entry = ""; + /** + * Whether to show page numbers in the table of contents + */ + private boolean showPageNumber = true; + + /** + * Constructs a RtfTOCEntry with a certain entry text. + * + * @param entry The entry text to display + * @param font The Font to use + */ + public RtfTOCEntry(String entry, Font font) { + super(null, font); + if(entry != null) { + this.entry = entry; + } + } + + /** + * Writes the content of the RtfTOCEntry + * + * @return A byte array with the contents of the RtfTOCEntry + */ + public byte[] write() { + ByteArrayOutputStream result = new ByteArrayOutputStream(); + try { + result.write(TEXT_HIDDEN_ON); + result.write(OPEN_GROUP); + if(this.showPageNumber) { + result.write(TOC_ENTRY_PAGE_NUMBER); + } else { + result.write(TOC_ENTRY_NO_PAGE_NUMBER); + } + result.write(DELIMITER); + result.write(this.document.filterSpecialChar(this.entry, true, false).getBytes()); + result.write(CLOSE_GROUP); + result.write(TEXT_HIDDEN_OFF); + } catch(IOException ioe) { + ioe.printStackTrace(); + } + return result.toByteArray(); + } + + /** + * Sets whether to display a page number in the table of contents, or not + * + * @param showPageNumber Whether to display a page number or not + */ + public void setShowPageNumber(boolean showPageNumber) { + this.showPageNumber = showPageNumber; + } + + /** + * UNUSED + * @return null + * @throws IOException never thrown + */ + protected byte[] writeFieldInstContent() throws IOException { + return null; + } + + /** + * UNUSED + * @return null + * @throws IOException never thrown + */ + protected byte[] writeFieldResultContent() throws IOException { + return null; + } + +} diff --git a/src/main/java/com/lowagie/text/rtf/field/RtfTableOfContents.java b/src/main/java/com/lowagie/text/rtf/field/RtfTableOfContents.java new file mode 100644 index 0000000..b6738c1 --- /dev/null +++ b/src/main/java/com/lowagie/text/rtf/field/RtfTableOfContents.java @@ -0,0 +1,109 @@ +/* + * $Id: RtfTableOfContents.java,v 1.8 2004/12/14 12:51:54 blowagie Exp $ + * $Name: $ + * + * Copyright 2004 by Mark Hall + * Uses code Copyright 2002 + * Steffen.Stundzig@smb-tec.com + * + * The contents of this file are subject to the Mozilla Public License Version 1.1 + * (the "License"); you may not use this file except in compliance with the License. + * You may obtain a copy of the License at http://www.mozilla.org/MPL/ + * + * Software distributed under the License is distributed on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License + * for the specific language governing rights and limitations under the License. + * + * The Original Code is 'iText, a free JAVA-PDF library'. + * + * The Initial Developer of the Original Code is Bruno Lowagie. Portions created by + * the Initial Developer are Copyright (C) 1999, 2000, 2001, 2002 by Bruno Lowagie. + * All Rights Reserved. + * Co-Developer of the code is Paulo Soares. Portions created by the Co-Developer + * are Copyright (C) 2000, 2001, 2002 by Paulo Soares. All Rights Reserved. + * + * Contributor(s): all the names of the contributors are added in the source code + * where applicable. + * + * Alternatively, the contents of this file may be used under the terms of the + * LGPL license (the ?GNU LIBRARY GENERAL PUBLIC LICENSE?), in which case the + * provisions of LGPL are applicable instead of those above. If you wish to + * allow use of your version of this file only under the terms of the LGPL + * License and not to allow others to use your version of this file under + * the MPL, indicate your decision by deleting the provisions above and + * replace them with the notice and other provisions required by the LGPL. + * If you do not delete the provisions above, a recipient may use your version + * of this file under either the MPL or the GNU LIBRARY GENERAL PUBLIC LICENSE. + * + * This library is free software; you can redistribute it and/or modify it + * under the terms of the MPL as stated above or under the terms of the GNU + * Library General Public License as published by the Free Software Foundation; + * either version 2 of the License, or any later version. + * + * This library is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS + * FOR A PARTICULAR PURPOSE. See the GNU Library general Public License for more + * details. + * + * If you didn't download this code from the following link, you should check if + * you aren't using an obsolete version: + * http://www.lowagie.com/iText/ + */ + +package com.lowagie.text.rtf.field; + +import java.io.IOException; + +import com.lowagie.text.Font; + + + +/** + * The RtfTableOfContents together with multiple RtfTOCEntry objects generates a table + * of contents. The table of contents will display no entries in the viewing program + * and the user will have to update it first. A text to inform the user of this is + * displayed instead. + * + * @version $Version:$ + * @author Mark Hall (mhall@edu.uni-klu.ac.at) + * @author Steffen.Stundzig@smb-tec.com + */ +public class RtfTableOfContents extends RtfField { + + /** + * The default text to display + */ + private String defaultText = "Table of Contents - Click to update"; + + /** + * Constructs a RtfTableOfContents. The default text is the text that is displayed + * before the user updates the table of contents + * + * @param defaultText The default text to display + * @param font The Font to use + */ + public RtfTableOfContents(String defaultText, Font font) { + super(null, font); + this.defaultText = defaultText; + } + + /** + * Writes the field instruction content + * + * @return A byte array containing with the field instructions + * @throws IOException + */ + protected byte[] writeFieldInstContent() throws IOException { + return "TOC \\\\f \\\\h \\\\u \\\\o \"1-5\" ".getBytes(); + } + + /** + * Writes the field result content + * + * @return An byte array containing the default text + * @throws IOException + */ + protected byte[] writeFieldResultContent() throws IOException { + return defaultText.getBytes(); + } +} diff --git a/src/main/java/com/lowagie/text/rtf/field/RtfTotalPageNumber.java b/src/main/java/com/lowagie/text/rtf/field/RtfTotalPageNumber.java new file mode 100644 index 0000000..a776fd6 --- /dev/null +++ b/src/main/java/com/lowagie/text/rtf/field/RtfTotalPageNumber.java @@ -0,0 +1,128 @@ +/* + * $Id: RtfTotalPageNumber.java,v 1.3 2005/05/13 12:09:14 hallm Exp $ + * $Name: $ + * + * Copyright 2005 Jose Hurtado jose.hurtado@gft.com + * Parts Copyright 2005 Mark Hall + * + * The contents of this file are subject to the Mozilla Public License Version 1.1 + * (the "License"); you may not use this file except in compliance with the License. + * You may obtain a copy of the License at http://www.mozilla.org/MPL/ + * + * Software distributed under the License is distributed on an "AS IS" basis, + * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License + * for the specific language governing rights and limitations under the License. + * + * The Original Code is 'iText, a free JAVA-PDF library'. + * + * The Initial Developer of the Original Code is Bruno Lowagie. Portions created by + * the Initial Developer are Copyright (C) 1999, 2000, 2001, 2002 by Bruno Lowagie. + * All Rights Reserved. + * Co-Developer of the code is Paulo Soares. Portions created by the Co-Developer + * are Copyright (C) 2000, 2001, 2002 by Paulo Soares. All Rights Reserved. + * + * Contributor(s): all the names of the contributors are added in the source code + * where applicable. + * + * Alternatively, the contents of this file may be used under the terms of the + * LGPL license (the ?GNU LIBRARY GENERAL PUBLIC LICENSE?), in which case the + * provisions of LGPL are applicable instead of those above. If you wish to + * allow use of your version of this file only under the terms of the LGPL + * License and not to allow others to use your version of this file under + * the MPL, indicate your decision by deleting the provisions above and + * replace them with the notice and other provisions required by the LGPL. + * If you do not delete the provisions above, a recipient may use your version + * of this file under either the MPL or the GNU LIBRARY GENERAL PUBLIC LICENSE. + * + * This library is free software; you can redistribute it and/or modify it + * under the terms of the MPL as stated above or under the terms of the GNU + * Library General Public License as published by the Free Software Foundation; + * either version 2 of the License, or any later version. + * + * This library is distributed in the hope that it will be useful, but WITHOUT + * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS + * FOR A PARTICULAR PURPOSE. See the GNU Library general Public License for more + * details. + * + * If you didn't download this code from the following link, you should check if + * you aren't using an obsolete version: + * http://www.lowagie.com/iText/ + */ + +package com.lowagie.text.rtf.field; + +import java.io.IOException; + +import com.lowagie.text.Font; +import com.lowagie.text.rtf.document.RtfDocument; +import com.lowagie.text.rtf.field.RtfField; + +/** + * The RtfTotalPageNumber provides the total number of pages field in rtf documents. + * + * @version $Version:$ + * @author Jose Hurtado (jose.hurtado@gft.com) + * @author Mark Hall (mhall@edu.uni-klu.ac.at) + */ +public class RtfTotalPageNumber extends RtfField { + + /** + * Constant for arabic total page numbers. + */ + private static final byte[] ARABIC_TOTAL_PAGES = "NUMPAGES \\\\* Arabic".getBytes(); + + /** + * Constructs a RtfTotalPageNumber. This can be added anywhere to add a total number of pages field. + */ + public RtfTotalPageNumber() { + super(null); + } + + /** + * Constructs a RtfTotalPageNumber with a specified Font. This can be added anywhere + * to add a total number of pages field. + * @param font + */ + public RtfTotalPageNumber(Font font) { + super(null, font); + } + + /** + * Constructs a RtfTotalPageNumber object. + * + * @param doc The RtfDocument this RtfTotalPageNumber belongs to + */ + public RtfTotalPageNumber(RtfDocument doc) { + super(doc); + } + + /** + * Constructs a RtfTotalPageNumber object with a specific font. + * + * @param doc The RtfDocument this RtfTotalPageNumber belongs to + * @param font The Font to use + */ + public RtfTotalPageNumber(RtfDocument doc, Font font) { + super(doc, font); + } + + /** + * Writes the field NUMPAGES instruction with Arabic format + * + * @return A byte array containing "NUMPAGES \\\\* Arabic". + * @throws IOException + */ + protected byte[] writeFieldInstContent() throws IOException { + return ARABIC_TOTAL_PAGES; + } + + /** + * Writes the field result content + * + * @return An byte array containing "1". + * @throws IOException + */ + protected byte[] writeFieldResultContent() throws IOException { + return "1".getBytes(); + } +} -- cgit v1.2.3