org.purepdf.pdf.PdfLayer

	Property	Defined By
		children : Vector.<IPdfOCG> [read-only]	PdfLayer
		name : String [write-only] Set the name of this layer	PdfLayer
		onPanel : Boolean Sets the visibility of the layer in Acrobat's layer panel.	PdfLayer
		parent : PdfLayer [read-only]	PdfLayer
		pdfObject : PdfObject [read-only] Get the dictionary representing the layer.	PdfLayer
		ref : PdfIndirectReference	PdfLayer
		size : int [read-only]	PdfDictionary
		title : String [read-only]	PdfLayer
		visible : Boolean The the layer visibility	PdfLayer

	Property	Defined By
		bytes : Bytes	PdfObject
		_children : Vector.<IPdfOCG>	PdfLayer
		dictionaryType : PdfName	PdfDictionary
		hashMap : HashMap	PdfDictionary
		indRef : PRIndirectReference	PdfObject
		_parent : PdfLayer	PdfLayer
		_ref : PdfIndirectReference	PdfLayer
		_title : String	PdfLayer
		type : int	PdfObject

Public Methods

	Method		Defined By
		PdfLayer($name:String = null, writer:PdfWriter = null) Create a new layer.	PdfLayer
		addChild(child:PdfLayer):void Adds a new child to the children list	PdfLayer
		canBeInObjStm():Boolean Whether this object can be contained in an object stream.	PdfObject
		contains(key:PdfName):Boolean	PdfDictionary
		createTitle(title:String, writer:PdfWriter):PdfLayer [static] Creates a titled layer.	PdfLayer
		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
		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
		setCreatorInfo(creator:String, subtype:String):void	PdfLayer
		setExport(export:Boolean):void Specifies the recommended state for content in this group when the document is saved by a viewer application to a format that does not support optional content	PdfLayer
		setIndRef(indRef:PRIndirectReference):void Set the indirect reference	PdfObject
		setLanguage(language:String, preferred:Boolean):void Specifies the language of the content controlled by this optional content group	PdfLayer
		setPrint(subtype:String, printstate:Boolean):void Specifies that the content in this group is intended for use in printing	PdfLayer
		setView(view:Boolean):void Indicates that the group should be set to that state when the document is opened in a viewer application.	PdfLayer
		setZoom(min:Number, max:Number):void Specifies a range of magnifications at which the content in this optional content group is best viewed.	PdfLayer
		toPdf(writer:PdfWriter, os:IOutputStream):void [override]	PdfDictionary
		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

_children

property

protected var _children:Vector.<IPdfOCG>

_parent

property

protected var _parent:PdfLayer

_ref

property

protected var _ref:PdfIndirectReference

_title

property

protected var _title:String

children

property

children:Vector.<IPdfOCG> [read-only]

Implementation
public function get children():Vector.<IPdfOCG>

name

property

name:String [write-only]

Set the name of this layer

Implementation
public function set name(value:String):void

onPanel

property

onPanel:Boolean

Sets the visibility of the layer in Acrobat's layer panel. If false the layer can not be manipulated by users

Implementation
public function get onPanel():Boolean
public function set onPanel(value:Boolean):void

parent

property

parent:PdfLayer [read-only]

Implementation
public function get parent():PdfLayer

pdfObject

property

pdfObject:PdfObject [read-only]

Get the dictionary representing the layer.

Implementation
public function get pdfObject():PdfObject

ref

property

ref:PdfIndirectReference

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

title

property

title:String [read-only]

Implementation
public function get title():String

visible

property

visible:Boolean

The the layer visibility

Implementation
public function get visible():Boolean
public function set visible(value:Boolean):void

Constructor Detail

PdfLayer

()

Constructor

public function PdfLayer($name:String = null, writer:PdfWriter = null)

Create a new layer. If only name is passed then a new title layer will be created

Parameters

	`$name:String` (default = `null`)

	`writer:PdfWriter` (default = `null`)

Method Detail

addChild

()

method

public function addChild(child:PdfLayer):void

Adds a new child to the children list

Parameters

child:PdfLayer

Throws

Error

createTitle

()

method

public static function createTitle(title:String, writer:PdfWriter):PdfLayer

Creates a titled layer. A title layer is not really a layer but a collection of layers under the same title heading

Parameters

	`title:String`

	`writer:PdfWriter`

Returns

PdfLayer

Throws

ArgumentError

setCreatorInfo

()

method

public function setCreatorInfo(creator:String, subtype:String):void

Parameters

	`creator:String` — a text string specifying the application that created the group

	`subtype:String` — a string defining the type of content controlled by the group

setExport

()

method

public function setExport(export:Boolean):void

Specifies the recommended state for content in this group when the document is saved by a viewer application to a format that does not support optional content

Parameters

export:Boolean

setLanguage

()

method

public function setLanguage(language:String, preferred:Boolean):void

Specifies the language of the content controlled by this optional content group

Parameters

	`language:String`

	`preferred:Boolean`

setPrint

()

method

public function setPrint(subtype:String, printstate:Boolean):void

Specifies that the content in this group is intended for use in printing

Parameters

	`subtype:String`

	`printstate:Boolean`

setView

()

method

public function setView(view:Boolean):void

Indicates that the group should be set to that state when the document is opened in a viewer application.

Parameters

view:Boolean

setZoom

()

method

public function setZoom(min:Number, max:Number):void

Specifies a range of magnifications at which the content in this optional content group is best viewed.

Parameters

	`min:Number`

	`max:Number`

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

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

Package	org.purepdf.pdf
Class	public class PdfLayer
Inheritance	PdfLayer PdfDictionary PdfObject it.sephiroth.utils.ObjectHash
Implements	IPdfOCG