WidgetController class

Class that programmatically interacts with widgets.

For a variant of this class suited specifically for unit tests, see WidgetTester. For one suitable for live tests on a device, consider LiveWidgetController.

Concrete subclasses must implement the pump method.

Implementers

Constructors

WidgetController(WidgetsBinding binding)
Creates a widget controller that uses the given binding.

Properties

allElements → Iterable<Element>
All elements currently in the widget tree (lazy pre-order traversal). [...]
read-only
allRenderObjects → Iterable<RenderObject>
Render objects of all the widgets currently in the widget tree (lazy pre-order traversal). [...]
read-only
allStates → Iterable<State<StatefulWidget>>
All states currently in the widget tree (lazy pre-order traversal). [...]
read-only
allWidgets → Iterable<Widget>
All widgets currently in the widget tree (lazy pre-order traversal). [...]
read-only
binding → WidgetsBinding
A reference to the current instance of the binding.
final
layers → List<Layer>
Returns a list of all the Layer objects in the rendering.
read-only
nextPointer ↔ int
The next available pointer identifier. [...]
read / write
hashCode → int
The hash code for this object. [...]
read-only, inherited
runtimeType → Type
A representation of the runtime type of the object.
read-only, inherited

Methods

any(Finder finder) → bool
Checks if finder exists in the tree.
drag(Finder finder, Offset offset, { int pointer }) → Future<void>
Attempts to drag the given widget by the given offset, by starting a drag in the middle of the widget. [...]
dragFrom(Offset startLocation, Offset offset, { int pointer }) → Future<void>
Attempts a drag gesture consisting of a pointer down, a move by the given offset, and a pointer up. [...]
element<T extends Element>(Finder finder) → T
The matching element in the widget tree. [...]
elementList<T extends Element>(Finder finder) → Iterable<T>
The matching elements in the widget tree. [...]
firstElement<T extends Element>(Finder finder) → T
The first matching element according to a depth-first pre-order traversal of the widget tree. [...]
firstRenderObject<T extends RenderObject>(Finder finder) → T
The render object of the first matching widget according to a depth-first pre-order traversal of the widget tree. [...]
firstState<T extends State<StatefulWidget>>(Finder finder) → T
The first matching state according to a depth-first pre-order traversal of the widget tree. [...]
firstWidget<T extends Widget>(Finder finder) → T
The first matching widget according to a depth-first pre-order traversal of the widget tree. [...]
fling(Finder finder, Offset offset, double speed, { int pointer, Duration frameInterval: const Duration(milliseconds: 16), Offset initialOffset: Offset.zero, Duration initialOffsetDelay: const Duration(seconds: 1) }) → Future<void>
Attempts a fling gesture starting from the center of the given widget, moving the given distance, reaching the given speed. [...]
flingFrom(Offset startLocation, Offset offset, double speed, { int pointer, Duration frameInterval: const Duration(milliseconds: 16), Offset initialOffset: Offset.zero, Duration initialOffsetDelay: const Duration(seconds: 1) }) → Future<void>
Attempts a fling gesture starting from the given location, moving the given distance, reaching the given speed. [...]
getBottomLeft(Finder finder) → Offset
Returns the point at the bottom left of the given widget. This point is not inside the object's hit test area.
getBottomRight(Finder finder) → Offset
Returns the point at the bottom right of the given widget. This point is not inside the object's hit test area.
getCenter(Finder finder) → Offset
Returns the point at the center of the given widget.
getRect(Finder finder) → Rect
Returns the rect of the given widget. This is only valid once the widget's render object has been laid out at least once.
getSize(Finder finder) → Size
Returns the size of the given widget. This is only valid once the widget's render object has been laid out at least once.
getTopLeft(Finder finder) → Offset
Returns the point at the top left of the given widget.
getTopRight(Finder finder) → Offset
Returns the point at the top right of the given widget. This point is not inside the object's hit test area.
hitTestOnBinding(Offset location) → HitTestResult
Forwards the given location to the binding's hitTest logic.
longPress(Finder finder, { int pointer }) → Future<void>
Dispatch a pointer down / pointer up sequence (with a delay of kLongPressTimeout + kPressTimeout between the two events) at the center of the given widget, assuming it is exposed. [...]
longPressAt(Offset location, { int pointer }) → Future<void>
Dispatch a pointer down / pointer up sequence at the given location with a delay of kLongPressTimeout + kPressTimeout between the two events.
press(Finder finder, { int pointer }) → Future<TestGesture>
Dispatch a pointer down at the center of the given widget, assuming it is exposed. [...]
pump(Duration duration) → Future<void>
Called to indicate that time should advance. [...]
renderObject<T extends RenderObject>(Finder finder) → T
The render object of the matching widget in the widget tree. [...]
renderObjectList<T extends RenderObject>(Finder finder) → Iterable<T>
The render objects of the matching widgets in the widget tree. [...]
sendEventToBinding(PointerEvent event, HitTestResult result) → Future<void>
Forwards the given pointer event to the binding.
startGesture(Offset downLocation, { int pointer }) → Future<TestGesture>
Begins a gesture at a particular point, and returns the TestGesture object which you can use to continue the gesture.
state<T extends State<StatefulWidget>>(Finder finder) → T
The matching state in the widget tree. [...]
stateList<T extends State<StatefulWidget>>(Finder finder) → Iterable<T>
The matching states in the widget tree. [...]
tap(Finder finder, { int pointer }) → Future<void>
Dispatch a pointer down / pointer up sequence at the center of the given widget, assuming it is exposed. [...]
tapAt(Offset location, { int pointer }) → Future<void>
Dispatch a pointer down / pointer up sequence at the given location.
widget<T extends Widget>(Finder finder) → T
The matching widget in the widget tree. [...]
widgetList<T extends Widget>(Finder finder) → Iterable<T>
The matching widgets in the widget tree. [...]
noSuchMethod(Invocation invocation) → dynamic
Invoked when a non-existent method or property is accessed. [...]
inherited
toString() → String
Returns a string representation of this object.
inherited

Operators

operator ==(dynamic other) → bool
The equality operator. [...]
inherited