TestSuperEditorConfigurator class

Builder that configures and pumps a SuperEditor widget.

Properties

hashCode → int

The hash code for this object.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

autoFocus(bool autoFocus) → TestSuperEditorConfigurator

Configures the SuperEditor to auto-focus when first pumped, or not.

build() → ConfiguredSuperEditorWidget

Builds a Super Editor experience based on chosen configurations and returns a ConfiguredSuperEditorWidget, which includes the associated Super Editor Widget.

enableHistory(bool isHistoryEnabled) → TestSuperEditorConfigurator

forAndroid() → TestSuperEditorConfigurator

Configures the SuperEditor for standard Android interactions, e.g., touch gestures and IME input.

forDesktop({TextInputSource inputSource = TextInputSource.ime}) → TestSuperEditorConfigurator

Configures the SuperEditor for standard desktop interactions, e.g., mouse and keyboard input.

forIOS() → TestSuperEditorConfigurator

Configures the SuperEditor for standard iOS interactions, e.g., touch gestures and IME input.

insideCustomScrollView() → TestSuperEditorConfigurator

Configures the SuperEditor to be displayed inside a CustomScrollView.

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

pump() → Future<TestDocumentContext>

Pumps a SuperEditor widget tree with the desired configuration, and returns a TestDocumentContext, which includes the artifacts connected to the widget tree, e.g., the DocumentEditor, DocumentComposer, etc.

simulateSoftwareKeyboardInsets(bool doSimulation, {double simulatedKeyboardHeight = 300, bool animateKeyboard = false}) → TestSuperEditorConfigurator

When true, adds MediaQuery view insets to simulate the appearance of a software keyboard whenever the IME connection is active - when false, does nothing.

toString() → String

A string representation of this object.

inherited

useAppTheme(ThemeData theme) → TestSuperEditorConfigurator

Configures the ThemeData used for the MaterialApp that wraps the SuperEditor.

useIosSelectionHeuristics(bool shouldUse) → TestSuperEditorConfigurator

useStylesheet(Stylesheet? stylesheet) → TestSuperEditorConfigurator

Configures the SuperEditor to use the given stylesheet.

withAddedComponents(List<ComponentBuilder> newComponents) → TestSuperEditorConfigurator

Adds the given component builders to the list of component builders that are used to render the document layout in the pumped SuperEditor.

withAddedKeyboardActions({List<SuperEditorKeyboardAction> prepend = const [], List<SuperEditorKeyboardAction> append = const []}) → TestSuperEditorConfigurator

withAddedReactions(List<EditReaction> addedReactions) → TestSuperEditorConfigurator

withAddedRequestHandlers(List<EditRequestHandler> addedRequestHandlers) → TestSuperEditorConfigurator

withAndroidCaretStyle({double? width, Color? color}) → TestSuperEditorConfigurator

withAndroidCollapsedHandleBuilder(DocumentCollapsedHandleBuilder? builder) → TestSuperEditorConfigurator

Configures the SuperEditor to use the given builder as its android collapsed handle builder.

withAndroidExpandedHandlesBuilder(DocumentExpandedHandlesBuilder? builder) → TestSuperEditorConfigurator

Configures the SuperEditor to use the given builder as its android expanded handles builder.

withAndroidToolbarBuilder(DocumentFloatingToolbarBuilder? builder) → TestSuperEditorConfigurator

Configures the SuperEditor to use the given builder as its android toolbar builder.

withAppBar(double height) → TestSuperEditorConfigurator

Configures the SuperEditor to display an AppBar with the given height above the SuperEditor.

withCaretPolicies({bool? displayCaretWithExpandedSelection}) → TestSuperEditorConfigurator

withCaretStyle({CaretStyle? caretStyle}) → TestSuperEditorConfigurator

withComponentBuilders(List<ComponentBuilder>? componentBuilders) → TestSuperEditorConfigurator

Configures the SuperEditor to use only the given componentBuilders

