PdfLocale enum

Optional configuration for the PDF annotation editor.

Pass an instance to any FlutterPdfAnnotations method via the config parameter to pre-configure the editor's initial state.

FlutterPdfAnnotations.openPDF(
  filePath: path,
  config: PDFAnnotationConfig(
    title: 'Review Contract',
    initialPenColor: Colors.red,
    initialHighlightColor: Colors.yellow.withOpacity(0.5),
    initialStrokeWidth: 3.0,
  ),
);

Language used for the native annotation editor UI.

Pass to PDFAnnotationConfig.locale. When omitted the device locale is used, falling back to PdfLocale.english for unsupported languages.

Inheritance

• Object
• Enum
• PdfLocale

Available extensions

• EnumName

Values

english → const PdfLocale

const PdfLocale('en')

arabic → const PdfLocale

const PdfLocale('ar')

spanish → const PdfLocale

const PdfLocale('es')

portuguese → const PdfLocale

const PdfLocale('pt')

Properties

code → String

BCP-47 language tag sent to the native side.

final

hashCode → int

The hash code for this object.

no setter, inherited

index → int

A numeric identifier for the enumerated value.

no setter, inherited

name → String

Available on Enum, provided by the EnumName extension

The name of the enum value.

no setter

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

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

Constants

values → const List<PdfLocale>

A constant List of the values in this enum, in order of their declaration.