SetaPDF_Core_Resource_ExtGState Resource class for handling external graphic states

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

Class hierarchy

Implements

Summary

Constants

TYPE_COLOR_SPACE

TYPE_EXT_G_STATE

TYPE_FONT

TYPE_PATTERN

TYPE_PROC_SET

TYPE_PROPERTIES

TYPE_SHADING

TYPE_X_OBJECT


Properties

$_dictionary

The graphics state parameter dictionary

$_indirectObject


Static Methods

createExtGStateDictionary()

static public SetaPDF_Core_Type_Dictionary SetaPDF_Core_Resource_ExtGState::createExtGStateDictionary ( void )

Creates a graphics state parameter dictionary.


Methods

__construct()

public SetaPDF_Core_Resource_ExtGState::__construct ( [ SetaPDF_Core_Type_IndirectObjectInterface|SetaPDF_Core_Type_Dictionary|string $extGStateDictionary = null ] )

The constructor.

Parameters
$extGStateDictionary : SetaPDF_Core_Type_IndirectObjectInterface|SetaPDF_Core_Type_Dictionary|string
 
Exceptions

Throws InvalidArgumentException

See

_setBoolean()

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

Sets the boolean $value on the offset $name.

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

_setName()

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

Sets the name $value on the offset $name.

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

_setNumeric()

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

Sets the numeric $value on the offset $name.

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

getDictionary()

public SetaPDF_Core_Type_Dictionary SetaPDF_Core_Resource_ExtGState::getDictionary ( void )

Get the graphics state parameter dictionary.

getIndirectObject()

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

Gets an indirect object for this graphics state parameter dictionary.

Parameters
$document : SetaPDF_Core_Document|null
 
Exceptions

Throws InvalidArgumentException

See

getResourceType()

public string SetaPDF_Core_Resource_ExtGState::getResourceType ( void )

Returns the resource type for the graphic state.

See

setBlendMode()

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

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

Parameters
$blendMode : null|string|SetaPDF_Core_Type_Name

Implement handling of an array parameter

See
  • PDF 32000-1:2008 - 11.3.5, "Blend Mode" and 11.6.3, "Specifying Blending Colour Space and Blend Mode"

setConstantOpacity()

public void SetaPDF_Core_Resource_ExtGState::setConstantOpacity ( float $opacity )

Set the current stroking alpha constant.

Parameters
$opacity : float
 

setConstantOpacityNonStroking()

public void SetaPDF_Core_Resource_ExtGState::setConstantOpacityNonStroking ( float $opacity )

Set the current non-stroking alpha constant.

Parameters
$opacity : float
 

setLineCapStyle()

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

Set the line cap style.

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

setLineJoinStyle()

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

Set the line join style.

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

setLineWidth()

public void SetaPDF_Core_Resource_ExtGState::setLineWidth ( float $lineWidth )

Set the line width.

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

setMiterLimit()

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

Set the miter limit.

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

setOverprintControl()

public void SetaPDF_Core_Resource_ExtGState::setOverprintControl ( boolean $overprintControl )

Set the flag specifying whether to apply overprint.

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

setOverprintControlNonStroking()

public void SetaPDF_Core_Resource_ExtGState::setOverprintControlNonStroking ( boolean $overprintControl )

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 void SetaPDF_Core_Resource_ExtGState::setOverprintMode ( integer $overprintMode )

Set the overprint mode.

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

setRenderingIntent()

public void SetaPDF_Core_Resource_ExtGState::setRenderingIntent ( string $renderingIntent )

Set the name of the rendering intent.

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