Class Usage in namespace setasign\SetaPDF2\Core\Document\OptionalContent\Group in SetaPDF v2 API Reference

Index

\setasign\SetaPDF2
1. Core
  1. Document
  2. Document
    1. OptionalContent
      1. Group
      2. Group
        
        Usage

setasign\SetaPDF2\Core\Document\OptionalContent\Group

Usage A helper class for an optional content group object to manage the usage dictionary

File: /SetaPDF v2/Core/Document/OptionalContent/Group/Usage.php
Old class name (alias): \SetaPDF_Core_Document_OptionalContent_Group_Usage

Class hierarchy

Usage

Summary

Properties

$_group

Properties

$_group

protected \SetaPDF_Core_Document_OptionalContent_Group Usage::$_group

The optional content group object

Methods

__construct()

public Usage::__construct (

\SetaPDF_Core_Document_OptionalContent_Group $group

)

The constructor .

Parameters

$group : \SetaPDF_Core_Document_OptionalContent_Group

_getState()

protected Usage::_getState (

string $name

): string

Get a state by name.

Parameters

$name : string

_setState()

protected Usage::_setState (

string $name,
string $state

): void

Set a state by name.

Parameters

$name : string
$state : string

cleanUp()

public Usage::cleanUp (

void

): void

Release resources / cycled references.

getDictionary()

public Usage::getDictionary (

bool $create = false

): ?\SetaPDF_Core_Type_Dictionary

Gets and/or creates the usage dictionary.

Method is normally only used internally.

Parameters

$create : bool

getExportState()

public Usage::getExportState (

void

): ?string

Get the export state.

See

PDF 32000-1:2008 - 8.11.4.4 Usage and Usage Application Dictionaries

getPrintState()

public Usage::getPrintState (

void

): ?string

Get the print state.

See

PDF 32000-1:2008 - 8.11.4.4 Usage and Usage Application Dictionaries

getViewState()

public Usage::getViewState (

void

): ?string

Get the view state.

See

PDF 32000-1:2008 - 8.11.4.4 Usage and Usage Application Dictionaries

setExportState()

public Usage::setExportState (

string|false $state = \setasign\SetaPDF2\Core\Document\Catalog\OptionalContent ::STATE_ON

): void

Set the export state.

Parameters

$state : string|false

See

PDF 32000-1:2008 - 8.11.4.4 Usage and Usage Application Dictionaries

setPrintState()

public Usage::setPrintState (

string|false $state = \setasign\SetaPDF2\Core\Document\Catalog\OptionalContent ::STATE_ON

): void

Set the print state.

Parameters

$state : string|false

See

PDF 32000-1:2008 - 8.11.4.4 Usage and Usage Application Dictionaries

setViewState()

public Usage::setViewState (

string|false $state = \setasign\SetaPDF2\Core\Document\Catalog\OptionalContent ::STATE_ON

): void

Set the view state.

Parameters

$state : string|false

See

PDF 32000-1:2008 - 8.11.4.4 Usage and Usage Application Dictionaries