Index

  1. \SetaPDF
    1. Core
    2. Core
      1. Canvas
      2. Canvas
        1. GraphicState
        2. GraphicState
          1. Text

SetaPDF_Core_Canvas_GraphicState_Text A class representing a text graphic state.

File: /SetaPDF v2/Core/Canvas/GraphicState/Text.php

Class hierarchy

Summary

Methods

Properties

Constants

Constants

CHARACTER_SPACING

public const string SetaPDF_Core_Canvas_GraphicState_Text::CHARACTER_SPACING = 'characterSpacing'

Data name constant

FONT

public const string SetaPDF_Core_Canvas_GraphicState_Text::FONT = 'font'

Data name constant

FONT_SIZE

public const string SetaPDF_Core_Canvas_GraphicState_Text::FONT_SIZE = 'fontSize'

Data name constant

LEADING

public const string SetaPDF_Core_Canvas_GraphicState_Text::LEADING = 'leading'

Data name constant

LINE_MATRIX

public const string SetaPDF_Core_Canvas_GraphicState_Text::LINE_MATRIX = 'lineMatrix'

Data name constant

RENDERING_MODE

public const string SetaPDF_Core_Canvas_GraphicState_Text::RENDERING_MODE = 'renderingMode'

Data name constant

RISE

public const string SetaPDF_Core_Canvas_GraphicState_Text::RISE = 'rise'

Data name constant

SCALING

public const string SetaPDF_Core_Canvas_GraphicState_Text::SCALING = 'scaling'

Data name constant

TEXT_MATRIX

public const string SetaPDF_Core_Canvas_GraphicState_Text::TEXT_MATRIX = 'textMatrix'

Data name constant

WORD_SPACING

public const string SetaPDF_Core_Canvas_GraphicState_Text::WORD_SPACING = 'wordSpacing'

Data name constant


Properties

$_callbacks

protected callback[] SetaPDF_Core_Canvas_GraphicState_Text::$_callbacks = array()

Callbacks which should be executed when a specific value is set.

$_data

protected array SetaPDF_Core_Canvas_GraphicState_Text::$_data = array()

The data of the text graphic state.

$_graphicState

protected SetaPDF_Core_Canvas_GraphicState SetaPDF_Core_Canvas_GraphicState_Text::$_graphicState

The main graphic state from which this text graphic state is inherited/created from.

$_stack

protected array SetaPDF_Core_Canvas_GraphicState_Text::$_stack

The graphic state instance of this text state.


Methods

__construct()

public SetaPDF_Core_Canvas_GraphicState_Text::__construct (
SetaPDF_Core_Canvas_GraphicState $graphicState, array &$stack
)

The constructor.

Parameters
$graphicState : SetaPDF_Core_Canvas_GraphicState
 
$stack : array

A reference to the graphic state stack array.

_getCurrent()

protected SetaPDF_Core_Canvas_GraphicState_Text::_getCurrent (
void
): mixed

Get the current state of the stack.

_getFontBBoxVector()

private SetaPDF_Core_Canvas_GraphicState_Text::_getFontBBoxVector (
int $index
): SetaPDF_Core_Geometry_Vector

Get a font bounding box vector.

Parameters
$index : int
 
Exceptions

Throws SetaPDF_Core_Exception

_getValue()

protected SetaPDF_Core_Canvas_GraphicState_Text::_getValue (
string $name, mixed $default
): mixed

Get a value by walking through the graphic stack.

Parameters
$name : string
 
$default : mixed
 

_setValue()

protected SetaPDF_Core_Canvas_GraphicState_Text::_setValue (
string $name, mixed $value
): void

Sets a value in the current graphic stack.

Parameters
$name : string
 
$value : mixed
 

_showText()

protected SetaPDF_Core_Canvas_GraphicState_Text::_showText (
string $text
): $this

Method that is invoked when a text should be shown.

Parameters
$text : string
 
Exceptions

Throws SetaPDF_Core_Exception

