Index

  1. \SetaPDF
    1. Core
    2. Core
      1. Document
      2. Document
        1. Catalog
        2. Catalog
          1. Names
          2. Names
          3. AcroForm
          4. AdditionalActions
          5. Dests
          6. Extensions
          7. MarkInfo
          8. OptionalContent
          9. Outlines
          10. OutputIntents
          11. PageLabels
          12. Pages
          13. Permissions
          14. StructTreeRoot
          15. ViewerPreferences

SetaPDF_Core_Document_Catalog_ViewerPreferences Class representing the access to the ViewerPreferences dictionary of a document

File: /SetaPDF v2/Core/Document/Catalog/ViewerPreferences.php

Class hierarchy

Summary

Methods

Properties

Constants

Constants

DIRECTION_L2R

public const string SetaPDF_Core_Document_Catalog_ViewerPreferences::DIRECTION_L2R = 'L2R'

Constant value for predominant reading order for text.

Left to right.

DIRECTION_R2L

public const string SetaPDF_Core_Document_Catalog_ViewerPreferences::DIRECTION_R2L = 'R2L'

Constant value for predominant reading order for text.

Right to left.

DUPLEX_FLIP_LONG_EDGE

public const string SetaPDF_Core_Document_Catalog_ViewerPreferences::DUPLEX_FLIP_LONG_EDGE = 'DuplexFlipLongEdge'

Constant value of the paper handling option that shall be used when printing the file from the print dialog.

Duplex and flip on the long edge of the sheet.

DUPLEX_FLIP_SHORT_EDGE

public const string SetaPDF_Core_Document_Catalog_ViewerPreferences::DUPLEX_FLIP_SHORT_EDGE = 'DuplexFlipShortEdge'

Constant value of the paper handling option that shall be used when printing the file from the print dialog.

Duplex and flip on the short edge of the sheet.

DUPLEX_SIMPLEX

public const string SetaPDF_Core_Document_Catalog_ViewerPreferences::DUPLEX_SIMPLEX = 'Simplex'

Constant value of the paper handling option that shall be used when printing the file from the print dialog.

Print single-sided.

NON_FULL_SCREEN_PAGE_MODE_USE_NONE

public const string SetaPDF_Core_Document_Catalog_ViewerPreferences::NON_FULL_SCREEN_PAGE_MODE_USE_NONE = 'UseNone'

Constant value specifying how to display the document on exiting full-screen mode.

Neither document outline nor thumbnail images visible.

NON_FULL_SCREEN_PAGE_MODE_USE_OC

public const string SetaPDF_Core_Document_Catalog_ViewerPreferences::NON_FULL_SCREEN_PAGE_MODE_USE_OC = 'UseOC'

Constant value specifying how to display the document on exiting full-screen mode.

Optional content group panel visible.

NON_FULL_SCREEN_PAGE_MODE_USE_OUTLINES

public const string SetaPDF_Core_Document_Catalog_ViewerPreferences::NON_FULL_SCREEN_PAGE_MODE_USE_OUTLINES = 'UseOutlines'

Constant value specifying how to display the document on exiting full-screen mode.

Document outline visible.

NON_FULL_SCREEN_PAGE_MODE_USE_THUMBS

public const string SetaPDF_Core_Document_Catalog_ViewerPreferences::NON_FULL_SCREEN_PAGE_MODE_USE_THUMBS = 'UseThumbs'

Constant value specifying how to display the document on exiting full-screen mode.

Thumbnail images visible.

PRINT_SCALING_APP_DEFAULT

public const string SetaPDF_Core_Document_Catalog_ViewerPreferences::PRINT_SCALING_APP_DEFAULT = 'AppDefault'

Constant value of the the page scaling option that shall be selected when a print dialog is displayed for this document.

Reader’s default print scaling.

PRINT_SCALING_NONE

public const string SetaPDF_Core_Document_Catalog_ViewerPreferences::PRINT_SCALING_NONE = 'None'

Constant value of the the page scaling option that shall be selected when a print dialog is displayed for this document.

No page scaling.


Properties

$_catalog

