PaintingEditor class

A StatefulWidget that represents an image editor with painting capabilities.

Inheritance

Constructors

PaintingEditor.asset(String assetPath, {Key? key, required ThemeData theme, I18n i18n = const I18n(), ImageEditorCustomWidgets customWidgets = const ImageEditorCustomWidgets(), ImageEditorIcons icons = const ImageEditorIcons(), ImageEditorDesignModeE designMode = ImageEditorDesignModeE.material, ImageEditorTheme imageEditorTheme = const ImageEditorTheme(), PaintEditorConfigs configs = const PaintEditorConfigs(), required Size imageSize, List<Layer>? layers, EdgeInsets? paddingHelper, double layerFontSize = 24.0, TextStyle emojiTextStyle = const TextStyle()})
Constructor for loading image from assetPath.
factory
PaintingEditor.autoSource({Key? key, required ThemeData theme, I18n i18n = const I18n(), ImageEditorCustomWidgets customWidgets = const ImageEditorCustomWidgets(), ImageEditorIcons icons = const ImageEditorIcons(), ImageEditorDesignModeE designMode = ImageEditorDesignModeE.material, ImageEditorTheme imageEditorTheme = const ImageEditorTheme(), PaintEditorConfigs configs = const PaintEditorConfigs(), required Size imageSize, Uint8List? byteArray, File? file, String? assetPath, String? networkUrl, List<Layer>? layers, EdgeInsets? paddingHelper, double layerFontSize = 24.0, TextStyle emojiTextStyle = const TextStyle()})
Constructor for automatic source selection based on properties
factory
PaintingEditor.file(File file, {Key? key, required ThemeData theme, I18n i18n = const I18n(), ImageEditorCustomWidgets customWidgets = const ImageEditorCustomWidgets(), ImageEditorIcons icons = const ImageEditorIcons(), ImageEditorDesignModeE designMode = ImageEditorDesignModeE.material, ImageEditorTheme imageEditorTheme = const ImageEditorTheme(), PaintEditorConfigs configs = const PaintEditorConfigs(), required Size imageSize, List<Layer>? layers, EdgeInsets? paddingHelper, double layerFontSize = 24.0, TextStyle emojiTextStyle = const TextStyle()})
Constructor for loading image from File.
factory
PaintingEditor.memory(Uint8List byteArray, {Key? key, required ThemeData theme, I18n i18n = const I18n(), ImageEditorCustomWidgets customWidgets = const ImageEditorCustomWidgets(), ImageEditorIcons icons = const ImageEditorIcons(), ImageEditorDesignModeE designMode = ImageEditorDesignModeE.material, ImageEditorTheme imageEditorTheme = const ImageEditorTheme(), PaintEditorConfigs configs = const PaintEditorConfigs(), required Size imageSize, List<Layer>? layers, EdgeInsets? paddingHelper, double layerFontSize = 24.0, TextStyle emojiTextStyle = const TextStyle()})
Constructor for loading image from memory.
factory
PaintingEditor.network(String networkUrl, {Key? key, required ThemeData theme, I18n i18n = const I18n(), ImageEditorCustomWidgets customWidgets = const ImageEditorCustomWidgets(), ImageEditorIcons icons = const ImageEditorIcons(), ImageEditorDesignModeE designMode = ImageEditorDesignModeE.material, ImageEditorTheme imageEditorTheme = const ImageEditorTheme(), PaintEditorConfigs configs = const PaintEditorConfigs(), required Size imageSize, List<Layer>? layers, EdgeInsets? paddingHelper, double layerFontSize = 24.0, TextStyle emojiTextStyle = const TextStyle()})
Constructor for loading image from network url.
factory

Properties

assetPath → String?
The asset path of the image.
final
byteArray → Uint8List?
A Uint8List representing the image data in memory.
final
configs → PaintEditorConfigs
Configuration options for the painting editor.
final
customWidgets → ImageEditorCustomWidgets
Custom widget overrides for the editor.
final
designMode → ImageEditorDesignModeE
The design mode of the editor (e.g., material or custom).
final
emojiTextStyle → TextStyle
Custom emoji text style to apply to emoji characters in the grid.
final
file → File?
A File representing the image file.
final
hashCode → int
The hash code for this object.
no setterinherited
i18n → I18n
Internationalization settings for text localization.
final
icons → ImageEditorIcons
Icons used within the editor.
final
imageEditorTheme → ImageEditorTheme
The theme specific to the painting editor.
final
imageSize → Size
The size of the image.
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
layerFontSize → double
The font size for text layers within the editor.
final
layers → List<Layer>?
A list of Layer objects representing image layers.
final
networkUrl → String?
The network URL of the image.
final
paddingHelper → EdgeInsets?
Additional padding for the editor.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
theme → ThemeData
The overall theme for the editor, including colors and styles.
final

Methods

createElement() → StatefulElement
Creates a StatefulElement to manage this widget's location in the tree.
inherited
createState() → State<PaintingEditor>
Creates the mutable state for this widget at a given location in the tree.
override
debugDescribeChildren() → List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toDiagnosticsNode({String? name, DiagnosticsTreeStyle? style}) → DiagnosticsNode
Returns a debug representation of the object that is used by debugging tools and by DiagnosticsNode.toStringDeep.
inherited
toString({DiagnosticLevel minLevel = DiagnosticLevel.info}) → String
A string representation of this object.
inherited
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String
Returns a string representation of this node and its descendants.
inherited
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String
Returns a one-line detailed description of the object.
inherited
toStringShort() → String
A short, textual description of this widget.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited