Packageorg.purepdf.pdf
Classpublic class PdfStructureTreeRoot
InheritancePdfStructureTreeRoot Inheritance PdfDictionary Inheritance PdfObject Inheritance it.sephiroth.utils.ObjectHash



Public Properties
 PropertyDefined By
  reference : PdfIndirectReference
[read-only]
PdfStructureTreeRoot
 Inheritedsize : int
[read-only]
PdfDictionary
  writer : PdfWriter
[read-only]
PdfStructureTreeRoot
Protected Properties
 PropertyDefined By
 Inheritedbytes : Bytes
PdfObject
 InheriteddictionaryType : PdfName
PdfDictionary
 InheritedhashMap : HashMap
PdfDictionary
 InheritedindRef : PRIndirectReference
PdfObject
 Inheritedtype : int
PdfObject
Public Methods
 MethodDefined By
  
PdfStructureTreeRoot
  
buildTree():void
PdfStructureTreeRoot
 Inherited
canBeInObjStm():Boolean
Whether this object can be contained in an object stream.
PdfObject
 Inherited
contains(key:PdfName):Boolean
PdfDictionary
 Inherited
dispose():void
PdfObject
 Inherited
Returns a PdfObject as a PdfArray, resolving indirect references.
PdfDictionary
 Inherited
PdfDictionary
 Inherited
Returns a PdfObject as a PdfNumber, resolving indirect references.
PdfDictionary
 Inherited
PdfObject
 Inherited
Returns the PdfObject associated to the specified key, resolving a possible indirect reference to a direct object.
PdfDictionary
 Inherited
PdfObject
 Inherited
getKeys():KeySet
PdfDictionary
 Inherited
getType():int
PdfObject
 Inherited
PdfDictionary
 Inherited
isArray():Boolean
PdfObject
 Inherited
isBoolean():Boolean
PdfObject
 Inherited
isDictionary():Boolean
PdfObject
 Inherited
isIndirect():Boolean
PdfObject
 Inherited
isName():Boolean
PdfObject
 Inherited
isNull():Boolean
PdfObject
 Inherited
isNumber():Boolean
PdfObject
 Inherited
isStream():Boolean
Checks if this PdfObject is of the type PdfStream
PdfObject
 Inherited
isString():Boolean
PdfObject
  
mapRole(used:PdfName, standard:PdfName):void
Maps the user tags to the standard tags.
PdfStructureTreeRoot
 Inherited
merge(other:PdfDictionary):void
PdfDictionary
 Inherited
PdfDictionary
 Inherited
put(key:PdfName, object:PdfObject):void
PdfDictionary
 Inherited
putAll(other:PdfDictionary):void
PdfDictionary
 Inherited
putEx(key:PdfName, value:PdfObject):void
Associates the specified PdfObject as value to the specified PdfName as key in this map.
PdfDictionary
 Inherited
remove(key:PdfName):void
PdfDictionary
 Inherited
Set the indirect reference
PdfObject
  
setPageMark(page:int, struc:PdfIndirectReference):void
PdfStructureTreeRoot
 Inherited
toPdf(writer:PdfWriter, os:IOutputStream):void
[override]
PdfDictionary
 Inherited
toString():String
[override]
PdfDictionary
Protected Methods
 MethodDefined By
 Inherited
setContent(content:String):void
PdfObject
Public Constants
 ConstantDefined By
 InheritedARRAY : int = 5
[static]
PdfObject
 InheritedBOOLEAN : int = 1
[static]
PdfObject
 InheritedCATALOG : PdfName
[static]
PdfDictionary
 InheritedDICTIONARY : int = 6
[static]
PdfObject
 InheritedINDIRECT : int = 10
[static]
PdfObject
 InheritedNAME : int = 4
[static]
PdfObject
 InheritedNOTHING : String
[static]
PdfObject
 InheritedNULL : int = 8
[static]
PdfObject
 InheritedNUMBER : int = 2
[static]
PdfObject
 InheritedOUTLINES : PdfName
[static]
PdfDictionary
 InheritedPAGE : PdfName
[static]
PdfDictionary
 InheritedSTREAM : int = 7
[static]
PdfObject
 InheritedSTRING : int = 3
[static]
PdfObject
 InheritedTEXT_PDFDOCENCODING : String = PDF
[static]
PdfObject
 InheritedTEXT_UNICODE : String = UnicodeBig
[static]
PdfObject
Property Detail
referenceproperty
reference:PdfIndirectReference  [read-only]


Implementation
    public function get reference():PdfIndirectReference
writerproperty 
writer:PdfWriter  [read-only]


Implementation
    public function get writer():PdfWriter
Constructor Detail
PdfStructureTreeRoot()Constructor
public function PdfStructureTreeRoot(writer:PdfWriter)



Parameters
writer:PdfWriter
Method Detail
buildTree()method
public function buildTree():void


Throws
IOError
mapRole()method 
public function mapRole(used:PdfName, standard:PdfName):void

Maps the user tags to the standard tags. The mapping will allow a standard application to make some sense of the tagged document whatever the user tags may be.

Parameters

used:PdfName — the user tag
 
standard:PdfName — the standard tag

setPageMark()method 
public function setPageMark(page:int, struc:PdfIndirectReference):void

Parameters

page:int
 
struc:PdfIndirectReference