AnnotationWidget class

Framework widget that wraps custom annotations with automatic functionality.

This widget serves as the rendering layer for annotations, automatically providing:

  • Reactive positioning: Updates automatically based on annotation.visualPosition
  • Visibility control: Shows/hides based on annotation.isVisible
  • Selection feedback: Theme-consistent borders and highlights when selected
  • Hover feedback: Visual indication when annotation is being dragged over (highlighted)
  • Theme integration: Uses NodeFlowTheme for consistent styling across the editor

Framework Integration

Custom annotation implementers only need to focus on their Annotation.buildWidget method. The AnnotationWidget handles all positioning, selection, theming, and interaction logic automatically.

The widget wraps the custom annotation content with:

  1. Observer for MobX reactivity
  2. Positioned for absolute canvas positioning
  3. Selection/highlight borders using theme colors
  4. Visibility logic to hide when annotation.isVisible is false

Example Usage

This widget is typically used internally by AnnotationLayer:

AnnotationWidget(
  annotation: stickyNote,
  isSelected: controller.annotations.isAnnotationSelected(stickyNote.id),
  isHighlighted: false,
)

See also:

Inheritance
Available extensions

Constructors

AnnotationWidget({Key? key, required Annotation annotation, bool isSelected = false, bool isHighlighted = false})
Creates an annotation widget.
const

Properties

annotation → Annotation
The annotation to render.
final
hashCode → int
The hash code for this object.
no setterinherited
isHighlighted → bool
Whether this annotation is being highlighted (e.g., during a drag-over operation).
final
isSelected → bool
Whether this annotation is currently selected.
final
key → Key?
Controls how one widget replaces another widget in the tree.
finalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

build(BuildContext context) → Widget
Describes the part of the user interface represented by this widget.
override
createElement() → StatelessElement
Creates a StatelessElement to manage this widget's location in the tree.
inherited
debugDescribeChildren() → List<DiagnosticsNode>
Returns a list of DiagnosticsNode objects describing this node's children.
inherited
debugFillProperties(DiagnosticPropertiesBuilder properties) → void
Add additional properties associated with the node.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
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
toStringDeep({String prefixLineOne = '', String? prefixOtherLines, DiagnosticLevel minLevel = DiagnosticLevel.debug, int wrapWidth = 65}) → String
Returns a string representation of this node and its descendants.
inherited
toStringShallow({String joiner = ', ', DiagnosticLevel minLevel = DiagnosticLevel.debug}) → String
Returns a one-line detailed description of the object.
inherited
toStringShort() → String
A short, textual description of this widget.
inherited
withAnnotationLayer(NodeFlowController<T> controller) → Widget

Available on Widget, provided by the AnnotationLayerSupport extension

Wraps this widget with an annotation layer.

Operators

operator ==(Object other) → bool
The equality operator.
inherited