| Package | org.purepdf.pdf |
| Class | public class PdfString |
| Inheritance | PdfString  PdfObject it.sephiroth.utils.ObjectHash |
| Property | Defined By | ||
|---|---|---|---|
 | bytes : Bytes | PdfObject | |
| encoding : String = PDF | PdfString | ||
| hexWriting : Boolean | PdfString | ||
| indRef : PRIndirectReference | PdfObject | |
| objGen : int | PdfString | ||
| objNum : int = 0 | PdfString | ||
| originalValue : String = null | PdfString | ||
| type : int | PdfObject | |
| value : String | PdfString | ||
| Method | Defined By | ||
|---|---|---|---|
PdfString($value:*, $encoding:String)
Create a new PdfString
| PdfString | ||
| canBeInObjStm():Boolean
Whether this object can be contained in an object stream. | PdfObject | |
Decrypt an encrypted PdfString
| PdfString | ||
| dispose():void | PdfObject | |
[override] | PdfString | ||
| PdfObject | ||
| getType():int | PdfObject | |
| isArray():Boolean | PdfObject | |
| isBoolean():Boolean | PdfObject | |
| isDictionary():Boolean | PdfObject | |
isHexWriting():Boolean | PdfString | ||
| isIndirect():Boolean | PdfObject | |
| isName():Boolean | PdfObject | |
| isNull():Boolean | PdfObject | |
| isNumber():Boolean | PdfObject | |
| isStream():Boolean
Checks if this PdfObject is of the type PdfStream
| PdfObject | |
| isString():Boolean | PdfObject | |
setEncoding(enc:String):void | PdfString | ||
setHexWriting(hexWriting:Boolean):PdfString | PdfString | ||
| setIndRef(indRef:PRIndirectReference):void
Set the indirect reference
| PdfObject | |
setObjNum(objNum:int, objGen:int):void | PdfString | ||
[override] | PdfString | ||
toString():String [override] | PdfString | ||
toUnicodeString():String
Returns the Unicode String value of this
| PdfString | ||
| encoding | property |
Hide Inherited Protected Properties
Show Inherited Protected Propertiesprotected var encoding:String = PDF| hexWriting | property |
protected var hexWriting:Boolean| objGen | property |
protected var objGen:int| objNum | property |
protected var objNum:int = 0| originalValue | property |
protected var originalValue:String = null| value | property |
protected var value:String| PdfString | () | Constructor |
public function PdfString($value:*, $encoding:String)Create a new PdfString
Parameters$value:* — String or Bytes
| |
$encoding:String (default = NaN) |
| decrypt | () | method |
public function decrypt(reader:PdfReader):voidDecrypt an encrypted PdfString
Parameters
reader:PdfReader |
| getBytes | () | method |
| isHexWriting | () | method |
public function isHexWriting():BooleanReturnsBoolean |
| setEncoding | () | method |
public function setEncoding(enc:String):voidParameters
enc:String |
| setHexWriting | () | method |
public function setHexWriting(hexWriting:Boolean):PdfStringParameters
hexWriting:Boolean |
PdfString |
| setObjNum | () | method |
public function setObjNum(objNum:int, objGen:int):voidParameters
objNum:int | |
objGen:int |
| toPdf | () | method |
override public function toPdf(writer:PdfWriter, os:IOutputStream):voidParameters
writer:PdfWriter | |
os:IOutputStream |
| toString | () | method |
override public function toString():StringReturnsString |
| toUnicodeString | () | method |
public function toUnicodeString():StringReturns the Unicode String value of this
ReturnsString |