Class Stream in namespace setasign\SetaPDF2\Core\IccProfile in SetaPDF v2 API Reference

Index

\setasign\SetaPDF2
1. Core
  1. IccProfile
    1. Parser
    2. Stream

setasign\SetaPDF2\Core\IccProfile

Stream Class for handling an ICC profile stream

File: /SetaPDF v2/Core/IccProfile/Stream.php
Old class name (alias): \SetaPDF_Core_IccProfile_Stream

Class hierarchy

Stream

Summary

Properties

$_indirectObject

protected \setasign\SetaPDF2\Core\Type\IndirectObjectInterface Stream::$_indirectObject

The indirect object of this stream

$_parser

protected Parser Stream::$_parser

A ICC profile parser instance

Static Methods

create()

public static Stream::create (

\setasign\SetaPDF2\Core\Document $document,
\setasign\SetaPDF2\Core\Reader\BinaryReader|string $iccProfile

): Stream

Creates an ICC profile stream.

Parameters

$document : \setasign\SetaPDF2\Core\Document
$iccProfile : \setasign\SetaPDF2\Core\Reader\BinaryReader|string: A path to an ICC profile or a reader object

Exceptions

Throws \setasign\SetaPDF2\Core\Exception

Methods

__construct()

public Stream::__construct (

\setasign\SetaPDF2\Core\Type\IndirectObjectInterface $indirectObject

)

The constructor.

Parameters

$indirectObject : \setasign\SetaPDF2\Core\Type\IndirectObjectInterface

Exceptions

Throws \InvalidArgumentException

_getDictionary()

protected Stream::_getDictionary (

void

): \setasign\SetaPDF2\Core\Type\PdfDictionary

Get the stream dictionary.

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

cleanUp()

public Stream::cleanUp (

void

): void

Release resources.

getAlternate()

public Stream::getAlternate (

void

Get the alternate color space.

Exceptions

Throws \setasign\SetaPDF2\Core\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

getColorComponents()

public Stream::getColorComponents (

void

): int

Get the color component count.

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

getIndirectObject()

public Stream::getIndirectObject (

void

): \setasign\SetaPDF2\Core\Type\IndirectObjectInterface

Get the indirect object.

getParser()

public Stream::getParser (

void

): Parser

Get a parser instance for this ICC profile stream.

Exceptions

Throws \setasign\SetaPDF2\Core\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

getStreamObject()

public Stream::getStreamObject (

void

): \setasign\SetaPDF2\Core\Type\PdfStream

Get the stream object.

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception

setAlternate()

public Stream::setAlternate (

?\setasign\SetaPDF2\Core\ColorSpace\ColorSpace $colorSpace = null

): void

Set the alternate color space.

Parameters

$colorSpace : ?\setasign\SetaPDF2\Core\ColorSpace\ColorSpace

Exceptions

Throws \setasign\SetaPDF2\Core\Type\Exception