SetaPDF_Core_Document_OptionalContent_Group An optional content group

File: /SetaPDF/Core/Document/OptionalContent/Group.php

Class hierarchy

Implements

Summary

Constants

TYPE_COLOR_SPACE

TYPE_EXT_G_STATE

TYPE_FONT

TYPE_PATTERN

TYPE_PROC_SET

TYPE_PROPERTIES

TYPE_SHADING

TYPE_X_OBJECT


Properties

$_dictionary


Static Methods

createOCGDictionary()

static public SetaPDF_Core_Type_Dictionary SetaPDF_Core_Document_OptionalContent_Group::createOCGDictionary ( string $name [, string $encoding = 'UTF-8' ] )

Creates an optional content group dictionary.

Parameters
$name : string
 
$encoding : string
 

Methods

__construct()

public SetaPDF_Core_Document_OptionalContent_Group::__construct ( SetaPDF_Core_Type_IndirectObjectInterface|SetaPDF_Core_Type_Dictionary|string $ocgDictionary )

The constructor.

Parameters
$ocgDictionary : SetaPDF_Core_Type_IndirectObjectInterface|SetaPDF_Core_Type_Dictionary|string
 
Exceptions

Throws InvalidArgumentException

See

cleanUp()

public void SetaPDF_Core_Document_OptionalContent_Group::cleanUp ( void )

Release memory / cycled references.

getDictionary()

public SetaPDF_Core_Type_Dictionary SetaPDF_Core_Document_OptionalContent_Group::getDictionary ( void )

Get the dictionary of the optional content group.

getIndirectObject()

public SetaPDF_Core_Type_IndirectObjectInterface SetaPDF_Core_Document_OptionalContent_Group::getIndirectObject ( [ SetaPDF_Core_Document $document = null ] )

Get an indirect object for this optional content group.

Parameters
$document : SetaPDF_Core_Document
 
Exceptions

Throws InvalidArgumentException

See

getName()

public string SetaPDF_Core_Document_OptionalContent_Group::getName ( [ string $encoding = 'UTF-8' ] )

Get the name of the optional content group.

Parameters
$encoding : string
 

getResourceType()

public string SetaPDF_Core_Document_OptionalContent_Group::getResourceType ( void )

Get the resource type for optional content groups.

See

setName()

public void SetaPDF_Core_Document_OptionalContent_Group::setName ( string $name [, string $encoding = 'UTF-8' ] )

Set the name of the optional content group.

Parameters
$name : string
 
$encoding : string
 

usage()

public SetaPDF_Core_Document_OptionalContent_Group_Usage SetaPDF_Core_Document_OptionalContent_Group::usage ( void )

Gets the usage helper class.