Class IccBased in namespace setasign\SetaPDF2\Core\ColorSpace in SetaPDF v2 API Reference

Index

\setasign\SetaPDF2
1. Core
  1. ColorSpace
    1. AbstractResource
    2. ColorSpace
    3. DeviceCmyk
    4. DeviceGray
    5. DeviceN
    6. DeviceRgb
    7. IccBased
    8. Indexed
    9. Lab
    10. Separation

setasign\SetaPDF2\Core\ColorSpace

IccBased ICCBased Color Space

File: /SetaPDF v2/Core/ColorSpace/IccBased.php
Old class name (alias): \SetaPDF_Core_ColorSpace_IccBased

Class hierarchy

ColorSpace
- AbstractResource
  - IccBased

Implements

\setasign\SetaPDF2\Core\Resource\ResourceInterface

Summary

Constants

TYPE_COLOR_SPACE

public const string \setasign\SetaPDF2\Core\Resource\ResourceInterface::TYPE_COLOR_SPACE = 'ColorSpace'

Type constant

TYPE_EXT_G_STATE

public const string \setasign\SetaPDF2\Core\Resource\ResourceInterface::TYPE_EXT_G_STATE = 'ExtGState'

Type constant

TYPE_FONT

public const string \setasign\SetaPDF2\Core\Resource\ResourceInterface::TYPE_FONT = 'Font'

Type constant

TYPE_PATTERN

public const string \setasign\SetaPDF2\Core\Resource\ResourceInterface::TYPE_PATTERN = 'Pattern'

Type constant

TYPE_PROC_SET

public const string \setasign\SetaPDF2\Core\Resource\ResourceInterface::TYPE_PROC_SET = 'ProcSet'

Type constant

TYPE_PROPERTIES

public const string \setasign\SetaPDF2\Core\Resource\ResourceInterface::TYPE_PROPERTIES = 'Properties'

Type constant

TYPE_SHADING

public const string \setasign\SetaPDF2\Core\Resource\ResourceInterface::TYPE_SHADING = 'Shading'

Type constant

TYPE_X_OBJECT

public const string \setasign\SetaPDF2\Core\Resource\ResourceInterface::TYPE_X_OBJECT = 'XObject'

Type constant

Properties

$_indirectObject

protected \SetaPDF_Core_Type_IndirectObjectInterface ColorSpace::$_indirectObject

The indirect object for this color space

$_value

protected \SetaPDF_Core_Type_Name|\SetaPDF_Core_Type_Array ColorSpace::$_value

The main color space PDF value

Static Methods

create()

public static IccBased::create (

\SetaPDF_Core_IccProfile_Stream $iccStream

): \SetaPDF_Core_ColorSpace_IccBased

Creates an instance of this color space.

Parameters

$iccStream : \SetaPDF_Core_IccProfile_Stream

Exceptions

Throws \setasign\SetaPDF2\Core\Exception

createByDefinition()

public static ColorSpace::createByDefinition (

string|\SetaPDF_Core_Type_Name|\SetaPDF_Core_Type_Array|\SetaPDF_Core_Type_IndirectObjectInterface $object

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 \setasign\SetaPDF2\Core\Type\Exception

Throws \setasign\SetaPDF2\Core\Exception

freeCache()

public static IccBased::freeCache (

\SetaPDF_Core_Document $document

): void

Release profile stream instances by a document instance.

Parameters

$document : \SetaPDF_Core_Document

Methods

__construct()

public IccBased::__construct (

\SetaPDF_Core_Type_AbstractType $definition

)

The constructor.

Parameters

$definition : \SetaPDF_Core_Type_AbstractType

Exceptions

Throws \InvalidArgumentException,\setasign\SetaPDF2\Core\Exception

_getStream()

private IccBased::_getStream (

void

): void

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

getAlternateColorSpace()

public IccBased::getAlternateColorSpace (

void

Get the alternate color space.

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

Throws \setasign\SetaPDF2\Core\Exception

getColorComponents()

public IccBased::getColorComponents (

void

): int

Get the color components of this color space.

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

getDefaultDecodeArray()

public IccBased::getDefaultDecodeArray (

void

): array

Get the default decode array of this color space.

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

getFamily()

public ColorSpace::getFamily (

void

): string

Get the color space family name of this color space.

Exceptions

Throws \setasign\SetaPDF2\Core\Exception

getIccProfileStream()

public IccBased::getIccProfileStream (

void

): \SetaPDF_Core_IccProfile_Stream

Get an instance of the ICC Profile stream.

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

getIndirectObject()

public AbstractResource::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

\setasign\SetaPDF2\Core\Resource\ResourceInterface::getIndirectObject()

getPdfValue()

public ColorSpace::getPdfValue (

void

): \SetaPDF_Core_Type_Name|\SetaPDF_Core_Type_Array

Get the main color space PDF value.

getResourceType()

public AbstractResource::getResourceType (

void

): string

Get the resource-type of an implementation.