Class Indexed 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

Indexed Indexed Color Space

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

Class hierarchy

ColorSpace
- AbstractResource
  - Indexed

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

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

Methods

__construct()

public Indexed::__construct (

\SetaPDF_Core_Type_AbstractType $definition

)

The constructor.

Parameters

$definition : \SetaPDF_Core_Type_AbstractType

Exceptions

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

getBase()

public Indexed::getBase (

void

Get the base color space.

Exceptions

Throws \setasign\SetaPDF2\Core\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

getColorComponents()

public Indexed::getColorComponents (

void

): int

Get the color components of this color space.

Exceptions

Throws \setasign\SetaPDF2\Core\Exception

getDefaultDecodeArray()

public Indexed::getDefaultDecodeArray (

int $bitsPerComponent = null

): array

Get the default decode array of this color space.

Parameters

$bitsPerComponent : int

Exceptions

Throws \setasign\SetaPDF2\Core\Exception

getFamily()

public ColorSpace::getFamily (

void

): string

Get the color space family name of this color space.

Exceptions

Throws \setasign\SetaPDF2\Core\Exception

getHival()

public Indexed::getHival (

void

): int

Get the maximum valid index value (hival).

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()

getLookupTable()

public Indexed::getLookupTable (

void

): array

Get the lookup table.

Exceptions

Throws \setasign\SetaPDF2\Core\Exception

Throws \setasign\SetaPDF2\Core\Type\Exception

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.