SetaPDF_Extractor_TextItem A text item.

File: /SetaPDF/Extractor/TextItem.php

Class hierarchy

Implements

Summary

Properties

$_baselineEnd

$_baselineStart

$_bounds

The bounds of this text item.

$_characterSpacing

The character spacing value.

$_end

The current transformation matrix when the text item ends.

$_filterId

protected null|string SetaPDF_Extractor_TextItem::$_filterId

The filter id which accepted this item.

$_font

The font object used by this text item.

$_fontSize

The font size.

$_no

protected string SetaPDF_Extractor_TextItem::$_no

An item identifier.

$_orientation

The orientation of this text item.

$_rawString

The raw PDF string.

$_scaling

The scaling value.

$_spaceWidth

The space width of the font used by this text item.

$_start

The current transformation matrix when the text item starts.

$_string

protected string[] SetaPDF_Extractor_TextItem::$_string = array()

The resulting string in a specific encoding.

$_ul

The upper left point/vector of this text item.

$_wordSpacing

The word spacing value.


Methods

__construct()

public SetaPDF_Extractor_TextItem::__construct ( $rawString $rawString, SetaPDF_Core_Font $font, $fontSize $fontSize, $characterSpacing $characterSpacing, $wordSpacing $wordSpacing, $scaling $scaling, SetaPDF_Core_Geometry_Matrix $start, SetaPDF_Core_Geometry_Matrix $end, $no $no )

The constructor.

Parameters
$rawString : $rawString
 
$font : SetaPDF_Core_Font
 
$fontSize : $fontSize
 
$characterSpacing : $characterSpacing
 
$wordSpacing : $wordSpacing
 
$scaling : $scaling
 
$start : SetaPDF_Core_Geometry_Matrix
 
$end : SetaPDF_Core_Geometry_Matrix
 
$no : $no
 

_getFontBBoxVector()

Get a font bounding box vector.

Parameters
$name : $name
 
Exceptions

Throws SetaPDF_Core_Exception

cleanUp()

public void SetaPDF_Extractor_TextItem::cleanUp ( void )

Release memory and cycled references

getBaseLineEnd()

Get the base line end vector.

getBaseLineStart()

Get the base line start vector.

getBounds()

Get the bounds of this text item.

getCharacterSpacing()

Get the character spacing.

The value is from the local graphic state and not a value in the user space.

getEndMatrix()

Get the transformation matrix which was defined after the text item was shown.

getFilterId()

public null|string SetaPDF_Extractor_TextItem::getFilterId ( void )

Get the filter id by which this item was accepted.

getFont()

Get the text items font object.

getFontSize()

Get the font size of this text item.

The value is from the local graphic state and not a value in the user space.

getLl()

Get the lower left vector.

getLr()

Get lower right vector.

getNo()

public string SetaPDF_Extractor_TextItem::getNo ( void )

Get the text item identification.

getOrientation()

Get the orientation of the text item.

getRawString()

Get the raw string.

getScaling()

public float SetaPDF_Extractor_TextItem::getScaling ( void )

Get the scaling value.

The value is from the local graphic state and not a value in the user space.

getStartMatrix()

Get the transformation matrix which was defined when the text item started.

getString()

public string SetaPDF_Extractor_TextItem::getString ( [ string $encoding = 'UTF-8' ] )

Get the string in a specific encoding.

Parameters
$encoding : string
 

getUl()

Get the upper left vector.

getUr()

Get the upper right vector.

getUserSpaceSpaceWidth()

Get the width of the space character in user space.

Exceptions

Throws SetaPDF_Core_Exception

getWordSpacing()

Get the word spcaing defined in its graphic state.

The value is from the local graphic state and not a value in the user space.

setFilterId()

public void SetaPDF_Extractor_TextItem::setFilterId ( string $filterId )

Sets the filter id by which this item was accepted.

Parameters
$filterId : string