1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336
|
/*
* $Id: PdfObject.java,v 1.26 2002/07/09 11:28:23 blowagie Exp $
* $Name: $
*
* Copyright 1999, 2000, 2001, 2002 Bruno Lowagie
*
* 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.pdf;
import java.io.OutputStream;
import java.io.IOException;
/**
* <CODE>PdfObject</CODE> is the abstract superclass of all PDF objects.
* <P>
* PDF supports seven basic types of objects: Booleans, numbers, strings, names,
* arrays, dictionaries and streams. In addition, PDF provides a null object.
* Objects may be labeled so that they can be referred to by other objects.<BR>
* All these basic PDF objects are described in the 'Portable Document Format
* Reference Manual version 1.3' Chapter 4 (pages 37-54).
*
* @see PdfNull
* @see PdfBoolean
* @see PdfNumber
* @see PdfString
* @see PdfName
* @see PdfArray
* @see PdfDictionary
* @see PdfStream
* @see PdfIndirectReference
*/
public abstract class PdfObject {
// static membervariables (all the possible types of a PdfObject)
/** a possible type of <CODE>PdfObject</CODE> */
public static final int BOOLEAN = 1;
/** a possible type of <CODE>PdfObject</CODE> */
public static final int NUMBER = 2;
/** a possible type of <CODE>PdfObject</CODE> */
public static final int STRING = 3;
/** a possible type of <CODE>PdfObject</CODE> */
public static final int NAME = 4;
/** a possible type of <CODE>PdfObject</CODE> */
public static final int ARRAY = 5;
/** a possible type of <CODE>PdfObject</CODE> */
public static final int DICTIONARY = 6;
/** a possible type of <CODE>PdfObject</CODE> */
public static final int STREAM = 7;
/** a possible type of <CODE>PdfObject</CODE> */
//public static final int NULL = 8;
// renamed this member to m_NULL to prevent confusion w/ gcj (ssteward)
public static final int m_NULL = 8;
public static final int INDIRECT = 10;
/** This is an empty string used for the <CODE>PdfNull</CODE>-object and for an empty <CODE>PdfString</CODE>-object. */
public static final String NOTHING = "";
/** This is the default encoding to be used for converting Strings into bytes and vice versa.
* The default encoding is PdfDocEncoding.
*/
public static final String TEXT_PDFDOCENCODING = "PDF";
/** This is the encoding to be used to output text in Unicode. */
public static final String TEXT_UNICODE = "UnicodeBig";
// membervariables
/** the content of this <CODE>PdfObject</CODE> */
protected byte[] bytes;
/** the type of this <CODE>PdfObject</CODE> */
protected int type;
// constructors
/**
* Constructs a <CODE>PdfObject</CODE> of a certain <VAR>type</VAR> without any <VAR>content</VAR>.
*
* @param type type of the new <CODE>PdfObject</CODE>
*/
protected PdfObject(int type) {
this.type = type;
}
/**
* Constructs a <CODE>PdfObject</CODE> of a certain <VAR>type</VAR> with a certain <VAR>content</VAR>.
*
* @param type type of the new <CODE>PdfObject</CODE>
* @param content content of the new <CODE>PdfObject</CODE> as a <CODE>String</CODE>.
*/
protected PdfObject(int type, String content) {
this.type = type;
bytes = PdfEncodings.convertToBytes(content, null);
}
/**
* Constructs a <CODE>PdfObject</CODE> of a certain <VAR>type</VAR> with a certain <VAR>content</VAR>.
*
* @param type type of the new <CODE>PdfObject</CODE>
* @param bytes content of the new <CODE>PdfObject</CODE> as an array of <CODE>byte</CODE>.
*/
protected PdfObject(int type, byte[] bytes) {
this.bytes = bytes;
this.type = type;
}
// methods dealing with the content of this object
/**
* Returns the PDF representation of this <CODE>PdfObject</CODE> as an array of <CODE>byte</CODE>s.
*
* @return an array of <CODE>byte</CODE>
*/
// public byte[] toPdf(PdfWriter writer) {
// return bytes;
// }
public void toPdf(PdfWriter writer, OutputStream os) throws IOException {
if (bytes != null)
os.write(bytes);
}
public byte[] getBytes() {
return bytes;
}
/**
* Returns the length of the PDF representation of the <CODE>PdfObject</CODE>.
* <P>
* In some cases, namely for <CODE>PdfString</CODE> and <CODE>PdfStream</CODE>,
* this method differs from the method <CODE>length</CODE> because <CODE>length</CODE>
* returns the length of the actual content of the <CODE>PdfObject</CODE>.</P>
* <P>
* Remark: the actual content of an object is in most cases identical to its representation.
* The following statement is always true: length() >= pdfLength().</P>
*
* @return a length
*/
// public int pdfLength() {
// return toPdf(null).length;
// }
/**
* Returns the <CODE>String</CODE>-representation of this <CODE>PdfObject</CODE>.
*
* @return a <CODE>String</CODE>
*/
public String toString() {
if (bytes == null)
return super.toString();
else
return PdfEncodings.convertToString(bytes, null);
}
/**
* Returns the length of the actual content of the <CODE>PdfObject</CODE>.
* <P>
* In some cases, namely for <CODE>PdfString</CODE> and <CODE>PdfStream</CODE>,
* this method differs from the method <CODE>pdfLength</CODE> because <CODE>pdfLength</CODE>
* returns the length of the PDF representation of the object, not of the actual content
* as does the method <CODE>length</CODE>.</P>
* <P>
* Remark: the actual content of an object is in some cases identical to its representation.
* The following statement is always true: length() >= pdfLength().</P>
*
* @return a length
*/
public int length() {
return toString().length();
}
/**
* Changes the content of this <CODE>PdfObject</CODE>.
*
* @param content the new content of this <CODE>PdfObject</CODE>
*/
protected void setContent(String content) {
bytes = PdfEncodings.convertToBytes(content, null);
}
// methods dealing with the type of this object
/**
* Returns the type of this <CODE>PdfObject</CODE>.
*
* @return a type
*/
public int type() {
return type;
}
/**
* Checks if this <CODE>PdfObject</CODE> is of the type <CODE>PdfNull</CODE>.
*
* @return <CODE>true</CODE> or <CODE>false</CODE>
*/
public boolean isNull() {
return (this.type == m_NULL);
}
/**
* Checks if this <CODE>PdfObject</CODE> is of the type <CODE>PdfBoolean</CODE>.
*
* @return <CODE>true</CODE> or <CODE>false</CODE>
*/
public boolean isBoolean() {
return (this.type == BOOLEAN);
}
/**
* Checks if this <CODE>PdfObject</CODE> is of the type <CODE>PdfNumber</CODE>.
*
* @return <CODE>true</CODE> or <CODE>false</CODE>
*/
public boolean isNumber() {
return (this.type == NUMBER);
}
/**
* Checks if this <CODE>PdfObject</CODE> is of the type <CODE>PdfString</CODE>.
*
* @return <CODE>true</CODE> or <CODE>false</CODE>
*/
public boolean isString() {
return (this.type == STRING);
}
/**
* Checks if this <CODE>PdfObject</CODE> is of the type <CODE>PdfName</CODE>.
*
* @return <CODE>true</CODE> or <CODE>false</CODE>
*/
public boolean isName() {
return (this.type == NAME);
}
/**
* Checks if this <CODE>PdfObject</CODE> is of the type <CODE>PdfArray</CODE>.
*
* @return <CODE>true</CODE> or <CODE>false</CODE>
*/
public boolean isArray() {
return (this.type == ARRAY);
}
/**
* Checks if this <CODE>PdfObject</CODE> is of the type <CODE>PdfDictionary</CODE>.
*
* @return <CODE>true</CODE> or <CODE>false</CODE>
*/
public boolean isDictionary() {
return (this.type == DICTIONARY);
}
/**
* Checks if this <CODE>PdfObject</CODE> is of the type <CODE>PdfStream</CODE>.
*
* @return <CODE>true</CODE> or <CODE>false</CODE>
*/
public boolean isStream() {
return (this.type == STREAM);
}
public boolean isIndirect() {
return (this.type == INDIRECT);
}
}
|