class final Core · roukmoute/pdf 0.6.1

PDF\Document\OutlineItem
Outline item; parent and sibling links are generated from its hierarchy.

Read the source declaration ↗

Inheritance and contracts

Parent : PDF\Syntax\Object\DictionaryType

Interfaces : Countable, IteratorAggregate, PDF\Document\OutlineParent, PDF\Syntax\FileStructure\BasicType, Stringable, Traversable

Construction

__construct()

public function __construct(PDF\Syntax\DataStructure\TextString $title, PDF\Document\Destinations\Destination|PDF\Syntax\Object\DictionaryType|null $destinationOrAction = null, bool $expanded = true, PDF\Syntax\Object\DictionaryObject\Entry ...$entries)

Declared by PDF\Document\OutlineItem · View the code ↗

Declared methods

addItem()

public function addItem(self $item): self

Declared by PDF\Document\OutlineItem · View the code ↗

attachTo()

public function attachTo(PDF\Document\OutlineParent $parent): void
@internal Attach through addItem().

Declared by PDF\Document\OutlineItem · View the code ↗

entries()

public function entries(): iterable

Declared by PDF\Document\OutlineItem · View the code ↗

items()

public function items(): array

Declared by PDF\Document\OutlineItem · View the code ↗

visibleDescendantCount()

public function visibleDescendantCount(): int

Declared by PDF\Document\OutlineItem · View the code ↗

with()

public function with(PDF\Syntax\Object\DictionaryObject\Entry $entry): static

Declared by PDF\Document\OutlineItem · View the code ↗

without()

public function without(PDF\Syntax\Object\NameType|string $key): static

Declared by PDF\Document\OutlineItem · View the code ↗

Inherited methods

6 methods from parents and contracts

__toString()

public function __toString(): string

Declared by PDF\Syntax\Object\DictionaryType · View the code ↗

count()

public function count(): int

Declared by PDF\Syntax\Object\DictionaryType · View the code ↗

get()

Declared by PDF\Syntax\Object\DictionaryType · View the code ↗

getIterator()

public function getIterator(): Traversable

Declared by PDF\Syntax\Object\DictionaryType · View the code ↗

has()

public function has(PDF\Syntax\Object\NameType|string $key): bool

Declared by PDF\Syntax\Object\DictionaryType · View the code ↗

toPdf()

public function toPdf(PDF\Serialization\SerializationContext $context): string

Declared by PDF\Syntax\Object\DictionaryType · View the code ↗

Properties

DeclarationOrigin and documentation
public readonly bool $expandedPDF\Document\OutlineItem