Class PdfString
- Direct Known Subclasses:
PdfDate
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:
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionConstructs an emptyPdfString
-object.PdfString
(byte[] bytes) Constructs aPdfString
-object.Constructs aPdfString
-object containing a string in the standard encodingTEXT_PDFDOCENCODING
.Constructs aPdfString
-object containing a string in the specified encoding. -
Method Summary
Modifier and TypeMethodDescription(package private) void
Decrypt an encryptedPdfString
byte[]
getBytes()
Gets the presentation of this object in a byte arrayGets the encoding of this string.byte[]
char[]
return the characters in our value without any translation.boolean
setHexWriting
(boolean hexWriting) (package private) void
setObjNum
(int objNum, int objGen) void
toPdf
(PdfWriter writer, OutputStream os) Writes the PDF representation of thisPdfString
as an array ofbyte
to the specifiedOutputStream
.toString()
Returns theString
value of thisPdfString
-object.Returns the UnicodeString
value of thisPdfString
-object.Methods inherited from class com.lowagie.text.pdf.PdfObject
canBeInObjStm, getIndRef, isArray, isBoolean, isDictionary, isIndirect, isName, isNull, isNumber, isStream, isString, length, setContent, setIndRef, type
-
Field Details
-
value
The value of this object. -
originalValue
-
encoding
The encoding. -
objNum
protected int objNum -
objGen
protected int objGen -
hexWriting
protected boolean hexWriting
-
-
Constructor Details
-
PdfString
public PdfString()Constructs an emptyPdfString
-object. -
PdfString
Constructs aPdfString
-object containing a string in the standard encodingTEXT_PDFDOCENCODING
.- Parameters:
value
- the content of the string
-
PdfString
Constructs aPdfString
-object containing a string in the specified encoding.- Parameters:
value
- the content of the stringencoding
- an encoding
-
PdfString
public PdfString(byte[] bytes) Constructs aPdfString
-object.- Parameters:
bytes
- an array ofbyte
-
-
Method Details
-
toPdf
Writes the PDF representation of thisPdfString
as an array ofbyte
to the specifiedOutputStream
.- Overrides:
toPdf
in classPdfObject
- Parameters:
writer
- for backwards compatibilityos
- TheOutputStream
to write the bytes to.- Throws:
IOException
- on error
-
toString
Returns theString
value of thisPdfString
-object. -
getBytes
public byte[] getBytes()Description copied from class:PdfObject
Gets the presentation of this object in a byte array -
toUnicodeString
Returns the UnicodeString
value of thisPdfString
-object.- Returns:
- A
String
-
getEncoding
Gets the encoding of this string.- Returns:
- a
String
-
setObjNum
void setObjNum(int objNum, int objGen) -
decrypt
Decrypt an encryptedPdfString
-
getOriginalBytes
public byte[] getOriginalBytes()- Returns:
- The original bytes used to create this PDF string, or the bytes of our current value if the original bytes are missing.
-
getOriginalChars
public char[] getOriginalChars()return the characters in our value without any translation. This allows a string to be built that holds 2-byte or one-byte character codes, as needed for processing by fonts when extracting text.Intended for use when no encoding transformations are desired.
- Returns:
- The code points in this font as chars.
-
isHexWriting
public boolean isHexWriting() -
setHexWriting
-