HintStream
extends PdfStream
in package
Primary hint stream — ISO 32000-2 §F.3.1.
A stream whose dictionary contains hint-table offsets (P, S, T, O, A, E, V, I, C, L, R, B) pointing into the body of the stream. Used by linearized PDFs to speed up progressive rendering.
Object-model only; not emitted by PdfWriter.
Table of Contents
Properties
- $a : int|null
- $b : int|null
- $c : int|null
- $data : string
- $dictionary : PdfDictionary
- $e : int|null
- $generationNumber : int
- $i : int|null
- $l : int|null
- $o : int|null
- $objectNumber : int
- $p : int|null
- $r : int|null
- $s : int|null
- $t : int|null
- $v : int|null
Methods
- __construct() : mixed
- setFilter() : void
- Set a filter to encode/decode the stream data.
- toIndirectObject() : string
- Wrap the object in an indirect object structure: X Y obj ... endobj
- toPdf() : string
- Returns the stream body: dictionary, stream keyword, data, endstream.
Properties
$a
public
int|null
$a
= null
$b
public
int|null
$b
= null
$c
public
int|null
$c
= null
$data
public
string
$data
= ''
$dictionary
public
PdfDictionary
$dictionary
$e
public
int|null
$e
= null
$generationNumber
public
int
$generationNumber
= 0
$i
public
int|null
$i
= null
$l
public
int|null
$l
= null
$o
public
int|null
$o
= null
$objectNumber
public
int
$objectNumber
= 0
$p
public
int|null
$p
= null
$r
public
int|null
$r
= null
$s
public
int|null
$s
= null
$t
public
int|null
$t
= null
$v
public
int|null
$v
= null
Methods
__construct()
public
__construct([string $data = '' ]) : mixed
Parameters
- $data : string = ''
setFilter()
Set a filter to encode/decode the stream data.
public
setFilter(FilterInterface $filter, string $pdfFilterName) : void
Parameters
- $filter : FilterInterface
-
The filter implementation
- $pdfFilterName : string
-
The PDF filter name (e.g. 'FlateDecode', 'ASCII85Decode')
toIndirectObject()
Wrap the object in an indirect object structure: X Y obj ... endobj
public
toIndirectObject() : string
Return values
stringtoPdf()
Returns the stream body: dictionary, stream keyword, data, endstream.
public
toPdf() : string
/Length is injected into the dictionary at serialization time. If a filter is set, the data is encoded before writing.