Class SetaPDF_Core_IccProfile_Stream in SetaPDF v2 API Reference

Index

\SetaPDF
1. Core
2. Core
  1. IccProfile
    1. Parser
    2. Stream

SetaPDF_Core_IccProfile_Stream Class for handling a ICC profile stream

File: /SetaPDF v2/Core/IccProfile/Stream.php

Class hierarchy

SetaPDF_Core_IccProfile_Stream

Summary

Properties

$_indirectObject

protected SetaPDF_Core_Type_IndirectObjectInterface SetaPDF_Core_IccProfile_Stream::$_indirectObject

The indirect object of this stream

$_parser

protected SetaPDF_Core_IccProfile_Parser SetaPDF_Core_IccProfile_Stream::$_parser

A ICC profile parser instance

Static Methods

create()

public static SetaPDF_Core_IccProfile_Stream::create (

SetaPDF_Core_Document $document, SetaPDF_Core_Reader_Binary|string $iccProfile

): SetaPDF_Core_IccProfile_Stream

Creates an ICC profile stream.

Parameters

$document : SetaPDF_Core_Document
$iccProfile : SetaPDF_Core_Reader_Binary|string: A path to a ICC profile or a reader object

Exceptions

Throws SetaPDF_Core_Exception

Methods

__construct()

public SetaPDF_Core_IccProfile_Stream::__construct (

SetaPDF_Core_Type_IndirectObjectInterface $indirectObject

)

The constructor.

Parameters

$indirectObject : SetaPDF_Core_Type_IndirectObjectInterface

Exceptions

Throws InvalidArgumentException

_getDictionary()

protected SetaPDF_Core_IccProfile_Stream::_getDictionary (

void

): SetaPDF_Core_Type_Dictionary

Get the stream dictionary.

Exceptions

Throws SetaPDF_Core_Type_Exception

cleanUp()

public SetaPDF_Core_IccProfile_Stream::cleanUp (

void

): void

Release resources.

getAlternate()

public SetaPDF_Core_IccProfile_Stream::getAlternate (

void

Get the alternate color space.

Exceptions

Throws SetaPDF_Core_Exception

Throws SetaPDF_Core_Type_Exception

getColorComponents()

public SetaPDF_Core_IccProfile_Stream::getColorComponents (

void

): integer

Get the color component count.

Exceptions

Throws SetaPDF_Core_Type_Exception

getIndirectObject()

public SetaPDF_Core_IccProfile_Stream::getIndirectObject (

void

): SetaPDF_Core_Type_IndirectObjectInterface

Get the indirect object.

getParser()

public SetaPDF_Core_IccProfile_Stream::getParser (

void

): SetaPDF_Core_IccProfile_Parser

Get a parser instance for this ICC profile stream.

Exceptions

Throws SetaPDF_Core_Exception

Throws SetaPDF_Core_Type_Exception

getStreamObject()

public SetaPDF_Core_IccProfile_Stream::getStreamObject (

void

): SetaPDF_Core_Type_Stream

Get the stream object.

Exceptions

Throws SetaPDF_Core_Type_Exception

setAlternate()

public SetaPDF_Core_IccProfile_Stream::setAlternate (

[ SetaPDF_Core_ColorSpace $colorSpace = null ]

): void

Set the alternate color space.

Parameters

$colorSpace : SetaPDF_Core_ColorSpace

Exceptions

Throws SetaPDF_Core_Type_Exception