withCustomWidgetTreeBuilder(WidgetTreeBuilder? builder) → TestSuperEditorConfigurator

Configures the SuperEditor to use a custom widget tree above SuperEditor.

withEditorSize(Size? size) → TestSuperEditorConfigurator

Configures the SuperEditor to constrain its maxHeight and maxWidth using the given size.

withFocusNode(FocusNode? focusNode) → TestSuperEditorConfigurator

Configures the SuperEditor to use the given focusNode

withGestureMode(DocumentGestureMode gestureMode) → TestSuperEditorConfigurator

Configures the SuperEditor to use the given gestureMode.

withHistoryGroupingPolicy(HistoryGroupingPolicy policy) → TestSuperEditorConfigurator

withImeConfiguration(SuperEditorImeConfiguration configuration) → TestSuperEditorConfigurator

Configures the way in which the user interacts with the IME, e.g., brightness, autocorrection, etc.

withImeConnectionNotifier(ValueNotifier<bool>? isImeConnected) → TestSuperEditorConfigurator

Configures the SuperEditor with the given isImeConnected notifier, which allows test code to listen for changes to the IME connection from within SuperEditor.

withImeOverrides(DeltaTextInputClientDecorator imeOverrides) → TestSuperEditorConfigurator

Configures the SuperEditor to intercept and override desired IME signals, as determined by the given imeOverrides.

withImePolicies(SuperEditorImePolicies policies) → TestSuperEditorConfigurator

Configures the SuperEditor with the given IME policies, which dictate the interactions between focus, selection, and the platform IME, including software keyborads on mobile.

withInputRole(String inputRole) → TestSuperEditorConfigurator

Configures the SuperEditor to use the given inputRole.

withInputSource(TextInputSource inputSource) → TestSuperEditorConfigurator

Configures the SuperEditor to use the given inputSource.

withIosCaretStyle({double? width, Color? color, double? handleBallDiameter}) → TestSuperEditorConfigurator

withiOSToolbarBuilder(DocumentFloatingToolbarBuilder? builder) → TestSuperEditorConfigurator

Configures the SuperEditor to use the given builder as its iOS toolbar builder.

withKey(Key? key) → TestSuperEditorConfigurator

Configures the SuperEditor to use the given key.

withLayoutKey(GlobalKey<State<StatefulWidget>>? layoutKey) → TestSuperEditorConfigurator

Configures the SuperEditor DocumentLayout to use the given layoutKey.

withPlugin(SuperEditorPlugin plugin) → TestSuperEditorConfigurator

Applies the given plugin to the pumped SuperEditor.

withScrollController(ScrollController? scrollController) → TestSuperEditorConfigurator

Configures the SuperEditor to use the given scrollController

withSelection(DocumentSelection? selection) → TestSuperEditorConfigurator

Configures the SuperEditor to use the given selection as its initial selection.

withSelectionPolicies(SuperEditorSelectionPolicies policies) → TestSuperEditorConfigurator

Configures the SuperEditor with the given selection policies, which dictate the interactions between selection and other details, such as focus change.

withSelectionStyles(SelectionStyles? styles) → TestSuperEditorConfigurator

Configures the SuperEditor with the given selection styles, which dictate the color of the primary user's selection, and related selection details.

withSelectorHandlers(Map<String, SuperEditorSelectorHandler> handlers) → TestSuperEditorConfigurator

Configures the SuperEditor to use the given selector handlers.

withSoftwareKeyboardController(SoftwareKeyboardController controller) → TestSuperEditorConfigurator

Configures the SuperEditor's SoftwareKeyboardController.

withTapDelegateFactories(List<SuperEditorContentTapDelegateFactory>? tapDelegateFactories) → TestSuperEditorConfigurator

Configures the SuperEditor to use only the given tapDelegateFactories.

withTapRegionGroupId(String? tapRegionGroupId) → TestSuperEditorConfigurator

Configures the SuperEditor to use the given tapRegionGroupId.

Operators

operator ==(Object other) → bool

The equality operator.

inherited