protected SetaPDF_Core_Document_Catalog SetaPDF_Core_Document_Catalog_ViewerPreferences::$_catalog

The catalog instance


Methods

__construct()

public SetaPDF_Core_Document_Catalog_ViewerPreferences::__construct ()

The constructor.

Parameters
$catalog : SetaPDF_Core_Document_Catalog
 

_getValue()

protected SetaPDF_Core_Document_Catalog_ViewerPreferences::_getValue (
string $key [, mixed $default = false [, boolean $pdfObject = false ]]
): mixed

Helper method to get a value of the ViewerPreferences dictionary.

Parameters
$key : string
 
$default : mixed
 
$pdfObject : boolean
 
Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

_removeKey()

protected SetaPDF_Core_Document_Catalog_ViewerPreferences::_removeKey (
string $key
): void

Helper method for removing a key from the ViewerPreferences dictionary.

Parameters
$key : string
 
Exceptions

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Core_SecHandler_Exception

_setBooleanValue()

protected SetaPDF_Core_Document_Catalog_ViewerPreferences::_setBooleanValue (
string $key, boolean $value
): void

Helper method for setting boolean values.

Parameters
$key : string
 
$value : boolean
 
Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

_setNameValue()

protected SetaPDF_Core_Document_Catalog_ViewerPreferences::_setNameValue (
string $key, string $name
): void

Helper method for setting a name value.

Parameters
$key : string
 
$name : string
 
Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

_setValue()

protected SetaPDF_Core_Document_Catalog_ViewerPreferences::_setValue (
string $key, SetaPDF_Core_Type_AbstractType $value
): void

Helper method for setting a value.

Parameters
$key : string
 
$value : SetaPDF_Core_Type_AbstractType
 
Exceptions

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Core_SecHandler_Exception

cleanUp()

public SetaPDF_Core_Document_Catalog_ViewerPreferences::cleanUp (
void
): void

Release memory and cycled references.

getCenterWindow()

public SetaPDF_Core_Document_Catalog_ViewerPreferences::getCenterWindow (
void
): boolean

Get the flag specifying whether to position the document’s window in the center of the screen.

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

getDirection()

public SetaPDF_Core_Document_Catalog_ViewerPreferences::getDirection (
void
): string

Get the predominant reading order for text.

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

getDisplayDocTitle()

public SetaPDF_Core_Document_Catalog_ViewerPreferences::getDisplayDocTitle (
void
): boolean

Get the flag whether the title or the filename of the document should be displayed in the window’s title bar.

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

getDocument()

public SetaPDF_Core_Document_Catalog_ViewerPreferences::getDocument (
void
): SetaPDF_Core_Document

Get the document instance.

getDuplex()

public SetaPDF_Core_Document_Catalog_ViewerPreferences::getDuplex (
void
): string|null

Get the paper handling option that shall be used when printing the file from the print dialog.

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

getFitWindow()

public SetaPDF_Core_Document_Catalog_ViewerPreferences::getFitWindow (
void
): boolean

Get the flag specifying whether to resize the document’s window to fit the size of the first displayed page.

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

getHideMenubar()

public SetaPDF_Core_Document_Catalog_ViewerPreferences::getHideMenubar (
void
): boolean

Get the flag specifying whether to hide the conforming reader’s menu bar when the document is active.

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

getHideToolbar()

public SetaPDF_Core_Document_Catalog_ViewerPreferences::getHideToolbar (
void
): boolean

Get the flag specifying whether to hide the conforming reader’s tool bars when the document is active.

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

getHideWindowUI()

public SetaPDF_Core_Document_Catalog_ViewerPreferences::getHideWindowUI (
void
): boolean

Get flag specifying whether to hide user interface elements in the document’s window (such as scroll bars and navigation controls), leaving only the document’s contents displayed.

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

getNonFullScreenPageMode()

public SetaPDF_Core_Document_Catalog_ViewerPreferences::getNonFullScreenPageMode (
void
): string

Get the document's page mode, specifying how to display the document on exiting full-screen mode.

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

getNumCopies()

