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 PdfObject
* @see BadPdfFormatException
*/
public class PdfString : PdfObject {
// membervariables
/** The value of this object. */
protected string value = NOTHING;
protected string originalValue = null;
/** The encoding. */
protected string encoding = TEXT_PDFDOCENCODING;
protected int objNum = 0;
protected int objGen = 0;
protected bool hexWriting = false;
// constructors
/**
* Constructs an empty PdfString-object.
*/
public PdfString() : base(STRING) {}
/**
* Constructs a PdfString-object.
*
* @param value the content of the string
*/
public PdfString(string value) : base(STRING) {
this.value = value;
}
/**
* Constructs a PdfString-object.
*
* @param value the content of the string
* @param encoding an encoding
*/
public PdfString(string value, string encoding) : base(STRING) {
this.value = value;
this.encoding = encoding;
}
/**
* Constructs a PdfString-object.
*
* @param bytes an array of byte
*/
public PdfString(byte[] bytes) : base(STRING) {
value = PdfEncodings.ConvertToString(bytes, null);
encoding = NOTHING;
}
// methods overriding some methods in PdfObject
/**
* Returns the PDF representation of this PdfString.
*
* @return an array of bytes
*/
public override void ToPdf(PdfWriter writer, Stream os) {
byte[] b = GetBytes();
PdfEncryption crypto = null;
if (writer != null)
crypto = writer.Encryption;
if (crypto != null) {
b = crypto.EncryptByteArray(b);
}
if (hexWriting) {
ByteBuffer buf = new ByteBuffer();
buf.Append('<');
int len = b.Length;
for (int k = 0; k < len; ++k)
buf.AppendHex(b[k]);
buf.Append('>');
os.Write(buf.ToByteArray(), 0, buf.Size);
}
else {
b = PdfContentByte.EscapeString(b);
os.Write(b, 0, b.Length);
}
}
/**
* Returns the string value of the PdfString-object.
*
* @return a string
*/
public override string ToString() {
return value;
}
// other methods
/**
* Gets the encoding of this string.
*
* @return a string
*/
public string Encoding {
get {
return encoding;
}
}
public String ToUnicodeString() {
if (encoding != null && encoding.Length != 0)
return value;
GetBytes();
if (bytes.Length >= 2 && bytes[0] == (byte)254 && bytes[1] == (byte)255)
return PdfEncodings.ConvertToString(bytes, PdfObject.TEXT_UNICODE);
else
return PdfEncodings.ConvertToString(bytes, PdfObject.TEXT_PDFDOCENCODING);
}
internal void SetObjNum(int objNum, int objGen) {
this.objNum = objNum;
this.objGen = objGen;
}
internal void Decrypt(PdfReader reader) {
PdfEncryption decrypt = reader.Decrypt;
if (decrypt != null) {
originalValue = value;
decrypt.SetHashKey(objNum, objGen);
bytes = PdfEncodings.ConvertToBytes(value, null);
bytes = decrypt.DecryptByteArray(bytes);
value = PdfEncodings.ConvertToString(bytes, null);
}
}
public override byte[] GetBytes() {
if (bytes == null) {
if (encoding != null && encoding.Equals(TEXT_UNICODE) && PdfEncodings.IsPdfDocEncoding(value))
bytes = PdfEncodings.ConvertToBytes(value, TEXT_PDFDOCENCODING);
else
bytes = PdfEncodings.ConvertToBytes(value, encoding);
}
return bytes;
}
public byte[] GetOriginalBytes() {
if (originalValue == null)
return GetBytes();
return PdfEncodings.ConvertToBytes(originalValue, null);
}
public PdfString SetHexWriting(bool hexWriting) {
this.hexWriting = hexWriting;
return this;
}
public bool IsHexWriting() {
return hexWriting;
}
}
}