com.lowagie.text.pdf
Class PdfString

java.lang.Object
  |
  +--com.lowagie.text.pdf.PdfObject
        |
        +--com.lowagie.text.pdf.PdfString

Direct Known Subclasses:

PdfDate

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.3' section 4.4 (page 37-39).

See Also:

PdfObject, BadPdfFormatException

Field Summary

protected String	encoding The encoding.
protected String	value The value of this object.

Fields inherited from class com.lowagie.text.pdf.PdfObject

ARRAY, BOOLEAN, bytes, DICTIONARY, INDIRECT, NAME, NOTHING, NULL, NUMBER, STREAM, STRING, TEXT_PDFDOCENCODING, TEXT_UNICODE, type

Constructor Summary

PdfString()
Constructs an empty PdfString-object.

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

PdfString(String value)
Constructs a PdfString-object.

PdfString(String value, String encoding)
Constructs a PdfString-object.

Method Summary

String	getEncoding() Gets the encoding of this string.
void	toPdf(PdfWriter writer, OutputStream os) Returns the PDF representation of this PdfString.
String	toString() Returns the String value of the PdfString-object.
String	toUnicodeString()

Methods inherited from class com.lowagie.text.pdf.PdfObject

getBytes, isArray, isBoolean, isDictionary, isName, isNull, isNumber, isStream, isString, length, setContent, type

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

value

protected String value

The value of this object.

encoding

protected String encoding

The encoding.

Constructor Detail

PdfString

public PdfString()

Constructs an empty PdfString-object.

PdfString

public PdfString(String value)

Constructs a PdfString-object.

Parameters:

value - the content of the string

PdfString

public PdfString(String value,
                 String encoding)

Constructs a PdfString-object.

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

toPdf

public void toPdf(PdfWriter writer,
                  OutputStream os)
           throws IOException

Returns the PDF representation of this PdfString.

Overrides:

toPdf in class PdfObject

Returns:

an array of bytes

IOException

toString

public String toString()

Returns the String value of the PdfString-object.

Overrides:

toString in class PdfObject

Returns:

a String

getEncoding

public String getEncoding()

Gets the encoding of this string.

Returns:

a String

toUnicodeString

public String toUnicodeString()