PdfConfigurator<T, D> class abstract

Inheritance

• Object
• Converter<T, D>
• ConverterConfigurator<T, D>
• PdfConfigurator

Implemented types

• AttrInlineFunctions<List<InlineSpan>, TextStyle?>
• AttrBlockFunctions<Widget, TextStyle?>
• DocumentFunctions<Delta, List<String>, List<Widget>>

Implementers

• PdfService

Constructors

PdfConfigurator({required Future<Font> onRequestBoldFont(String fontFamily), required Future<Font> onRequestBothFont(String fontFamily), required Future<List<Font>?> onRequestFallbacks(String fontFamily)?, required Future<Font> onRequestFont(String fontFamily), required Future<Font> onRequestItalicFont(String fontFamily), required List<CustomConverter> customConverters, required T document, double? blockQuotePaddingLeft, double? blockQuotePaddingRight, double? blockQuotethicknessDividerColor, PdfColor? blockQuoteBackgroundColor, PdfColor? codeBlockBackgroundColor, TextStyle? codeBlockNumLinesTextStyle, TextStyle? codeBlockTextStyle, PdfColor? blockQuoteDividerColor, TextStyle? blockQuoteTextStyle, Font? codeBlockFont, CustomPDFWidget? onDetectBlockquote, CustomPDFWidget? onDetectCodeBlock, CustomPDFWidget? onDetectAlignedParagraph, CustomPDFWidget? onDetectCommonText, CustomPDFWidget? onDetectHeaderAlignedBlock, CustomPDFWidget? onDetectHeaderBlock, CustomPDFWidget? onDetectInlinesMarkdown, CustomPDFWidget? onDetectLink, CustomPDFWidget? onDetectList, CustomPDFWidget? onDetectInlineRichTextStyles, CustomPDFWidget? onDetectImageBlock, Delta? backM, Delta? frontM})

Properties

backM → Delta?

final

blockQuoteBackgroundColor → PdfColor?

final

blockQuoteDividerColor → PdfColor?

final

blockQuotePaddingLeft → double?

final

blockQuotePaddingRight → double?

final

blockQuoteTextStyle → TextStyle?

final

blockQuotethicknessDividerColor → double?

final

codeBlockBackgroundColor → PdfColor?

final

codeBlockFont → Font?

final

codeBlockNumLinesTextStyle → TextStyle?

final

codeBlockTextStyle → TextStyle?

final

customConverters → List<CustomConverter>

final

defaultFontSize → int

final

defaultLinkColor ↔ PdfColor

late, final

defaultTextStyle ↔ TextStyle

late, final

defaultTheme ↔ ThemeData

late, final

document → T

no setter, inherited

frontM → Delta?

final

hashCode → int

The hash code for this object.

no setter, inherited

onDetectAlignedParagraph → CustomPDFWidget?

final

onDetectBlockquote → CustomPDFWidget?

final

onDetectCodeBlock → CustomPDFWidget?

final

onDetectCommonText → CustomPDFWidget?

final

onDetectHeaderAlignedBlock → CustomPDFWidget?

final

onDetectHeaderBlock → CustomPDFWidget?

final

onDetectImageBlock → CustomPDFWidget?

final

onDetectInlineRichTextStyles → CustomPDFWidget?

final

onDetectInlinesMarkdown → CustomPDFWidget?

final

onDetectLink → CustomPDFWidget?

final

onDetectList → CustomPDFWidget?

final

onRequestBoldFont → Future<Font> Function(String fontFamily)

final

onRequestBothFont → Future<Font> Function(String fontFamily)

final

onRequestFallbacks → (Future<List<Font>?> Function(String fontFamily)?)

final

onRequestFont → Future<Font> Function(String fontFamily)

final

onRequestItalicFont → Future<Font> Function(String fontFamily)

final

pageHeight ↔ double

late, final

pageWidth ↔ double

late, final

rules → List<Rule>

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

applyInlineStyles(String line, [TextStyle? style, bool addFontSize = true]) → Future<List<TextSpan>>

blockGenerators(List<String> lines) → Future<List<Widget>>

This function generate widgets to create a book with custom views of the content

inherited

customRules(List<Rule> customRules, {bool clearDefaultRules = false}) → void

This fuction let us add new rules as we wants. We can clear the default rules, or just write our rules. You can check html2md documentation about here: https://github.com/jarontai/html2md

inherited

generateDoc() → Future<D>

This functions generates the document

inherited

generatePages({required List<Delta> documents}) → Future<List<Map<String, dynamic>>>

This function create a (valid) file transforming delta format to markdown and detecting all markdown syntax for put the attributes to the paragraph

inherited

getAlignedHeaderBlock(String line, [TextStyle? style]) → Future<List<Widget>>

override

getAlignedParagraphBlock(String line, [TextStyle? style]) → Future<List<Widget>>

override

getBlockQuote(String line, [TextStyle? style]) → Future<List<Widget>>

override

getCodeBlock(String line, [TextStyle? style]) → Future<List<Widget>>

override

getHeaderBlock(String line, [TextStyle? style]) → Future<Widget>

override

getImageBlock(String line, [Alignment? alignment]) → Future<Widget?>

override

getInlineStyles(String line, [TextStyle? style]) → Future<List<TextSpan>>

override

getLinkStyle(String line, [TextStyle? style, bool addFontSize = true]) → Future<List<TextSpan>>

override

getListBlock(String line, bool isCheckList, [TextStyle? style]) → Future<Widget>

override

getNewLinesWithSpacing(String line, [TextStyle? style]) → Future<List<TextSpan>>

getRichTextInlineStyles(String line, [TextStyle? style, bool returnContentIfNeedIt = false, bool addFontSize = true]) → Future<List<InlineSpan>>

override

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