PdfFooterConfig class
Configuration for the PDF footer section.
The footer appears at the bottom of each page and can include:
- Custom text on the left side
- Page numbers on the right side (Page X of Y)
Constructors
-
Creates a new footer configuration.
const
-
Creates a disabled footer configuration.
const
Properties
- dividerColor → PdfColor?
-
The color of the divider line.
final
- dividerThickness → double
-
The thickness of the divider line.
final
- enabled → bool
-
Whether the footer is enabled.
final
- fontSize → double
-
Font size for the footer text.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- hasLeftText → bool
-
Whether custom left text is configured.
no setter
- leftText → String?
-
Custom text to display on the left side of the footer.
final
- pageNumberFormat → String
-
The format for page numbers. Use {page} and {total} as placeholders.
Default: "Página {page} de {total}"
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- showDivider → bool
-
Whether to show a divider line above the footer.
final
- showPageNumbers → bool
-
Whether to show page numbers.
final
- textColor → PdfColor?
-
Color for the footer text.
final
- topPadding → double
-
Padding above the footer.
final
Methods
-
copyWith(
{bool? enabled, String? leftText, bool? showPageNumbers, String? pageNumberFormat, double? fontSize, PdfColor? textColor, bool? showDivider, PdfColor? dividerColor, double? dividerThickness, double? topPadding}) → PdfFooterConfig - Creates a copy with modified properties.
-
formatPageNumber(
int page, int total) → String - Formats the page number string with actual values.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited