Class SetaPDF_Core_Document_OptionalContent_Group_Usage 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_Usage A helper class for an optional content group object to manage the usage dictionary

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

Class hierarchy

SetaPDF_Core_Document_OptionalContent_Group_Usage

Summary

Properties

$_group

Properties

$_group

protected SetaPDF_Core_Document_OptionalContent_Group SetaPDF_Core_Document_OptionalContent_Group_Usage::$_group

The optional content group object

Methods

__construct()

public SetaPDF_Core_Document_OptionalContent_Group_Usage::__construct (

SetaPDF_Core_Document_OptionalContent_Group $group

)

The constructor .

Parameters

$group : SetaPDF_Core_Document_OptionalContent_Group

_getState()

protected SetaPDF_Core_Document_OptionalContent_Group_Usage::_getState (

string $name

): string

Get a state by name.

Parameters

$name : string

_setState()

protected SetaPDF_Core_Document_OptionalContent_Group_Usage::_setState (

string $name, string $state

): void

Set a state by name.

Parameters

$name : string
$state : string

cleanUp()

public SetaPDF_Core_Document_OptionalContent_Group_Usage::cleanUp (

void

): void

Release resources / cycled references.

getDictionary()

public SetaPDF_Core_Document_OptionalContent_Group_Usage::getDictionary (

[ boolean $create = false ]

): null|SetaPDF_Core_Type_Dictionary

Gets and/or creates the usage dictionary.

Method is normally only used internally.

Parameters

$create : boolean

getExportState()

public SetaPDF_Core_Document_OptionalContent_Group_Usage::getExportState (

void

): string|null

Get the export state.

See

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

getPrintState()

public SetaPDF_Core_Document_OptionalContent_Group_Usage::getPrintState (

void

): string|null

Get the print state.

See

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

getViewState()

public SetaPDF_Core_Document_OptionalContent_Group_Usage::getViewState (

void

): string|null

Get the view state.

See

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

setExportState()

public SetaPDF_Core_Document_OptionalContent_Group_Usage::setExportState (

[ string|false $state = SetaPDF_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 SetaPDF_Core_Document_OptionalContent_Group_Usage::setPrintState (

[ string|false $state = SetaPDF_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 SetaPDF_Core_Document_OptionalContent_Group_Usage::setViewState (

[ string|false $state = SetaPDF_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