ProImageEditorState class

Inheritance

• Object
• State<ProImageEditor>
• ProImageEditorState

Mixed in types

• ImageEditorConvertedConfigs
• SimpleConfigsAccessState<ProImageEditor>
• SimpleCallbacksAccessState<ProImageEditor>
• MainEditorGlobalKeys

Constructors

ProImageEditorState()

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 layers

getter/setter pair

blurEditor → GlobalKey<BlurEditorState>

A GlobalKey for the Blur Editor, used to access and control the state of the blur editor.

final, inherited

blurEditorCallbacks → BlurEditorCallbacks?

Returns the blur editor callbacks.

no setter, inherited

blurEditorConfigs → BlurEditorConfigs

Returns the configuration options for the blur editor.

no setter, inherited

callbacks → ProImageEditorCallbacks

Returns the callbacks for the editor.

no setter, inherited

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 setter, inherited

context → BuildContext

The location in the tree where this widget builds.

no setter, inherited

cropRotateEditor → GlobalKey<CropRotateEditorState>

A GlobalKey for the Crop and Rotate Editor, used to access and control the state of the crop and rotate editor.

final, inherited

cropRotateEditorCallbacks → CropRotateEditorCallbacks?

Returns the crop-rotate editor callbacks.

no setter, inherited

cropRotateEditorConfigs → CropRotateEditorConfigs

Returns the configuration options for the crop and rotate editor.

no setter, inherited

customWidgets → ImageEditorCustomWidgets

Returns custom widget configurations for the image editor.

no setter, inherited

designMode → ImageEditorDesignModeE

Returns the design mode for the image editor.

no setter, inherited

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.

final, inherited

emojiEditorConfigs → EmojiEditorConfigs

Returns the configuration options for the emoji editor.

no setter, inherited

filterEditor → GlobalKey<FilterEditorState>

A GlobalKey for the Filter Editor, used to access and control the state of the filter editor.

final, inherited

filterEditorCallbacks → FilterEditorCallbacks?

Returns the filter editor callbacks.

no setter, inherited

filterEditorConfigs → FilterEditorConfigs

Returns the configuration options for the filter editor.

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

helperLines → HelperLines

Returns helper lines configurations for the image editor.

no setter, inherited

heroTag → String

Returns the hero tag used in the image editor.

no setter, inherited

i18n → I18n

Returns the internationalization settings for the image editor.

no setter, inherited

icons → ImageEditorIcons

Returns the icons used in the image editor.

no setter, inherited

imageEditorTheme → ImageEditorTheme

Returns the theme settings for the image editor.

no setter, inherited

imageGenerationConfigs → ImageGeneratioConfigs

Gets the configurations related to image generation.

no setter, inherited

isMaterial → bool

Indicates if the design mode is material. Otherwise the design mode is cupertino.

no setter, inherited

isSubEditorOpen ↔ bool

Whether a sub editor is currently open.

getter/setter pair

layerInteraction → LayerInteraction

Returns layerInteraction configurations for the image editor.

no setter, inherited

layerInteractionManager → LayerInteractionManager

Helper class for managing interactions with layers in the editor.

final

mainEditorCallbacks → MainEditorCallbacks?

Returns the main editor callbacks.

no setter, inherited

mainEditorConfigs → MainEditorConfigs

Returns the configuration options for the main editor.

no setter, inherited

mounted → bool

Whether this State object is currently in a tree.

no setter, inherited

onCloseEditor → ImageEditingEmptyCallback?

A callback function that will be called before the image editor will close.

no setter, inherited

onImageEditingComplete → ImageEditingCompleteCallback?

A callback function that will be called when the editing is done, and it returns the edited image as a Uint8List.

no setter, inherited

paintEditorCallbacks → PaintEditorCallbacks?

Returns the paint editor callbacks.

no setter, inherited

paintEditorConfigs → PaintEditorConfigs

Returns the configuration options for the paint editor.

no setter, inherited

paintingEditor → GlobalKey<PaintingEditorState>

A GlobalKey for the Painting Editor, used to access and control the state of the painting editor.

final, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

selectedLayerIndex ↔ int

Index of the selected layer.

getter/setter pair

sizesManager ↔ SizesManager

Helper class for managing sizes and layout calculations.

late, final

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 setter, inherited

stateManager → StateManager

Manager class for managing the state of the editor.

final

stickerEditorConfigs → StickerEditorConfigs?

Returns the configuration options for the sticker editor.

no setter, inherited

textEditor → GlobalKey<TextEditorState>

A GlobalKey for the Text Editor, used to access and control the state of the text editor.

final, inherited

textEditorCallbacks → TextEditorCallbacks?

Returns the text editor callbacks.

no setter, inherited

textEditorConfigs → TextEditorConfigs

Returns the configuration options for the text editor.

no setter, inherited

widget → ProImageEditor

The current configuration.

no setter, inherited

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: 50)}) → 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