Class SetaPDF_Core_ColorSpace_Lab in SetaPDF v2 API Reference

Index

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

SetaPDF_Core_ColorSpace_Lab Lab Color Space

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

Class hierarchy

SetaPDF_Core_ColorSpace
- SetaPDF_Core_ColorSpace_Resource
  - SetaPDF_Core_ColorSpace_Lab

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

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

Methods

__construct()

public SetaPDF_Core_ColorSpace_Lab::__construct (

SetaPDF_Core_Type_AbstractType $definition

)

The constructor.

Parameters

$definition : SetaPDF_Core_Type_AbstractType

Exceptions

Throws InvalidArgumentException

Throws SetaPDF_Core_Exception

_getDictionary()

private SetaPDF_Core_ColorSpace_Lab::_getDictionary (

void

): SetaPDF_Core_Type_Dictionary

Exceptions

Throws SetaPDF_Core_Type_Exception

getBlackPoint()

public SetaPDF_Core_ColorSpace_Lab::getBlackPoint (

void

): array|float[]

Get the BlackPoint values.

Exceptions

Throws SetaPDF_Core_Type_Exception

getColorComponents()

public SetaPDF_Core_ColorSpace::getColorComponents (

void

): void

Get the color components of this color space.

Exceptions

Throws SetaPDF_Core_Exception

getDefaultDecodeArray()

public SetaPDF_Core_ColorSpace::getDefaultDecodeArray (

void

): void

Get the default decode array of this color space.

Exceptions

Throws SetaPDF_Core_Exception

getFamily()

public SetaPDF_Core_ColorSpace::getFamily (

void

): string

Get the color space family name of this color space.

Exceptions

Throws SetaPDF_Core_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.

getRange()

public SetaPDF_Core_ColorSpace_Lab::getRange (

void

): array|int[]

Get the Range values.

Exceptions

Throws SetaPDF_Core_Type_Exception

getResourceType()

public SetaPDF_Core_ColorSpace_Resource::getResourceType (

void

): string

Get the resource-type of an implementation.

getWhitePoint()

public SetaPDF_Core_ColorSpace_Lab::getWhitePoint (

void

): array

Get the WhitePoint value.

Exceptions

Throws SetaPDF_Core_Exception

setBlackPoint()

public SetaPDF_Core_ColorSpace_Lab::setBlackPoint (

int|float|int[] $x [, int|float $y = null [, int|float $z = null ]]

): void

Set the BlackPoint value.

Parameters

$x : int|float|int[]
$y : int|float
$z : int|float

Exceptions

Throws SetaPDF_Core_Type_Exception

setRange()

public SetaPDF_Core_ColorSpace_Lab::setRange (

): void

Set the Range values.

Parameters

$aMin : int|float|int[]
$aMax : int|float
$bMin : int|float
$bMax : int|float

Exceptions

Throws SetaPDF_Core_Type_Exception

setWhitePoint()

public SetaPDF_Core_ColorSpace_Lab::setWhitePoint (

int|float|int[] $x [, int|float $y = null [, int|float $z = null ]]

): void

Set the WhitePoint values.

Parameters

$x : int|float|int[]
$y : int|float
$z : int|float

Exceptions

Throws SetaPDF_Core_Exception

Throws SetaPDF_Core_Type_Exception