com.lowagie.text.pdf
public class PdfString extends PdfObject
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 String | encoding The encoding. |
protected boolean | hexWriting |
protected int | objGen |
protected int | objNum |
protected String | originalValue |
protected String | value 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 | |
---|---|
void | decrypt(PdfReader reader)
Decrypt an encrypted PdfString |
byte[] | getBytes() |
String | getEncoding()
Gets the encoding of this string.
|
byte[] | getOriginalBytes() |
boolean | isHexWriting() |
PdfString | setHexWriting(boolean hexWriting) |
void | setObjNum(int objNum, int objGen) |
void | toPdf(PdfWriter writer, OutputStream os)
Writes the PDF representation of this PdfString as an array
of byte to the specified OutputStream .
|
String | toString()
Returns the String value of this PdfString -object.
|
String | toUnicodeString()
Returns the Unicode String value of this
PdfString -object.
|
PdfString
-object.PdfString
-object containing a string in the
standard encoding TEXT_PDFDOCENCODING
.
Parameters: value the content of the string
PdfString
-object containing a string in the
specified encoding.
Parameters: value the content of the string encoding an encoding
PdfString
-object.
Parameters: bytes an array of byte
PdfString
Returns: a String
PdfString
as an array
of byte
to the specified OutputStream
.
Parameters: writer for backwards compatibility os The OutputStream
to write the bytes to.
String
value of this PdfString
-object.
Returns: A String
String
value of this
PdfString
-object.
Returns: A String