begin()

public SetaPDF_Core_Canvas_GraphicState_Text::begin (
void
): $this

Begins a text object in the graphic state.

cleanUp()

public SetaPDF_Core_Canvas_GraphicState_Text::cleanUp (
void
): void

Release cycled references.

end()

public SetaPDF_Core_Canvas_GraphicState_Text::end (
void
): $this

Ends a text object in the graphic state.

getBottomUserSpace()

public SetaPDF_Core_Canvas_GraphicState_Text::getBottomUserSpace (
void
): SetaPDF_Core_Geometry_Vector

Get the bottom bearing line value in user space coordinate system.

Exceptions

Throws SetaPDF_Core_Exception

getCharacterSpacing()

public SetaPDF_Core_Canvas_GraphicState_Text::getCharacterSpacing (
void
): integer|float

Gets the current character spacing value.

getFont()

public SetaPDF_Core_Canvas_GraphicState_Text::getFont (
void
): SetaPDF_Core_Font_FontInterface|boolean

Gets the current font instance.

getFontSize()

public SetaPDF_Core_Canvas_GraphicState_Text::getFontSize (
void
): float|boolean

Gets the current font size.

getLeading()

public SetaPDF_Core_Canvas_GraphicState_Text::getLeading (
void
): mixed

Gets the current leading value.

getLineMatrix()

public SetaPDF_Core_Canvas_GraphicState_Text::getLineMatrix (
void
): null|SetaPDF_Core_Geometry_Matrix

Gets the current line transformation matrix.

Exceptions

Throws BadMethodCallException

getRenderingMode()

public SetaPDF_Core_Canvas_GraphicState_Text::getRenderingMode (
void
): integer

Get the current rendering mode value.

getRise()

public SetaPDF_Core_Canvas_GraphicState_Text::getRise (
void
): float|integer

Gets the current text rise value.

getScaling()

public SetaPDF_Core_Canvas_GraphicState_Text::getScaling (
void
): mixed

Gets the current scaling value.

getTextMatrix()

public SetaPDF_Core_Canvas_GraphicState_Text::getTextMatrix (
void
): SetaPDF_Core_Geometry_Matrix

Gets the current text transformation matrix.

Exceptions

Throws BadMethodCallException

getTopUserSpace()

public SetaPDF_Core_Canvas_GraphicState_Text::getTopUserSpace (
void
): SetaPDF_Core_Geometry_Vector

Get the top bearing line value in user space coordinate system.

Exceptions

Throws SetaPDF_Core_Exception

getWordSpacing()

public SetaPDF_Core_Canvas_GraphicState_Text::getWordSpacing (
void
): integer|float

Gets the current word spacing value.

moveToNextLine()

public SetaPDF_Core_Canvas_GraphicState_Text::moveToNextLine (
float $x, float $y [, bool $setLeading = false ]
): $this

Move to the next line.

The "'" operator.

Parameters
$x : float
 
$y : float
 
$setLeading : bool
 

moveToNextLineAndShowText()

public SetaPDF_Core_Canvas_GraphicState_Text::moveToNextLineAndShowText (
string $text [, float|null $wordSpacing = null [, float|null $charSpacing = null ]]
): $this

Moves to the start of the next line and shows a text string.

Parameters
$text : string
 
$wordSpacing : float|null
 
$charSpacing : float|null
 
Exceptions

Throws SetaPDF_Core_Exception

moveToStartOfNextLine()

public SetaPDF_Core_Canvas_GraphicState_Text::moveToStartOfNextLine (
void
): SetaPDF_Core_Canvas_GraphicState_Text

Move to the start of the next line.

The "T*" operator.

registerCallback()

public SetaPDF_Core_Canvas_GraphicState_Text::registerCallback (
string $valueName, callback $callback
): void

Registers a callback that should be executed if a specifc value is set.

Parameters
$valueName : string
 
$callback : callback
 

setCharacterSpacing()

