PdfOutline class Null safety

Pdf Outline object

Constructors

PdfOutline(PdfDocument pdfDocument, {String? title, PdfPage? dest, PdfRect? rect, String? anchor, PdfColor? color, PdfOutlineMode destMode = PdfOutlineMode.fitPage, PdfOutlineStyle style = PdfOutlineStyle.normal, int? page})
Constructs a Pdf Outline object. When selected, the specified region is displayed.

Properties

anchor String?
Named destination
final
color PdfColor?
Color of the outline text
final
dest PdfPage?
The destination page
read / write
destMode PdfOutlineMode
How the destination is handled
final
effectiveLevel int?
External level for this outline
read / write
hashCode int
The hash code for this object. [...]
read-only, inherited
objgen int
This is the generation number for this object.
final, inherited
objser int
This is the unique serial number for this object.
final, inherited
outlines List<PdfOutline>
This holds any outlines below us
read / write
page int?
Page number
read-only
params → PdfDict<PdfDataType>
This is the object parameters.
final, inherited
parent PdfOutline?
For subentries, this points to it's parent outline
read / write
pdfDocument PdfDocument
This allows any Pdf object to refer to the document being constructed.
final, inherited
rect PdfRect?
The region on the destination page
final
runtimeType Type
A representation of the runtime type of the object.
read-only, inherited
style PdfOutlineStyle
How to display the outline text
final
title String?
This is this outlines Title
final

Methods

add(PdfOutline outline) → void
This method creates an outline, and attaches it to this one. When the outline is selected, the supplied region is displayed.
descendants() int
Returns the total number of descendants below this one.
getIndex(PdfOutline outline) int
This is called by children to find their position in this outlines tree.
getLast() int
Returns the last index in this outline
getNode(int i) PdfOutline
Returns the outline at a specified position.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
inherited
prepare() → void
Prepare the object to be written to the stream
ref() → PdfIndirect
Returns the unique serial number in Pdf format
inherited
toString() String
A string representation of this object. [...]
write(PdfStream os) → void
Writes the object to the output stream.
inherited
writeContent(PdfStream os) → void
inherited

Operators

operator ==(Object other) bool
The equality operator. [...]
inherited