Class SetaPDF_Core_Document_OptionalContent_Group in SetaPDF v2 API Reference

Index

\SetaPDF
1. Core
2. Core
  1. Document
  2. Document
    1. OptionalContent
      1. Group
      2. Group
        Usage

SetaPDF_Core_Document_OptionalContent_Group An optional content group

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

Class hierarchy

SetaPDF_Core_Document_OptionalContent_Group

Implements

SetaPDF_Core_Resource

Summary

Constants

TYPE_COLOR_SPACE

public const string SetaPDF_Core_Resource::TYPE_COLOR_SPACE = 'ColorSpace'

Type constant

TYPE_EXT_G_STATE

public const string SetaPDF_Core_Resource::TYPE_EXT_G_STATE = 'ExtGState'

Type constant

TYPE_FONT

public const string SetaPDF_Core_Resource::TYPE_FONT = 'Font'

Type constant

TYPE_PATTERN

public const string SetaPDF_Core_Resource::TYPE_PATTERN = 'Pattern'

Type constant

TYPE_PROC_SET

public const string SetaPDF_Core_Resource::TYPE_PROC_SET = 'ProcSet'

Type constant

TYPE_PROPERTIES

public const string SetaPDF_Core_Resource::TYPE_PROPERTIES = 'Properties'

Type constant

TYPE_SHADING

public const string SetaPDF_Core_Resource::TYPE_SHADING = 'Shading'

Type constant

TYPE_X_OBJECT

public const string SetaPDF_Core_Resource::TYPE_X_OBJECT = 'XObject'

Type constant

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

__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

Throws SetaPDF_Core_Type_Exception

See

SetaPDF_Core_Document_OptionalContent_Group::createOCGDictionary()

cleanUp()

public SetaPDF_Core_Document_OptionalContent_Group::cleanUp (

void

): void

Release memory / cycled references.

getDictionary()

public SetaPDF_Core_Document_OptionalContent_Group::getDictionary (

void

): SetaPDF_Core_Type_Dictionary

Get the dictionary of the optional content group.

getIndirectObject()

public SetaPDF_Core_Document_OptionalContent_Group::getIndirectObject (

[ SetaPDF_Core_Document $document = null ]

): SetaPDF_Core_Type_IndirectObjectInterface

Get an indirect object for this optional content group.

Parameters

$document : SetaPDF_Core_Document

Exceptions

Throws InvalidArgumentException

See

SetaPDF_Core_Resource::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

Exceptions

Throws SetaPDF_Core_Type_Exception

getResourceType()

public SetaPDF_Core_Document_OptionalContent_Group::getResourceType (

void

): string

Get the resource type for optional content groups.

See

SetaPDF_Core_Resource::getResourceType()

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

Exceptions

Throws SetaPDF_Core_Type_Exception

usage()

public SetaPDF_Core_Document_OptionalContent_Group::usage (

void

): SetaPDF_Core_Document_OptionalContent_Group_Usage

Gets the usage helper class.