public SetaPDF_Core_Canvas_GraphicState_Text::setCharacterSpacing (
float $characterSpacing
): $this

Sets the current character spacing value.

Parameters
$characterSpacing : float
 

setFont()

public SetaPDF_Core_Canvas_GraphicState_Text::setFont (
SetaPDF_Core_Font_FontInterface $font, float $size
): $this

Sets the current font and size.

Parameters
$font : SetaPDF_Core_Font_FontInterface
 
$size : float
 

setLeading()

public SetaPDF_Core_Canvas_GraphicState_Text::setLeading (
float $leading
): $this

Sets the current leading value.

Parameters
$leading : float
 

setLineMatrix()

public SetaPDF_Core_Canvas_GraphicState_Text::setLineMatrix (
float|SetaPDF_Core_Geometry_Matrix $aOrMatrix [, float|null $b = null [, float|null $c = null [, float|null $d = null [, float|null $e = null [, float|null $f = null ]]]]]
): $this

Sets the current line matrix.

Parameters
$aOrMatrix : float|SetaPDF_Core_Geometry_Matrix
 
$b : float|null
 
$c : float|null
 
$d : float|null
 
$e : float|null
 
$f : float|null
 

setRenderingMode()

public SetaPDF_Core_Canvas_GraphicState_Text::setRenderingMode (
integer $renderingMode
): $this

Sets the current rendering mode.

Parameters
$renderingMode : integer
 

setRise()

public SetaPDF_Core_Canvas_GraphicState_Text::setRise (
float $rise
): $this

Sets the text rise value.

Parameters
$rise : float
 

setScaling()

public SetaPDF_Core_Canvas_GraphicState_Text::setScaling (
float $scaleing
): $this

Sets the current scaling value.

Parameters
$scaleing : float
 

setTextMatrix()

public SetaPDF_Core_Canvas_GraphicState_Text::setTextMatrix (
float|SetaPDF_Core_Geometry_Matrix $aOrMatrix [, float|null $b = null [, float|null $c = null [, float|null $d = null [, float|null $e = null [, float|null $f = null ]]]]]
): $this

Sets the current text matrix.

Parameters
$aOrMatrix : float|SetaPDF_Core_Geometry_Matrix
 
$b : float|null
 
$c : float|null
 
$d : float|null
 
$e : float|null
 
$f : float|null
 

setWordSpacing()

public SetaPDF_Core_Canvas_GraphicState_Text::setWordSpacing (
float $wordSpacing
): $this

Sets the current word spacing value.

Parameters
$wordSpacing : float
 

showText()

public SetaPDF_Core_Canvas_GraphicState_Text::showText (
string $text
): SetaPDF_Core_Canvas_GraphicState_Text

Shows a text string.

Parameters
$text : string
 
Exceptions

Throws SetaPDF_Core_Exception

showTextStrings()

public SetaPDF_Core_Canvas_GraphicState_Text::showTextStrings (
string|string[] $textStrings
): void

Shows text strings.

Parameters
$textStrings : string|string[]
 
Exceptions

Throws SetaPDF_Core_Exception

toTextSpace()

public SetaPDF_Core_Canvas_GraphicState_Text::toTextSpace (
[ SetaPDF_Core_Geometry_Vector $vector = null ]
): SetaPDF_Core_Geometry_Vector

Converts a vectors values to the text space coordinate system.

Parameters
$vector : SetaPDF_Core_Geometry_Vector
 

toUserSpace()

public SetaPDF_Core_Canvas_GraphicState_Text::toUserSpace (
[ SetaPDF_Core_Geometry_Vector $vector = null ]
): SetaPDF_Core_Geometry_Vector

Converts a vectors values to the user space coordinate system.

Parameters
$vector : SetaPDF_Core_Geometry_Vector
 

unregisterCallback()

public SetaPDF_Core_Canvas_GraphicState_Text::unregisterCallback (
string $valueName
): void

Un-registers a callback.

Parameters
$valueName : string
 
See

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