public SetaPDF_Core_Document_Catalog_ViewerPreferences::getNumCopies (
[ int $defaultValue = 1 ]
): bool|mixed

Get the number of copies that shall be printed when the print dialog is opened.

Parameters
$defaultValue : int

A default value, to be used if no preference is defined.

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

getPickTrayByPdfSize()

public SetaPDF_Core_Document_Catalog_ViewerPreferences::getPickTrayByPdfSize (
[ null|boolean $defaultValue = null ]
): bool|mixed

Get the flag specifying whether the PDF page size shall be used to select the input paper tray.

Parameters
$defaultValue : null|boolean
 
Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

getPrintArea()

public SetaPDF_Core_Document_Catalog_ViewerPreferences::getPrintArea (
void
): string

Get the name of the page boundary representing the area of a page that shall be rendered when printing the document.

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

getPrintClip()

public SetaPDF_Core_Document_Catalog_ViewerPreferences::getPrintClip (
void
): string

Get the name of the page boundary to which the contents of a page shall be clipped when printing the document.

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

getPrintPageRange()

public SetaPDF_Core_Document_Catalog_ViewerPreferences::getPrintPageRange (
[ array $defaultValue = array ( ) ]
): array

Get the page numbers used to initialize the print dialog box when the file is printed.

Parameters
$defaultValue : array

A default value that will be returned if no preference is defined.

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

getPrintScaling()

public SetaPDF_Core_Document_Catalog_ViewerPreferences::getPrintScaling (
void
): string

Get the page scaling option that shall be selected when a print dialog is displayed for this document.

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

getViewArea()

public SetaPDF_Core_Document_Catalog_ViewerPreferences::getViewArea (
void
): string

Get the page boundary representing the area of a page that shall be displayed when viewing the document on the screen.

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

getViewClip()

public SetaPDF_Core_Document_Catalog_ViewerPreferences::getViewClip (
void
): string

Get the name of the page boundary to which the contents of a page shall be clipped when viewing the document on the screen.

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

setCenterWindow()

public SetaPDF_Core_Document_Catalog_ViewerPreferences::setCenterWindow (
[ boolean $value = true ]
): void

Set the flag specifying whether to position the document’s window in the center of the screen.

Parameters
$value : boolean

A boolean value defining whether to position the document’s window in the center.

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

setDirection()

public SetaPDF_Core_Document_Catalog_ViewerPreferences::setDirection (
string|false $name
): void

Set the predominant reading order for text.

Parameters
$name : string|false

A constant value of SetaPDF_Core_Document_Catalog_ViewerPreferences::DIRECTION_XXX or false to remove this entry.

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

setDisplayDocTitle()

public SetaPDF_Core_Document_Catalog_ViewerPreferences::setDisplayDocTitle (
[ boolean $value = true ]
): void

Set the flag whether the title or the filename of the document should be displayed in the window’s title bar.

Parameters
$value : boolean

The value defining whether if the title of the document should be displayed in the window’s title bar (true) or the filename (false).

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

setDuplex()

public SetaPDF_Core_Document_Catalog_ViewerPreferences::setDuplex (
string|false $name
): void

Set the paper handling option that shall be used when printing the file from the print dialog.

Parameters
$name : string|false

A constant value of SetaPDF_Core_Document_Catalog_ViewerPreferences::DUPLEX_XXX or false to remove that entry.

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

setFitWindow()

public SetaPDF_Core_Document_Catalog_ViewerPreferences::setFitWindow (
[ boolean $value = true ]
): void

Set the flag specifying whether to resize the document’s window to fit the size of the first displayed page.

Parameters
$value : boolean

A boolean value defining whether to resize the document’s window.

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

setHideMenubar()

public SetaPDF_Core_Document_Catalog_ViewerPreferences::setHideMenubar (
[ boolean $value = true ]
): void

Set the flag specifying whether to hide the conforming reader’s menu bar when the document is active.

Does not affect the display through a browser plugin.

Parameters
$value : boolean

A boolean value defining whether to hide the menu bar or not.

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

setHideToolbar()

public SetaPDF_Core_Document_Catalog_ViewerPreferences::setHideToolbar (
[ boolean $value = true ]
): void

Set the flag specifying whether to hide the conforming reader’s tool bars when the document is active.

Parameters
$value : boolean

A boolean value defining whether to hide the tool bars or not.

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

setHideWindowUI()

public SetaPDF_Core_Document_Catalog_ViewerPreferences::setHideWindowUI (
[ boolean $value = true ]
): void

Set flag specifying whether to hide user interface elements in the document’s window (such as scroll bars and navigation controls), leaving only the document’s contents displayed.

Parameters
$value : boolean

A boolean value defining whether to hide user interface elements in the document's windows.

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

setNonFullScreenPageMode()

public SetaPDF_Core_Document_Catalog_ViewerPreferences::setNonFullScreenPageMode (): void

Set the document's page mode, specifying how to display the document on exiting full-screen mode.

Parameters
$name : string|false

A constant value of SetaPDF_Core_Document_Catalog_ViewerPreferences::NON_FULL_SCREEN_PAGE_MODE_XXX or false to remove the entry.

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

setNumCopies()

public SetaPDF_Core_Document_Catalog_ViewerPreferences::setNumCopies (
integer|false $numCopies
): void

Set the number of copies that shall be printed when the print dialog is opened for this file.

Parameters
$numCopies : integer|false

The number of copies or false to remove this entry.

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

setPickTrayByPdfSize()

public SetaPDF_Core_Document_Catalog_ViewerPreferences::setPickTrayByPdfSize (
[ boolean $value = true ]
): void

Set the flag specifying whether the PDF page size shall be used to select the input paper tray.

Parameters
$value : boolean

A boolean value

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

setPrintArea()

public SetaPDF_Core_Document_Catalog_ViewerPreferences::setPrintArea (
string|false $boundaryName
): void

Set the name of the page boundary representing the area of a page that shall be rendered when printing the document.

Parameters
$boundaryName : string|false

A boundary name as defined as a constant in SetaPDF_Core_PageBoundaries or false to remove that entry.

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

setPrintClip()

public SetaPDF_Core_Document_Catalog_ViewerPreferences::setPrintClip (
string|false $boundaryName
): void

Set the name of the page boundary to which the contents of a page shall be clipped when printing the document.

Parameters
$boundaryName : string|false

A boundary name as defined as a constant in SetaPDF_Core_PageBoundaries or false to remove that entry.

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

setPrintPageRange()

public SetaPDF_Core_Document_Catalog_ViewerPreferences::setPrintPageRange (
[ array|null $pageRange = null ]
): void

Set the page numbers used to initialize the print dialog box when the file is printed.

Parameters
$pageRange : array|null

An array of even number of integer values to be interpreted in pairs. Each pair represents the first and last pages in a sub-range of pages.

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

setPrintScaling()

public SetaPDF_Core_Document_Catalog_ViewerPreferences::setPrintScaling (
string|false $name
): void

Set the page scaling option that shall be selected when a print dialog is displayed for this document.

Parameters
$name : string|false

A constant value of SetaPDF_Core_Document_Catalog_ViewerPreferences::PRINT_SCALING_XXX or false to remove that entry.

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

setViewArea()

public SetaPDF_Core_Document_Catalog_ViewerPreferences::setViewArea (
string|false $boundaryName
): void

Set the page boundary representing the area of a page that shall be displayed when viewing the document on the screen.

Parameters
$boundaryName : string|false

A boundary name as defined as a constant in SetaPDF_Core_PageBoundaries or false to remove this entry.

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception

setViewClip()

public SetaPDF_Core_Document_Catalog_ViewerPreferences::setViewClip (
string $boundaryName
): void

Set the name of the page boundary to which the contents of a page shall be clipped when viewing the document on the screen.

Parameters
$boundaryName : string

A boundary name as defined as a constant in SetaPDF_Core_PageBoundaries.

Exceptions

Throws SetaPDF_Core_SecHandler_Exception

Throws SetaPDF_Core_Type_Exception


© 2024 Setasign GmbH & Co. KG · Contact / Imprint · Data Privacy Statement (German)