class final Core · roukmoute/pdf 0.6.2
PDF\Document\Navigation\PageLabelsExplicit ranges and real NumberTree, validated against the actual catalogue pages.Inheritance and contracts
Parent : PDF\Syntax\Object\DictionaryType
Interfaces : Countable, IteratorAggregate, PDF\Syntax\FileStructure\BasicType, Stringable, Traversable
Construction
__construct()
public function __construct(PDF\Document\Navigation\LabelRange ...$ranges)Declared methods
catalogEntry()
public function catalogEntry(): PDF\Syntax\Object\DictionaryObject\Entryentries()
public function entries(): iterablelabel()
public function label(PDF\Syntax\Object\IntegerType $pageIndex, PDF\Document\Navigation\NavigationLimits $limits = new NavigationLimits()): PDF\Syntax\DataStructure\TextStringlabelsFor()
public function labelsFor(PDF\Syntax\Object\DictionaryType $catalog, PDF\Document\Navigation\NavigationLimits $limits = new NavigationLimits()): array@return list<TextString>validateCatalog()
public function validateCatalog(PDF\Syntax\Object\DictionaryType $catalog): voidwith()
public function with(PDF\Syntax\Object\DictionaryObject\Entry $entry): staticwithout()
public function without(PDF\Syntax\Object\NameType|string $key): staticInherited methods
6 methods from parents and contracts
__toString()
public function __toString(): stringcount()
public function count(): intget()
public function get(PDF\Syntax\Object\NameType|string $key): ?PDF\Syntax\FileStructure\BasicTypegetIterator()
public function getIterator(): Traversablehas()
public function has(PDF\Syntax\Object\NameType|string $key): booltoPdf()
public function toPdf(PDF\Serialization\SerializationContext $context): stringProperties
| Declaration | Origin and documentation |
|---|---|
public readonly array $ranges | PDF\Document\Navigation\PageLabels@var non-empty-list<LabelRange> |
public readonly PDF\Syntax\DataStructure\NumberTree $tree | PDF\Document\Navigation\PageLabels |