TablePlusTooltipTheme class

Theme configuration for cell tooltips.

This theme integrates with the just_tooltip package, providing a unified configuration for both text-based and widget-based tooltips throughout the table.

Properties are divided into:

  • Visual styling (mapped to JustTooltipTheme): backgroundColor, borderRadius, padding, elevation, boxShadow, borderColor, borderWidth, textStyle, showArrow, arrowBaseWidth, arrowLength, arrowPositionRatio
  • Layout & behavior (passed to JustTooltip widget): direction, alignment, offset, crossAxisOffset, screenMargin, enableTap, enableHover, interactive, waitDuration, showDuration, animation, animationCurve, fadeBegin, scaleBegin, slideOffset, rotationBegin, animationDuration
  • Toggle : enabled, hideOnEmptyMessage

Constructors

TablePlusTooltipTheme({bool enabled = true, bool hideOnEmptyMessage = true, Color backgroundColor = const Color(0xFF616161), BorderRadius borderRadius = const BorderRadius.all(Radius.circular(6)), EdgeInsets padding = const EdgeInsets.symmetric(horizontal: 12.0, vertical: 8.0), double elevation = 4.0, List<BoxShadow>? boxShadow, Color? borderColor, double borderWidth = 0.0, TextStyle textStyle = const TextStyle(fontSize: 12, color: Colors.white), bool showArrow = false, double arrowBaseWidth = 12.0, double arrowLength = 6.0, double arrowPositionRatio = 0.25, TooltipDirection direction = TooltipDirection.bottom, TooltipAlignment alignment = TooltipAlignment.center, double offset = 8.0, double crossAxisOffset = 0.0, double screenMargin = 8.0, bool enableTap = false, bool enableHover = true, bool interactive = true, Duration waitDuration = const Duration(milliseconds: 500), Duration? showDuration, TooltipAnimation animation = TooltipAnimation.fade, Curve? animationCurve, double fadeBegin = 0.0, double scaleBegin = 0.0, double slideOffset = 0.3, double rotationBegin = -0.05, Duration animationDuration = const Duration(milliseconds: 150)})
Creates a TablePlusTooltipTheme with the specified styling properties.
const

Properties

alignment → TooltipAlignment
The cross-axis alignment of the tooltip relative to the child.
final
animation → TooltipAnimation
The type of animation when showing/hiding the tooltip.
final
animationCurve → Curve?
The curve for the tooltip animation.
final
animationDuration → Duration
The duration of the tooltip animation.
final
arrowBaseWidth → double
The base width of the arrow.
final
arrowLength → double
The length (protrusion) of the arrow.
final
arrowPositionRatio → double
The position ratio of the arrow along the tooltip edge (0.0 to 1.0).
final
backgroundColor → Color
The background color of the tooltip.
final
borderColor → Color?
Optional border color of the tooltip.
final
borderRadius → BorderRadius
The border radius of the tooltip.
final
borderWidth → double
The border width of the tooltip.
final
boxShadow → List<BoxShadow>?
Optional custom box shadows for the tooltip.
final
crossAxisOffset → double
The cross-axis shift of the tooltip.
final
direction → TooltipDirection
The direction (side) where the tooltip appears relative to the child.
final
elevation → double
The shadow elevation of the tooltip.
final
enabled → bool
Whether tooltips are enabled globally. If false, no tooltips will be shown regardless of column settings.
final
enableHover → bool
Whether to show the tooltip on hover.
final
enableTap → bool
Whether to show the tooltip on tap.
final
fadeBegin → double
The starting opacity for fade animations.
final
hashCode → int
The hash code for this object.
no setterinherited
hideOnEmptyMessage → bool
Whether to suppress the tooltip when the message is empty.
final
interactive → bool
Whether the tooltip stays visible when the mouse is over the tooltip itself.
final
offset → double
The gap between the child widget and the tooltip.
final
padding → EdgeInsets
The padding inside the tooltip.
final
rotationBegin → double
The starting rotation for rotation animations.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scaleBegin → double
The starting scale for scale animations.
final
screenMargin → double
The minimum distance from the viewport edge.
final
showArrow → bool
Whether to show an arrow indicator pointing to the target widget.
final
showDuration → Duration?
The length of time that the tooltip will be shown after activation. If null, the tooltip stays visible until the pointer leaves.
final
slideOffset → double
The slide distance ratio for slide animations.
final
textStyle → TextStyle
The text style for tooltip content.
final
waitDuration → Duration
The length of time that a pointer must hover over a tooltip's widget before the tooltip will be shown.
final

Methods

copyWith({bool? enabled, bool? hideOnEmptyMessage, Color? backgroundColor, BorderRadius? borderRadius, EdgeInsets? padding, double? elevation, List<BoxShadow>? boxShadow, Color? borderColor, double? borderWidth, TextStyle? textStyle, bool? showArrow, double? arrowBaseWidth, double? arrowLength, double? arrowPositionRatio, TooltipDirection? direction, TooltipAlignment? alignment, double? offset, double? crossAxisOffset, double? screenMargin, bool? enableTap, bool? enableHover, bool? interactive, Duration? waitDuration, Duration? showDuration, TooltipAnimation? animation, Curve? animationCurve, double? fadeBegin, double? scaleBegin, double? slideOffset, double? rotationBegin, Duration? animationDuration}) → TablePlusTooltipTheme
Creates a copy of this theme with the given fields replaced with new values.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJustTooltipTheme() → JustTooltipTheme
Converts visual properties to a JustTooltipTheme instance.
toString() → String
A string representation of this object.
inherited

Operators

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