ProImageEditorState class
- Inheritance
-
- Object
- State<
ProImageEditor> - ProImageEditorState
- Mixed-in types
Constructors
Properties
-
activeLayers
→ List<
Layer> -
Get the list of layers from the current image editor changes.
no setter
- blockOnScaleUpdateFunction ↔ bool
-
Indicates whether the
onScaleUpdate
function can be triggered to interact with the layersgetter/setter pair -
blurEditor
→ GlobalKey<
BlurEditorState> -
A GlobalKey for the Blur Editor, used to access and control the state of the blur editor.
finalinherited
- blurEditorCallbacks → BlurEditorCallbacks?
-
Returns the blur editor callbacks.
no setterinherited
- blurEditorConfigs → BlurEditorConfigs
-
Returns the configuration options for the blur editor.
no setterinherited
- callbacks → ProImageEditorCallbacks
-
Returns the callbacks for the editor.
no setterinherited
- canRedo → bool
-
Determines whether redo actions can be performed on the current state.
no setter
- canUndo → bool
-
Determines whether undo actions can be performed on the current state.
no setter
- configs → ProImageEditorConfigs
-
Returns the main configuration options for the editor.
no setterinherited
- context → BuildContext
-
The location in the tree where this widget builds.
no setterinherited
-
cropRotateEditor
→ GlobalKey<
CropRotateEditorState> -
A GlobalKey for the Crop and Rotate Editor, used to access and control the state of the crop and rotate editor.
finalinherited
- cropRotateEditorCallbacks → CropRotateEditorCallbacks?
-
Returns the crop-rotate editor callbacks.
no setterinherited
- cropRotateEditorConfigs → CropRotateEditorConfigs
-
Returns the configuration options for the crop and rotate editor.
no setterinherited
- customWidgets → ImageEditorCustomWidgets
-
Returns custom widget configurations for the image editor.
no setterinherited
- designMode → ImageEditorDesignModeE
-
Returns the design mode for the image editor.
no setterinherited
- disablePopScope ↔ bool
-
Indicates whether PopScope is disabled.
getter/setter pair
- editorImage ↔ EditorImage
-
Get the current background image.
getter/setter pair
-
emojiEditor
→ GlobalKey<
EmojiEditorState> -
A GlobalKey for the Emoji Editor, used to access and control the state of the emoji editor.
finalinherited
- emojiEditorConfigs → EmojiEditorConfigs
-
Returns the configuration options for the emoji editor.
no setterinherited
-
filterEditor
→ GlobalKey<
FilterEditorState> -
A GlobalKey for the Filter Editor, used to access and control the state of the filter editor.
finalinherited
- filterEditorCallbacks → FilterEditorCallbacks?
-
Returns the filter editor callbacks.
no setterinherited
- filterEditorConfigs → FilterEditorConfigs
-
Returns the configuration options for the filter editor.
no setterinherited
- hashCode → int
-
The hash code for this object.
no setterinherited
- helperLines → HelperLines
-
Returns helper lines configurations for the image editor.
no setterinherited
- heroTag → String
-
Returns the hero tag used in the image editor.
no setterinherited
- i18n → I18n
-
Returns the internationalization settings for the image editor.
no setterinherited
- icons → ImageEditorIcons
-
Returns the icons used in the image editor.
no setterinherited
- imageEditorTheme → ImageEditorTheme
-
Returns the theme settings for the image editor.
no setterinherited
- imageGenerationConfigs → ImageGeneratioConfigs
-
Gets the configurations related to image generation.
no setterinherited
- isMaterial → bool
-
Indicates if the design mode is material. Otherwise the design mode is cupertino.
no setterinherited
- isSubEditorOpen ↔ bool
-
Whether a sub editor is currently open.
getter/setter pair
- layerInteraction → LayerInteraction
-
Returns layerInteraction configurations for the image editor.
no setterinherited
- layerInteractionManager → LayerInteractionManager
-
Helper class for managing interactions with layers in the editor.
final
- mainEditorCallbacks → MainEditorCallbacks?
-
Returns the main editor callbacks.
no setterinherited
- mainEditorConfigs → MainEditorConfigs
-
Returns the configuration options for the main editor.
no setterinherited
- mounted → bool
-
Whether this State object is currently in a tree.
no setterinherited
- onCloseEditor → ImageEditingEmptyCallback?
-
A callback function that will be called before the image editor will close.
no setterinherited
- onImageEditingComplete → ImageEditingCompleteCallback?
-
A callback function that will be called when the editing is done,
and it returns the edited image as a Uint8List.
no setterinherited
- paintEditorCallbacks → PaintEditorCallbacks?
-
Returns the paint editor callbacks.
no setterinherited
- paintEditorConfigs → PaintEditorConfigs
-
Returns the configuration options for the paint editor.
no setterinherited
-
paintingEditor
→ GlobalKey<
PaintingEditorState> -
A GlobalKey for the Painting Editor, used to access and control the state of the painting editor.
finalinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- selectedLayerIndex ↔ int
-
Index of the selected layer.
getter/setter pair
- sizesManager ↔ SizesManager
-
Helper class for managing sizes and layout calculations.
latefinal
-
stateHistory
→ List<
EditorStateHistory> -
List to store the history of image editor changes.
no setter
- stateHistoryConfigs → StateHistoryConfigs
-
Gets the configurations related to state history management.
no setterinherited
- stateManager → StateManager
-
Manager class for managing the state of the editor.
final
- stickerEditorConfigs → StickerEditorConfigs?
-
Returns the configuration options for the sticker editor.
no setterinherited
-
textEditor
→ GlobalKey<
TextEditorState> -
A GlobalKey for the Text Editor, used to access and control the state of the text editor.
finalinherited
- textEditorCallbacks → TextEditorCallbacks?
-
Returns the text editor callbacks.
no setterinherited
- textEditorConfigs → TextEditorConfigs
-
Returns the configuration options for the text editor.
no setterinherited
- widget → ProImageEditor
-
The current configuration.
no setterinherited
Methods
-
activate(
) → void -
Called when this object is reinserted into the tree after having been
removed via deactivate.
inherited
-
addHistory(
{List< Layer> ? layers, Layer? newLayer, TransformConfigs? transformConfigs, FilterMatrix? filters, double? blur, bool heroScreenshotRequired = false, bool blockCaptureScreenshot = false}) → void - Adds a new state to the history with the given configuration and updates the state manager.
-
addLayer(
Layer layer, {int removeLayerIndex = -1, bool blockSelectLayer = false, bool blockCaptureScreenshot = false}) → void - Add a new layer to the image editor.
-
build(
BuildContext context) → Widget -
Describes the part of the user interface represented by this widget.
override
-
captureEditorImage(
) → Future< Uint8List> - Captures the final editor image.
-
closeEditor(
) → void - Close the image editor.
-
closeWarning(
) → void - Displays a warning dialog before closing the image editor.
-
deactivate(
) → void -
Called when this object is removed from the tree.
inherited
-
debugFillProperties(
DiagnosticPropertiesBuilder properties) → void -
Add additional properties associated with the node.
inherited
-
decodeImage(
[TransformConfigs? transformConfigs]) → Future< void> - Decode the image being edited.
-
didChangeDependencies(
) → void -
Called when a dependency of this State object changes.
inherited
-
didUpdateWidget(
covariant ProImageEditor oldWidget) → void -
Called whenever the widget configuration changes.
inherited
-
dispose(
) → void -
Called when this object is removed from the tree permanently.
override
-
doneEditing(
) → void - Complete the editing process and return the edited image.
-
exportStateHistory(
{ExportEditorConfigs configs = const ExportEditorConfigs()}) → Future< ExportStateHistory> - Exports the current state history.
-
importStateHistory(
ImportStateHistory import) → void - Imports state history and performs necessary recalculations.
-
initKeyEventListener(
) → void - Initializes the key event listener by adding a handler to the keyboard service.
-
initState(
) → void -
Called when this object is inserted into the tree.
override
-
moveLayerListPosition(
{required int oldIndex, required int newIndex}) → void - Moves a layer in the list to a new position.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
openBlurEditor(
) → void - Opens the blur editor as a modal bottom sheet.
-
openCropRotateEditor(
) → void - Opens the crop rotate editor.
-
openEmojiEditor(
) → void - Opens the emoji editor.
-
openFilterEditor(
) → void - Opens the filter editor.
-
openPage<
T> (Widget page, {Duration duration = const Duration(milliseconds: 300)}) → Future< T?> - Open a new page on top of the current page.
-
openPaintingEditor(
) → void - Opens the painting editor.
-
openStickerEditor(
) → void - Opens the sticker editor as a modal bottom sheet.
-
openTextEditor(
{Duration duration = const Duration(milliseconds: 150)}) → void - Opens the text editor.
-
reassemble(
) → void -
Called whenever the application is reassembled during debugging, for
example during hot reload.
inherited
-
redoAction(
) → void - Redo the previously undone editing action.
-
removeAllLayers(
) → void - Remove all layers from the editor.
-
removeKeyEventListener(
) → void - Removes the key event listener by removing the handler from the keyboard service.
-
removeLayer(
int layerPos, {Layer? layer}) → void - Remove a layer from the editor.
-
setState(
void fn()) → void -
Notify the framework that the internal state of this object has changed.
override
-
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
-
toStringShort(
) → String -
A brief description of this object, usually just the runtimeType and the
hashCode.
inherited
-
undoAction(
) → void - Undo the last editing action.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited