Class setasign\SetaPDF2\Core\TransparencyGroup in SetaPDF v2 API Reference

Index

\setasign\SetaPDF2
1. Core
  1. BitConverter
  2. Canvas
  3. ColorSpace
  4. Core
  5. DataStructure
  6. Document
  7. Document
  8. EmbeddedFileStream
  9. Encoding
  10. Exception
  11. FileSpecification
  12. Filter
  13. Font
  14. Geometry
  15. IccProfile
  16. Image
  17. OutputIntent
  18. PageBoundaries
  19. PageFormats
  20. Parser
  21. Reader
  22. Resource
  23. SecHandler
  24. Text
  25. Tokenizer
  26. TransparencyGroup
  27. Type
  28. Writer
  29. XObject
  30. Xmp
  31. Zugferd

setasign\SetaPDF2\Core

TransparencyGroup Class representing a transparency group

File: /SetaPDF v2/Core/TransparencyGroup.php
Old class name (alias): \SetaPDF_Core_TransparencyGroup

Class hierarchy

TransparencyGroup

Summary

Properties

$_dictionary

protected \SetaPDF_Core_Type_Dictionary TransparencyGroup::$_dictionary

The dictionary

Static Methods

createDictionary()

public static TransparencyGroup::createDictionary (

void

): \SetaPDF_Core_Type_Dictionary

Creates a "Transparency Group XObjects" Group dictionary.

Methods

__construct()

public TransparencyGroup::__construct (

\SetaPDF_Core_Type_Dictionary $dictionary = null

)

Creates the Group dictionary for an Transparency Group XObject.

Parameters

$dictionary : \SetaPDF_Core_Type_Dictionary

Exceptions

Throws \InvalidArgumentException

getColorSpace()

public TransparencyGroup::getColorSpace (

bool $pdfValue = false

): \SetaPDF_Core_Type_Name|\SetaPDF_Core_Type_Array|null

Return the color space.

Parameters

$pdfValue : bool

getDictionary()

public TransparencyGroup::getDictionary (

void

): \SetaPDF_Core_Type_Dictionary

Get the dictionary.

isIsolated()

public TransparencyGroup::isIsolated (

void

): bool

Checks whether the transparency group is isolated.

isKnockoutGroup()

public TransparencyGroup::isKnockoutGroup (

void

): bool

Checks whether the transparency group is a knockout group.

setColorSpace()

public TransparencyGroup::setColorSpace (

string|\SetaPDF_Core_Type_Name $colorSpace

): void

Set the colorspace for this group.

Actually only standard color spaces are allowed.

Parameters

$colorSpace : string|\SetaPDF_Core_Type_Name

setIsolated()

public TransparencyGroup::setIsolated (

bool $isolated

): void

Set whether the transparency group is isolated.

Parameters

$isolated : bool

setKnockoutGroup()

public TransparencyGroup::setKnockoutGroup (

bool $knockoutGroup

): void

Set whether the transparency group is a knockout group.

Parameters

$knockoutGroup : bool