Index

  1. \SetaPDF
    1. Core
    2. Core
      1. ColorSpace
      2. ColorSpace
        1. DeviceCmyk
        2. DeviceGray
        3. DeviceN
        4. DeviceRgb
        5. IccBased
        6. Indexed
        7. Lab
        8. Resource
        9. Separation

SetaPDF_Core_ColorSpace_Separation Separation Color Space

File: /SetaPDF v2/Core/ColorSpace/Separation.php

Class hierarchy

Implements

Summary

Static Methods

Methods

Properties

Constants

Constants

TYPE_COLOR_SPACE

public const string SetaPDF_Core_Resource::TYPE_COLOR_SPACE = 'ColorSpace'

Type constant

TYPE_EXT_G_STATE

public const string SetaPDF_Core_Resource::TYPE_EXT_G_STATE = 'ExtGState'

Type constant

TYPE_FONT

public const string SetaPDF_Core_Resource::TYPE_FONT = 'Font'

Type constant

TYPE_PATTERN

public const string SetaPDF_Core_Resource::TYPE_PATTERN = 'Pattern'

Type constant

TYPE_PROC_SET

public const string SetaPDF_Core_Resource::TYPE_PROC_SET = 'ProcSet'

Type constant

TYPE_PROPERTIES

public const string SetaPDF_Core_Resource::TYPE_PROPERTIES = 'Properties'

Type constant

TYPE_SHADING

public const string SetaPDF_Core_Resource::TYPE_SHADING = 'Shading'

Type constant

TYPE_X_OBJECT

public const string SetaPDF_Core_Resource::TYPE_X_OBJECT = 'XObject'

Type constant


Properties

$_indirectObject

protected SetaPDF_Core_Type_IndirectObjectInterface SetaPDF_Core_ColorSpace::$_indirectObject

The indirect object for this color space

$_value

protected SetaPDF_Core_Type_Name|SetaPDF_Core_Type_Array SetaPDF_Core_ColorSpace::$_value

The main color space PDF value


Static Methods

createByDefinition()

public static SetaPDF_Core_ColorSpace::createByDefinition (): SetaPDF_Core_ColorSpace|SetaPDF_Core_ColorSpace_DeviceCmyk|SetaPDF_Core_ColorSpace_DeviceGray|SetaPDF_Core_ColorSpace_DeviceRgb|SetaPDF_Core_ColorSpace_IccBased|SetaPDF_Core_ColorSpace_Separation

Creates a color space instance based on the incoming value.

Parameters
$object : string|SetaPDF_Core_Type_Name|SetaPDF_Core_Type_Array|SetaPDF_Core_Type_IndirectObjectInterface

A color space definition

Exceptions

Throws InvalidArgumentException

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Core_Exception

createSpotColor()

public static SetaPDF_Core_ColorSpace_Separation::createSpotColor (
SetaPDF_Core_Document $document, string $name, int|float|array $c [, int|float $m = null [, int|float $y = null [, int|float $k = null ]]]
): SetaPDF_Core_ColorSpace_Separation

Creates a spot color color-space.

Parameters
$document : SetaPDF_Core_Document
 
$name : string
 
$c : int|float|array

If is array $m, $y, $k will be ignored. The array need 4 entries.

$m : int|float
 
$y : int|float
 
$k : int|float
 
Exceptions

Throws SetaPDF_Core_Exception


Methods

__construct()

public SetaPDF_Core_ColorSpace_Separation::__construct ()

The constructor.

Parameters
$definition : SetaPDF_Core_Type_AbstractType
 
Exceptions

Throws InvalidArgumentException

Throws SetaPDF_Core_Exception

getAlternateColorSpace()

public SetaPDF_Core_ColorSpace_Separation::getAlternateColorSpace (
void
): SetaPDF_Core_ColorSpace|SetaPDF_Core_ColorSpace_DeviceCmyk|SetaPDF_Core_ColorSpace_DeviceGray|SetaPDF_Core_ColorSpace_DeviceRgb|SetaPDF_Core_ColorSpace_IccBased|SetaPDF_Core_ColorSpace_Separation

Get the alternate color space.

Exceptions

Throws SetaPDF_Core_Exception

Throws SetaPDF_Core_Type_Exception

getAlternateSpace()

WARNING: This method is marked as deprecated!

public SetaPDF_Core_ColorSpace_Separation::getAlternateSpace (
void
): SetaPDF_Core_ColorSpace|SetaPDF_Core_ColorSpace_DeviceCmyk|SetaPDF_Core_ColorSpace_DeviceGray|SetaPDF_Core_ColorSpace_DeviceRgb|SetaPDF_Core_ColorSpace_IccBased|SetaPDF_Core_ColorSpace_Separation

Get the alternate color space.

Exceptions

Throws SetaPDF_Core_Exception

Throws SetaPDF_Core_Type_Exception

getColorComponents()

public SetaPDF_Core_ColorSpace::getColorComponents (
void
): void

Get the color components of this color space.

Exceptions

Throws SetaPDF_Core_Exception

getDefaultDecodeArray()

public SetaPDF_Core_ColorSpace::getDefaultDecodeArray (
void
): void

Get the default decode array of this color space.

Exceptions

Throws SetaPDF_Core_Exception

getFamily()

public SetaPDF_Core_ColorSpace::getFamily (
void
): string

Get the color space family name of this color space.

Exceptions

Throws SetaPDF_Core_Exception

getIndirectObject()

public SetaPDF_Core_ColorSpace_Resource::getIndirectObject (
[ SetaPDF_Core_Document $document = null ]
): SetaPDF_Core_Type_IndirectObjectInterface

Gets an indirect object for this color space dictionary.

Parameters
$document : SetaPDF_Core_Document
 
Exceptions

Throws InvalidArgumentException

See

getName()

public SetaPDF_Core_ColorSpace_Separation::getName (
void
): string

Get the name of the colorant that this Separation color space is intended to represent.

Exceptions

Throws SetaPDF_Core_Type_Exception

getPdfValue()

public SetaPDF_Core_ColorSpace::getPdfValue (
void
): SetaPDF_Core_Type_Name|SetaPDF_Core_Type_Array

Get the main color space PDF value.

getResourceType()

public SetaPDF_Core_ColorSpace_Resource::getResourceType (
void
): string

Get the resource-type of an implementation.

getTintTransform()

public SetaPDF_Core_ColorSpace_Separation::getTintTransform (
void
): SetaPDF_Core_Type_Dictionary|SetaPDF_Core_Type_Stream

Get the tint transformation function.

Exceptions

Throws SetaPDF_Core_Type_Exception

setAlternateColorSpace()

public SetaPDF_Core_ColorSpace_Separation::setAlternateColorSpace (): void

Set the alternate color space.

Parameters
$colorSpace : SetaPDF_Core_ColorSpace
 

setName()

public SetaPDF_Core_ColorSpace_Separation::setName (
string $name
): void

Set the name of the colorant that this Separation color space is intended to represent.

Parameters
$name : string
 
Exceptions

Throws SetaPDF_Core_Type_Exception

setTintTransform()

public SetaPDF_Core_ColorSpace_Separation::setTintTransform (): void

Set the tint transformation function.

Parameters
$tintTransform : SetaPDF_Core_Type_AbstractType
 
Exceptions

Throws InvalidArgumentException

Throws SetaPDF_Core_Type_Exception


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