Zend Framework  1.12
Public Member Functions | Protected Attributes | List of all members
Zend_Pdf_Outline_Loaded Class Reference

Public Member Functions

 getTitle ()
 Get outline title.
 
 setTitle ($title)
 Set outline title.
 
 setIsOpen ($isOpen)
 Sets 'isOpen' outline flag.
 
 isItalic ()
 Returns true if outline item is displayed in italic.
 
 setIsItalic ($isItalic)
 Sets 'isItalic' outline flag.
 
 isBold ()
 Returns true if outline item is displayed in bold.
 
 setIsBold ($isBold)
 Sets 'isBold' outline flag.
 
 getColor ()
 Get outline text color.
 
 setColor (Zend_Pdf_Color_Rgb $color)
 Set outline text color.
 
 getTarget ()
 Get outline target.
 
 setTarget ($target=null)
 Set outline target.
 
 setOptions (array $options)
 Set outline options.
 
 __construct (Zend_Pdf_Element $dictionary, SplObjectStorage $processedDictionaries=null)
 Create PDF outline object using specified dictionary.
 
 dumpOutline (Zend_Pdf_ElementFactory_Interface $factory, $updateNavigation, Zend_Pdf_Element $parent, Zend_Pdf_Element $prev=null, SplObjectStorage $processedOutlines=null)
 Dump Outline and its child outlines into PDF structures.
 
 dump ($level=0)
 
- Public Member Functions inherited from Zend_Pdf_Outline
 getTitle ()
 Get outline title.
 
 setTitle ($title)
 Set outline title.
 
 isOpen ()
 Returns true if outline item is open by default.
 
 setIsOpen ($isOpen)
 Sets 'isOpen' outline flag.
 
 isItalic ()
 Returns true if outline item is displayed in italic.
 
 setIsItalic ($isItalic)
 Sets 'isItalic' outline flag.
 
 isBold ()
 Returns true if outline item is displayed in bold.
 
 setIsBold ($isBold)
 Sets 'isBold' outline flag.
 
 getColor ()
 Get outline text color.
 
 setColor (Zend_Pdf_Color_Rgb $color)
 Set outline text color.
 
 getTarget ()
 Get outline target.
 
 setTarget ($target=null)
 Set outline target.
 
 getOptions ()
 Get outline options.
 
 setOptions (array $options)
 Set outline options.
 
 openOutlinesCount ()
 Returns number of the total number of open items at all levels of the outline.
 
 dumpOutline (Zend_Pdf_ElementFactory_Interface $factory, $updateNavigation, Zend_Pdf_Element $parent, Zend_Pdf_Element $prev=null, SplObjectStorage $processedOutlines=null)
 Dump Outline and its child outlines into PDF structures.
 
 current ()
 Returns the child outline.
 
 key ()
 Returns current iterator key.
 
 next ()
 Go to next child.
 
 rewind ()
 Rewind children.
 
 valid ()
 Check if current position is valid.
 
 getChildren ()
 Returns the child outline.
 
 hasChildren ()
 Implements RecursiveIterator interface.
 
 count ()
 count()
 

Protected Attributes

 $_outlineDictionary
 
 $_originalChildOutlines = array()
 
- Protected Attributes inherited from Zend_Pdf_Outline
 $_open = false
 

Additional Inherited Members

- Static Public Member Functions inherited from Zend_Pdf_Outline
static create ($param1, $param2=null)
 Create new Outline object.
 
- Public Attributes inherited from Zend_Pdf_Outline
 $childOutlines = array()
 

Constructor & Destructor Documentation

__construct ( Zend_Pdf_Element  $dictionary,
SplObjectStorage  $processedDictionaries = null 
)

Create PDF outline object using specified dictionary.

Member Function Documentation

dump (   $level = 0)
dumpOutline ( Zend_Pdf_ElementFactory_Interface  $factory,
  $updateNavigation,
Zend_Pdf_Element  $parent,
Zend_Pdf_Element  $prev = null,
SplObjectStorage  $processedOutlines = null 
)

Dump Outline and its child outlines into PDF structures.

Returns dictionary indirect object or reference

getColor ( )

Get outline text color.

Returns
Zend_Pdf_Color_Rgb
getTarget ( )

Get outline target.

Returns
Zend_Pdf_Target
Exceptions
Zend_Pdf_Exception
getTitle ( )

Get outline title.

Returns
string
Exceptions
Zend_Pdf_Exception
isBold ( )

Returns true if outline item is displayed in bold.

Returns
boolean
isItalic ( )

Returns true if outline item is displayed in italic.

Returns
boolean
setColor ( Zend_Pdf_Color_Rgb  $color)

Set outline text color.

(null means default color which is black)

Parameters
Zend_Pdf_Color_Rgb$color
Returns
Zend_Pdf_Outline
setIsBold (   $isBold)

Sets 'isBold' outline flag.

Parameters
boolean$isBold
Returns
Zend_Pdf_Outline
setIsItalic (   $isItalic)

Sets 'isItalic' outline flag.

Parameters
boolean$isItalic
Returns
Zend_Pdf_Outline
setIsOpen (   $isOpen)

Sets 'isOpen' outline flag.

Parameters
boolean$isOpen
Returns
Zend_Pdf_Outline
setOptions ( array  $options)

Set outline options.

Parameters
array$options
Returns
Zend_Pdf_Actions_Traceable
Exceptions
Zend_Pdf_Exception
setTarget (   $target = null)

Set outline target.

Null means no target

Parameters
Zend_Pdf_Target | string$target
Returns
Zend_Pdf_Outline
Exceptions
Zend_Pdf_Exception
setTitle (   $title)

Set outline title.

Parameters
string$title
Returns
Zend_Pdf_Outline

Member Data Documentation

$_originalChildOutlines = array()
protected
$_outlineDictionary
protected