CustomInspector class
- Mixed-in types
Constructors
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- isSelectMode ← bool
-
Enables select mode for the Inspector.
no getterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- selection → InspectorSelection
-
Ground truth tracking what object(s) are currently selected used by both
GUI tools such as the Flutter IntelliJ Plugin and the WidgetInspector
displayed on the device.
finalinherited
- selectionChangedCallback ↔ InspectorSelectionChangedCallback?
-
Callback typically registered by the WidgetInspector to receive
notifications when selection changes.
getter/setter pairinherited
Methods
-
addPubRootDirectories(
List< String> pubRootDirectories) → void -
Add a list of directories that should be considered part of the local
project.
inherited
-
devToolsInspectorUri(
String inspectorRef) → String -
Returns the DevTools inspector uri for the given vm service connection and
inspector reference.
inherited
-
disposeAllGroups(
) → void -
Clear all InspectorService object references.
inherited
-
disposeGroup(
String name) → void -
Free all references to objects in a group.
inherited
-
disposeId(
String? id, String groupName) → void -
Remove the object with the specified
idfrom the specified object group.inherited -
forceRebuild(
) → Future< void> -
Cause the entire tree to be rebuilt. This is used by development tools
when the application code has changed and is being hot-reloaded, to cause
the widget tree to pick up any changed implementations.
inherited
-
getChildren(
String diagnosticsNodeId, String groupName) → String -
Returns a JSON representation of the children of the DiagnosticsNode
object that
diagnosticsNodeIdreferences.inherited -
getChildrenDetailsSubtree(
String diagnosticableId, String groupName) → String -
Returns a JSON representation of the children of the DiagnosticsNode
object that
diagnosticableIdreferences providing information needed for the details subtree view.inherited -
getChildrenSummaryTree(
String diagnosticsNodeId, String groupName) → String -
Returns a JSON representation of the children of the DiagnosticsNode
object that
diagnosticsNodeIdreferences only including children that were created directly by user code.inherited -
getDetailsSubtree(
String diagnosticableId, String groupName, {int subtreeDepth = 2}) → String -
Returns a JSON representation of the subtree rooted at the
DiagnosticsNode object that
diagnosticsNodeIdreferences providing information needed for the details subtree view.inherited -
getParentChain(
String id, String groupName) → String -
Returns JSON representing the chain of DiagnosticsNode instances from
root of the tree to the Element or RenderObject matching
id.inherited -
getProperties(
String diagnosticsNodeId, String groupName) → String -
Returns a JSON representation of the properties of the DiagnosticsNode
object that
diagnosticsNodeIdreferences.inherited -
getRootWidget(
String groupName) → String -
Returns a JSON representation of the DiagnosticsNode for the root
Element.
inherited
-
getRootWidgetSummaryTree(
String groupName) → String -
Returns a JSON representation of the DiagnosticsNode for the root
Element showing only nodes that should be included in a summary tree.
inherited
-
getSelectedSummaryWidget(
String? previousSelectionId, String groupName) → String -
Returns a DiagnosticsNode representing the currently selected Element
if the selected Element should be shown in the summary tree otherwise
returns the first ancestor of the selected Element shown in the summary
tree.
inherited
-
getSelectedWidget(
String? previousSelectionId, String groupName) → String -
Returns a DiagnosticsNode representing the currently selected Element.
inherited
-
initServiceExtensions(
RegisterServiceExtensionCallback registerExtension) → void -
Called to register service extensions.
inherited
-
inspect(
Object? object) → void -
All events dispatched by a WidgetInspectorService use this method
instead of calling developer.inspect.
override
-
isStructuredErrorsEnabled(
) → bool -
Whether structured errors are enabled.
inherited
-
isWidgetCreationTracked(
) → bool -
Returns whether Widget creation locations are available.
inherited
-
isWidgetTreeReady(
[String? groupName]) → bool -
Returns whether the application has rendered its first frame and it is
appropriate to display the Widget tree in the inspector.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
performReassemble(
) → void -
This method is called by WidgetsBinding.performReassemble to flush caches
of obsolete values after a hot reload.
inherited
-
postEvent(
String eventKind, Map< Object, Object?> eventData, {String stream = 'Extension'}) → void -
All events dispatched by a WidgetInspectorService use this method
instead of calling developer.postEvent directly.
inherited
-
pubRootDirectories(
Map< String, String> parameters) → Future<Map< String, dynamic> > -
Returns the list of directories that should be considered part of the
local project.
inherited
-
registerServiceExtension(
{required String name, required ServiceExtensionCallback callback, required RegisterServiceExtensionCallback registerExtension}) → void -
Registers a service extension method with the given name (full
name "ext.flutter.inspector.name").
inherited
-
removePubRootDirectories(
List< String> pubRootDirectories) → void -
Remove a list of directories that should no longer be considered part
of the local project.
inherited
-
resetAllState(
) → void -
Reset all InspectorService state.
inherited
-
resetPubRootDirectories(
) → void -
Resets the list of directories, that should be considered part of the
local project, to the value passed in pubRootDirectories.
inherited
-
screenshot(
Object? object, {required double width, required double height, double margin = 0.0, double maxPixelRatio = 1.0, bool debugPaint = false}) → Future< Image?> -
Captures an image of the current state of an
objectthat is a RenderObject or Element.inherited -
setPubRootDirectories(
List< String> pubRootDirectories) → void -
Set the list of directories that should be considered part of the local
project.
inherited
-
setSelection(
Object? object, [String? groupName]) → bool -
Set the WidgetInspector selection to the specified
objectif it is a valid object to set as the inspector selection.inherited -
setSelectionById(
String? id, [String? groupName]) → bool -
Set the WidgetInspector selection to the object matching the specified
id if the object is valid object to set as the inspector selection.
inherited
-
toId(
Object? object, String groupName) → String? -
Returns a unique id for
objectthat will remain live at least until disposeGroup is called ongroupName.inherited -
toObject(
String? id, [String? groupName]) → Object? -
Returns the Dart object associated with a reference id.
inherited
-
toObjectForSourceLocation(
String id, [String? groupName]) → Object? -
Returns the object to introspect to determine the source location of an
object's class.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited