SetaPDF_Core_Document_OptionalContent_Group An optional content group

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

Class hierarchy

Implements

Summary

Constants

TYPE_COLOR_SPACE

const SetaPDF_Core_Document_OptionalContent_Group::TYPE_COLOR_SPACE = 'ColorSpace'

TYPE_EXT_G_STATE

const SetaPDF_Core_Document_OptionalContent_Group::TYPE_EXT_G_STATE = 'ExtGState'

TYPE_FONT

const SetaPDF_Core_Document_OptionalContent_Group::TYPE_FONT = 'Font'

TYPE_PATTERN

const SetaPDF_Core_Document_OptionalContent_Group::TYPE_PATTERN = 'Pattern'

TYPE_PROC_SET

const SetaPDF_Core_Document_OptionalContent_Group::TYPE_PROC_SET = 'ProcSet'

TYPE_PROPERTIES

const SetaPDF_Core_Document_OptionalContent_Group::TYPE_PROPERTIES = 'Properties'

TYPE_SHADING

const SetaPDF_Core_Document_OptionalContent_Group::TYPE_SHADING = 'Shading'

TYPE_X_OBJECT

const SetaPDF_Core_Document_OptionalContent_Group::TYPE_X_OBJECT = 'XObject'


Properties

$_dictionary

protected SetaPDF_Core_Type_Dictionary SetaPDF_Core_Document_OptionalContent_Group::$_dictionary

The optional content group dictionary

$_indirectObject

protected SetaPDF_Core_Type_IndirectObjectInterface SetaPDF_Core_Document_OptionalContent_Group::$_indirectObject

The indirect object of this group

$_usage

protected SetaPDF_Core_Document_OptionalContent_Group_Usage SetaPDF_Core_Document_OptionalContent_Group::$_usage

A usage helper class


Static Methods

createOCGDictionary()

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

Creates an optional content group dictionary.

Parameters
$name : string
 
$encoding : string
 

Methods

cleanUp()

Release memory / cycled references.

getDictionary()

Get the dictionary of the optional content group.

getIndirectObject()

getName()

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

Get the name of the optional content group.

Parameters
$encoding : string
 

getResourceType()

Get the resource type for optional content groups.

See

setName()

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

Set the name of the optional content group.

Parameters
$name : string
 
$encoding : string