Class SetaPDF_Core_ColorSpace_IccBased in SetaPDF v2 API Reference

Index

\SetaPDF
1. Core
2. Core
  1. ColorSpace
  2. ColorSpace

SetaPDF_Core_ColorSpace_IccBased ICCBased Color Space

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

Class hierarchy

SetaPDF_Core_ColorSpace
- SetaPDF_Core_ColorSpace_Resource
  - SetaPDF_Core_ColorSpace_IccBased

Implements

SetaPDF_Core_Resource

Summary

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

create()

public static SetaPDF_Core_ColorSpace_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 SetaPDF_Core_Exception

createByDefinition()

public static SetaPDF_Core_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 SetaPDF_Core_Type_Exception

Throws SetaPDF_Core_Exception

freeCache()

public static SetaPDF_Core_ColorSpace_IccBased::freeCache (

SetaPDF_Core_Document $document

): void

Release profile stream instances by a document instance.

Parameters

$document : SetaPDF_Core_Document

Methods

__construct()

public SetaPDF_Core_ColorSpace_IccBased::__construct (

SetaPDF_Core_Type_AbstractType $definition

)

The constructor.

Parameters

$definition : SetaPDF_Core_Type_AbstractType

Exceptions

Throws InvalidArgumentException,SetaPDF_Core_Exception

_getStream()

private SetaPDF_Core_ColorSpace_IccBased::_getStream (

void

): void

Exceptions

Throws SetaPDF_Core_Type_Exception

getAlternateColorSpace()

public SetaPDF_Core_ColorSpace_IccBased::getAlternateColorSpace (

void

Get the alternate color space.

Exceptions

Throws SetaPDF_Core_Type_Exception

Throws SetaPDF_Core_Exception

getColorComponents()

public SetaPDF_Core_ColorSpace_IccBased::getColorComponents (

void

): integer

Get the color components of this color space.

Exceptions

Throws SetaPDF_Core_Type_Exception

getDefaultDecodeArray()

public SetaPDF_Core_ColorSpace_IccBased::getDefaultDecodeArray (

void

): array

Get the default decode array of this color space.

Exceptions

Throws SetaPDF_Core_Type_Exception

getFamily()

public SetaPDF_Core_ColorSpace::getFamily (

void

): string

Get the color space family name of this color space.

Exceptions

Throws SetaPDF_Core_Exception

getIccProfileStream()

public SetaPDF_Core_ColorSpace_IccBased::getIccProfileStream (

void

): SetaPDF_Core_IccProfile_Stream

Get an instance of the ICC Profile stream.

Exceptions

Throws SetaPDF_Core_Type_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

SetaPDF_Core_Resource::getIndirectObject()

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.