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

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

Class hierarchy

Summary

Properties


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 string SetaPDF_Core_Document_OptionalContent_Group_Usage::_getState ( string $name )

Get a state by name.

Parameters
$name : string
 

_setState()

protected void SetaPDF_Core_Document_OptionalContent_Group_Usage::_setState ( string $name, string $state )

Set a state by name.

Parameters
$name : string
 
$state : string
 

cleanUp()

public void SetaPDF_Core_Document_OptionalContent_Group_Usage::cleanUp ( void )

Release resources / cycled references.

getDictionary()

public null|SetaPDF_Core_Type_Dictionary SetaPDF_Core_Document_OptionalContent_Group_Usage::getDictionary ( [ boolean $create = false ] )

Gets and/or creates the usage dictionary.

Method is normally only used internally.

Parameters
$create : boolean
 

getExportState()

public string|null SetaPDF_Core_Document_OptionalContent_Group_Usage::getExportState ( void )

Get the export state.

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

getPrintState()

public string|null SetaPDF_Core_Document_OptionalContent_Group_Usage::getPrintState ( void )

Get the print state.

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

getViewState()

public string|null SetaPDF_Core_Document_OptionalContent_Group_Usage::getViewState ( void )

Get the view state.

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

setExportState()

public void SetaPDF_Core_Document_OptionalContent_Group_Usage::setExportState ( [ string|false $state = \SetaPDF_Core_Document_Catalog_OptionalContent::STATE_ON ] )

Set the export state.

Parameters
$state : string|false
 
See
  • PDF 32000-1:2008 - 8.11.4.4 Usage and Usage Application Dictionaries

setPrintState()

public void SetaPDF_Core_Document_OptionalContent_Group_Usage::setPrintState ( [ string|false $state = \SetaPDF_Core_Document_Catalog_OptionalContent::STATE_ON ] )

Set the print state.

Parameters
$state : string|false
 
See
  • PDF 32000-1:2008 - 8.11.4.4 Usage and Usage Application Dictionaries

setViewState()

public void SetaPDF_Core_Document_OptionalContent_Group_Usage::setViewState ( [ string|false $state = \SetaPDF_Core_Document_Catalog_OptionalContent::STATE_ON ] )

Set the view state.

Parameters
$state : string|false
 
See
  • PDF 32000-1:2008 - 8.11.4.4 Usage and Usage Application Dictionaries