com.lowagie.text.pdf

Class PdfString

public class PdfString extends PdfObject

A PdfString-class is the PDF-equivalent of a JAVA-String-object.

A string is a sequence of characters delimited by parenthesis. If a string is too long to be conveniently placed on a single line, it may be split across multiple lines by using the backslash character (\) at the end of a line to indicate that the string continues on the following line. Within a string, the backslash character is used as an escape to specify unbalanced parenthesis, non-printing ASCII characters, and the backslash character itself. Use of the \ddd escape sequence is the preferred way to represent characters outside the printable ASCII character set.
This object is described in the 'Portable Document Format Reference Manual version 1.7' section 3.2.3 (page 53-56).

See Also: PdfObject BadPdfFormatException

Field Summary
protected Stringencoding
The encoding.
protected booleanhexWriting
protected intobjGen
protected intobjNum
protected StringoriginalValue
protected Stringvalue
The value of this object.
Constructor Summary
PdfString()
Constructs an empty PdfString-object.
PdfString(String value)
Constructs a PdfString-object containing a string in the standard encoding TEXT_PDFDOCENCODING.
PdfString(String value, String encoding)
Constructs a PdfString-object containing a string in the specified encoding.
PdfString(byte[] bytes)
Constructs a PdfString-object.
Method Summary
voiddecrypt(PdfReader reader)
Decrypt an encrypted PdfString
byte[]getBytes()
StringgetEncoding()
Gets the encoding of this string.
byte[]getOriginalBytes()
booleanisHexWriting()
PdfStringsetHexWriting(boolean hexWriting)
voidsetObjNum(int objNum, int objGen)
voidtoPdf(PdfWriter writer, OutputStream os)
Writes the PDF representation of this PdfString as an array of byte to the specified OutputStream.
StringtoString()
Returns the String value of this PdfString-object.
StringtoUnicodeString()
Returns the Unicode String value of this PdfString-object.

Field Detail

encoding

protected String encoding
The encoding.

hexWriting

protected boolean hexWriting

objGen

protected int objGen

objNum

protected int objNum

originalValue

protected String originalValue

value

protected String value
The value of this object.

Constructor Detail

PdfString

public PdfString()
Constructs an empty PdfString-object.

PdfString

public PdfString(String value)
Constructs a PdfString-object containing a string in the standard encoding TEXT_PDFDOCENCODING.

Parameters: value the content of the string

PdfString

public PdfString(String value, String encoding)
Constructs a PdfString-object containing a string in the specified encoding.

Parameters: value the content of the string encoding an encoding

PdfString

public PdfString(byte[] bytes)
Constructs a PdfString-object.

Parameters: bytes an array of byte

Method Detail

decrypt

void decrypt(PdfReader reader)
Decrypt an encrypted PdfString

getBytes

public byte[] getBytes()

getEncoding

public String getEncoding()
Gets the encoding of this string.

Returns: a String

getOriginalBytes

public byte[] getOriginalBytes()

isHexWriting

public boolean isHexWriting()

setHexWriting

public PdfString setHexWriting(boolean hexWriting)

setObjNum

void setObjNum(int objNum, int objGen)

toPdf

public void toPdf(PdfWriter writer, OutputStream os)
Writes the PDF representation of this PdfString as an array of byte to the specified OutputStream.

Parameters: writer for backwards compatibility os The OutputStream to write the bytes to.

toString

public String toString()
Returns the String value of this PdfString-object.

Returns: A String

toUnicodeString

public String toUnicodeString()
Returns the Unicode String value of this PdfString-object.

Returns: A String