Index

  1. \SetaPDF
    1. Core
    2. Core
      1. Resource
      2. Resource
        1. ExtGState
        2. PropertyList

SetaPDF_Core_Resource_ExtGState Resource class for handling external graphic states

File: /SetaPDF v2/Core/Resource/ExtGState.php

Class hierarchy

Implements

Summary

Static Methods

Methods

Properties

Constants

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

$_dictionary

protected SetaPDF_Core_Type_Dictionary SetaPDF_Core_Resource_ExtGState::$_dictionary

The graphics state parameter dictionary

$_indirectObject

protected SetaPDF_Core_Type_IndirectObjectInterface SetaPDF_Core_Resource_ExtGState::$_indirectObject

The indirect object for this graphic state


Static Methods

createExtGStateDictionary()

public static SetaPDF_Core_Resource_ExtGState::createExtGStateDictionary (
void
): SetaPDF_Core_Type_Dictionary

Creates a graphics state parameter dictionary.


Methods

__construct()

public SetaPDF_Core_Resource_ExtGState::__construct ()

The constructor.

Parameters
$extGStateDictionary : SetaPDF_Core_Type_IndirectObjectInterface|SetaPDF_Core_Type_Dictionary|string
 
Exceptions

Throws InvalidArgumentException

See

_setBoolean()

protected SetaPDF_Core_Resource_ExtGState::_setBoolean (
null|string|SetaPDF_Core_Type_Name $name, string $value
): void

Sets the boolean $value on the offset $name.

Parameters
$name : null|string|SetaPDF_Core_Type_Name
 
$value : string
 

_setName()

protected SetaPDF_Core_Resource_ExtGState::_setName (
null|string|SetaPDF_Core_Type_Name $name, string $value
): void

Sets the name $value on the offset $name.

Parameters
$name : null|string|SetaPDF_Core_Type_Name
 
$value : string
 

_setNumeric()

protected SetaPDF_Core_Resource_ExtGState::_setNumeric (
null|string|SetaPDF_Core_Type_Name $name, int|float $value
): void

Sets the numeric $value on the offset $name.

Parameters
$name : null|string|SetaPDF_Core_Type_Name
 
$value : int|float
 

getDictionary()

public SetaPDF_Core_Resource_ExtGState::getDictionary (
void
): SetaPDF_Core_Type_Dictionary

Get the graphics state parameter dictionary.

getIndirectObject()

public SetaPDF_Core_Resource_ExtGState::getIndirectObject (
[ SetaPDF_Core_Document|null $document = null ]
): SetaPDF_Core_Type_IndirectObjectInterface

Gets an indirect object for this graphics state parameter dictionary.

Parameters
$document : SetaPDF_Core_Document|null
 
Exceptions

Throws InvalidArgumentException

See

getResourceType()

public SetaPDF_Core_Resource_ExtGState::getResourceType (
void
): string

Returns the resource type for the graphic state.

See

setBlendMode()

public SetaPDF_Core_Resource_ExtGState::setBlendMode (
null|string|SetaPDF_Core_Type_Name $blendMode
): void

Set the blend mode to be used in transparent image model.

Parameters
$blendMode : null|string|SetaPDF_Core_Type_Name
 
See
  • PDF 32000-1:2008 - 11.3.5, "Blend Mode" and 11.6.3, "Specifying Blending Colour Space and Blend Mode"

setConstantOpacity()

public SetaPDF_Core_Resource_ExtGState::setConstantOpacity (
float $opacity
): void

Set the current stroking alpha constant.

Parameters
$opacity : float
 

setConstantOpacityNonStroking()

public SetaPDF_Core_Resource_ExtGState::setConstantOpacityNonStroking (
float $opacity
): void

Set the current non-stroking alpha constant.

Parameters
$opacity : float
 

setLineCapStyle()

public SetaPDF_Core_Resource_ExtGState::setLineCapStyle (
int|float $lineCapStyle
): void

Set the line cap style.

Parameters
$lineCapStyle : int|float
 
See
  • PDF 32000-1:2008 - 8.4.3.3, "Line Cap Style"

setLineJoinStyle()

public SetaPDF_Core_Resource_ExtGState::setLineJoinStyle (
int|float $lineJoinStyle
): void

Set the line join style.

Parameters
$lineJoinStyle : int|float
 
See
  • PDF 32000-1:2008 - 8.4.3.4, "Line Join Style"

setLineWidth()

public SetaPDF_Core_Resource_ExtGState::setLineWidth (
float $lineWidth
): void

Set the line width.

Parameters
$lineWidth : float
 
See
  • PDF 32000-1:2008 - 8.4.3.2, "Line Width"

setMiterLimit()

public SetaPDF_Core_Resource_ExtGState::setMiterLimit (
int|float $miterLimit
): void

Set the miter limit.

Parameters
$miterLimit : int|float
 
See
  • PDF 32000-1:2008 - 8.4.3.5, "Miter Limit"

setOverprintControl()

public SetaPDF_Core_Resource_ExtGState::setOverprintControl (
boolean $overprintControl
): void

Set the flag specifying whether to apply overprint.

Parameters
$overprintControl : boolean
 
See
  • PDF 32000-1:2008 - 8.6.7, "Overprint Control"

setOverprintControlNonStroking()

public SetaPDF_Core_Resource_ExtGState::setOverprintControlNonStroking (
boolean $overprintControl
): void

Set the flag specifying whether to apply overprint for non-stroking operations.

Parameters
$overprintControl : boolean
 
See
  • PDF 32000-1:2008 - 8.6.7, "Overprint Control"

setOverprintMode()

public SetaPDF_Core_Resource_ExtGState::setOverprintMode (
integer $overprintMode
): void

Set the overprint mode.

Parameters
$overprintMode : integer
 
See
  • PDF 32000-1:2008 - 8.6.7, "Overprint Control"

setRenderingIntent()

public SetaPDF_Core_Resource_ExtGState::setRenderingIntent (
string $renderingIntent
): void

Set the name of the rendering intent.

Parameters
$renderingIntent : string
 
See
  • PDF 32000-1:2008 - 8.6.5.8, "Rendering Intents"

© 2024 Setasign GmbH & Co. KG · Contact / Imprint · Data Privacy Statement (German)