org.purepdf.pdf.PdfOutline

	Property	Defined By
		color : RGBColor	PdfOutline
		count : int	PdfOutline
		indirectReference : PdfIndirectReference	PdfOutline
		kids : Vector.<PdfOutline>	PdfOutline
		level : int [read-only]	PdfOutline
		open : Boolean [write-only]	PdfOutline
		opened : Boolean [read-only]	PdfOutline
		parent : PdfOutline [read-only]	PdfOutline
		size : int [read-only]	PdfDictionary
		style : int	PdfOutline
		tag : String	PdfOutline
		title : String	PdfOutline
		writer : PdfWriter Constructs a PdfOutline	PdfOutline

	Property	Defined By
		_action : PdfAction	PdfOutline
		bytes : Bytes	PdfObject
		_destination : PdfDestination	PdfOutline
		dictionaryType : PdfName	PdfDictionary
		hashMap : HashMap	PdfDictionary
		indRef : PRIndirectReference	PdfObject
		type : int	PdfObject
		_writer : PdfWriter	PdfOutline

Public Methods

	Method		Defined By
		PdfOutline($writer:PdfWriter)	PdfOutline
		addKid(outline:PdfOutline):void	PdfOutline
		canBeInObjStm():Boolean Whether this object can be contained in an object stream.	PdfObject
		contains(key:PdfName):Boolean	PdfDictionary
		create(parent:PdfOutline, destination:PdfDestination, title:Paragraph, open:Boolean):PdfOutline [static]	PdfOutline
		dispose():void	PdfObject
		getAsArray(key:PdfName):PdfArray Returns a PdfObject as a PdfArray, resolving indirect references.	PdfDictionary
		getAsDict(key:PdfName):PdfDictionary	PdfDictionary
		getAsNumber(key:PdfName):PdfNumber Returns a PdfObject as a PdfNumber, resolving indirect references.	PdfDictionary
		getBytes():Bytes	PdfObject
		getDirectObject(key:PdfName):PdfObject Returns the PdfObject associated to the specified key, resolving a possible indirect reference to a direct object.	PdfDictionary
		getIndRef():PRIndirectReference	PdfObject
		getKeys():KeySet	PdfDictionary
		getType():int	PdfObject
		getValue(key:PdfName):PdfObject	PdfDictionary
		initOutline(parent:PdfOutline, title:String, open:Boolean):void	PdfOutline
		isArray():Boolean	PdfObject
		isBoolean():Boolean	PdfObject
		isDictionary():Boolean	PdfObject
		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
		merge(other:PdfDictionary):void	PdfDictionary
		mergeDifferent(other:PdfDictionary):void	PdfDictionary
		put(key:PdfName, object:PdfObject):void	PdfDictionary
		putAll(other:PdfDictionary):void	PdfDictionary
		putEx(key:PdfName, value:PdfObject):void Associates the specified PdfObject as value to the specified PdfName as key in this map.	PdfDictionary
		remove(key:PdfName):void	PdfDictionary
		setDestinationPage(pageReference:PdfIndirectReference):Boolean	PdfOutline
		setIndRef(indRef:PRIndirectReference):void Set the indirect reference	PdfObject
		toPdf(writer:PdfWriter, os:IOutputStream):void [override]	PdfOutline
		toString():String [override]	PdfDictionary

	Method	Defined By
		setContent(content:String):void	PdfObject

	Constant	Defined By
		ARRAY : int = 5 [static]	PdfObject
		BOOLEAN : int = 1 [static]	PdfObject
		CATALOG : PdfName [static]	PdfDictionary
		DICTIONARY : int = 6 [static]	PdfObject
		INDIRECT : int = 10 [static]	PdfObject
		NAME : int = 4 [static]	PdfObject
		NOTHING : String [static]	PdfObject
		NULL : int = 8 [static]	PdfObject
		NUMBER : int = 2 [static]	PdfObject
		OUTLINES : PdfName [static]	PdfDictionary
		PAGE : PdfName [static]	PdfDictionary
		STREAM : int = 7 [static]	PdfObject
		STRING : int = 3 [static]	PdfObject
		TEXT_PDFDOCENCODING : String = PDF [static]	PdfObject
		TEXT_UNICODE : String = UnicodeBig [static]	PdfObject

Property Detail

_action

property

protected var _action:PdfAction

_destination

property

protected var _destination:PdfDestination

_writer

property

protected var _writer:PdfWriter

color

property

color:RGBColor

Implementation
public function get color():RGBColor
public function set color(value:RGBColor):void

count

property

count:int

Implementation
public function get count():int
public function set count(value:int):void

indirectReference

property

indirectReference:PdfIndirectReference

Implementation
public function get indirectReference():PdfIndirectReference
public function set indirectReference(value:PdfIndirectReference):void

kids

property

kids:Vector.<PdfOutline>

Implementation
public function get kids():Vector.<PdfOutline>
public function set kids(value:Vector.<PdfOutline>):void

level

property

level:int [read-only]

Implementation
public function get level():int

open

property

open:Boolean [write-only]

Implementation
public function set open(value:Boolean):void

opened

property

opened:Boolean [read-only]

Implementation
public function get opened():Boolean

parent

property

parent:PdfOutline [read-only]

Implementation
public function get parent():PdfOutline

style

property

style:int

Implementation
public function get style():int
public function set style(value:int):void

tag

property

tag:String

Implementation
public function get tag():String
public function set tag(value:String):void

title

property

title:String

Implementation
public function get title():String
public function set title(value:String):void

writer

property

writer:PdfWriter

Constructs a PdfOutline

Implementation
public function get writer():PdfWriter
public function set writer(value:PdfWriter):void

Constructor Detail

PdfOutline

()

Constructor

public function PdfOutline($writer:PdfWriter)

Parameters

$writer:PdfWriter

Method Detail

addKid

()

method

public function addKid(outline:PdfOutline):void

Parameters

outline:PdfOutline

create

()

method

public static function create(parent:PdfOutline, destination:PdfDestination, title:Paragraph, open:Boolean):PdfOutline

Parameters

	`parent:PdfOutline`

	`destination:PdfDestination`

	`title:Paragraph`

	`open:Boolean`

Returns

PdfOutline

initOutline

()

method

public function initOutline(parent:PdfOutline, title:String, open:Boolean):void

Parameters

	`parent:PdfOutline`

	`title:String`

	`open:Boolean`

setDestinationPage

()

method

public function setDestinationPage(pageReference:PdfIndirectReference):Boolean

Parameters

pageReference:PdfIndirectReference

Returns

Boolean

toPdf

()

method

override public function toPdf(writer:PdfWriter, os:IOutputStream):void

Parameters

	`writer:PdfWriter`

	`os:IOutputStream`

Thu May 27 2010, 07:51 AM +02:00

API Documentation	All Packages \| All Classes \| Index \| Frames No Frames
PdfOutline	Properties \| Methods \| Constants

Package	org.purepdf.pdf
Class	public class PdfOutline
Inheritance	PdfOutline PdfDictionary PdfObject it.sephiroth.utils.ObjectHash