two_dimensional_scrollables library

The TableView, TreeView, and associated widgets.

To use, import package:two_dimensional_scrollables/two_dimensional_scrollables.dart.

Classes

CombiningSpanExtent
Runs the result of two SpanExtents through a combiner function to determine the ultimate pixel extent of a span.
FixedSpanExtent
A span extent with a fixed pixels value.
FractionalSpanExtent
Specified the span extent as a fraction of the viewport extent.
MaxSpanExtent
Returns the larger pixel extent of the two provided SpanExtent.
MinSpanExtent
Returns the smaller pixel extent of the two provided SpanExtent.
RemainingSpanExtent
Specifies that the span should occupy the remaining space in the viewport.
RenderTableViewport
A render object for viewing RenderBoxes in a table format that extends in both the horizontal and vertical dimensions.
RenderTreeViewport
A render object for viewing RenderBoxes in a tree format that extends in both the horizontal and vertical dimensions.
Span
Defines the extent, visual appearance, and gesture handling of a row or column.
SpanBorder
Describes the border for a Span.
SpanDecoration
A decoration for a Span.
SpanDecorationPaintDetails
Provides the details of a given SpanDecoration for painting.
SpanExtent
Defines the extent of a Span.
SpanExtentDelegate
Delegate passed to SpanExtent.calculateExtent from the RenderTableViewport during layout.
SpanPadding
Defines the leading and trailing padding values of a Span.
TableCellBuilderDelegate
A delegate that supplies children for a TableViewport on demand using a builder callback.
TableCellListDelegate
A delegate that supplies children for a TableViewport using an explicit two dimensional array.
TableVicinity
The relative position of a child in a TableViewport in relation to other children of the viewport, in terms of rows and columns.
TableView
A widget that displays a table, which can scroll in horizontal and vertical directions.
TableViewCell
Creates a cell of the TableView, along with information regarding merged cells and RepaintBoundarys.
TableViewParentData
Parent data structure used by RenderTableViewport.
TableViewport
A widget through which a portion of a Table of Widget children are viewed, typically in combination with a TableView.
TreeRowBorder
Describes the border for a TreeRow.
TreeRowBuilderDelegate
A delegate that supplies nodes for a TreeViewport on demand using a builder callback.
TreeVicinity
The position of a TreeRow in a TreeViewport in relation to other children of the viewport.
TreeView<T>
A widget that displays TreeViewNodes that expand and collapse in a vertically and horizontally scrolling TreeViewport.
TreeViewController
Enables control over the TreeViewNodes of a TreeView.
TreeViewIndentationType
The style of indentation for TreeViewNodes in a TreeView, as handled by RenderTreeViewport.
TreeViewNode<T>
A data structure for configuring children of a TreeView.
TreeViewport
A widget through which a portion of a tree of TreeViewNode children are viewed as rows, typically in combination with a TreeView.

Mixins

TableCellDelegateMixin
A mixin that defines the model for a TwoDimensionalChildDelegate to be used with a TableView.
TreeRowDelegateMixin
A mixin that defines the model for a TwoDimensionalChildDelegate to be used with a TreeView.
TreeViewStateMixin<T>
A mixin for classes implementing a tree structure as expected by a TreeViewController.

Typedefs

CombiningTableSpanExtent = CombiningSpanExtent
Runs the result of two TableSpanExtents through a combiner function to determine the ultimate pixel extent of a span.
CombiningTreeRowExtent = CombiningSpanExtent
Runs the result of two TreeRowExtents through a combiner function to determine the ultimate pixel height of a tree row.
FixedTableSpanExtent = FixedSpanExtent
A span extent with a fixed pixels value.
FixedTreeRowExtent = FixedSpanExtent
A TreeRow with a fixed pixels height.
FractionalTableSpanExtent = FractionalSpanExtent
Specified the span extent as a fraction of the viewport extent.
FractionalTreeRowExtent = FractionalSpanExtent
Specified the TreeRow height as a fraction of the viewport extent.
MaxTableSpanExtent = MaxSpanExtent
Returns the larger pixel extent of the two provided TableSpanExtent.
MaxTreeRowExtent = MaxSpanExtent
Returns the larger pixel extent of the two provided TreeRowExtent.
MinTableSpanExtent = MinSpanExtent
Returns the smaller pixel extent of the two provided TableSpanExtent.
MinTreeRowExtent = MinSpanExtent
Returns the smaller pixel extent of the two provided TreeRowExtent.
RemainingTableSpanExtent = RemainingSpanExtent
Specifies that the span should occupy the remaining space in the viewport.
RemainingTreeRowExtent = RemainingSpanExtent
Specifies that the row should occupy the remaining space in the viewport.
SpanExtentCombiner = double Function(double, double)
Signature for a function that combines the result of two SpanExtent.calculateExtent invocations.
TableSpan = Span
Defines the extent, visual appearance, and gesture handling of a row or column in a TableView.
TableSpanBorder = SpanBorder
Describes the border for a TableSpan.
TableSpanBuilder = TableSpan? Function(int index)
Signature for a function that creates a TableSpan for a given index of row or column in a TableView.
TableSpanDecoration = SpanDecoration
A decoration for a TableSpan.
TableSpanDecorationPaintDetails = SpanDecorationPaintDetails
Provides the details of a given TableSpanDecoration for painting.
TableSpanExtent = SpanExtent
Defines the extent of a TableSpan.
TableSpanExtentCombiner = SpanExtentCombiner
Signature for a function that combines the result of two TableSpanExtent.calculateExtent invocations.
TableSpanExtentDelegate = SpanExtentDelegate
Delegate passed to TableSpanExtent.calculateExtent from the RenderTableViewport during layout.
TableSpanPadding = SpanPadding
Defines the leading and trailing padding values of a TableSpan.
TableViewCellBuilder = TableViewCell Function(BuildContext context, TableVicinity vicinity)
Signature for a function that creates a child TableViewCell for a given TableVicinity in a TableView, but may return null.
TreeRow = Span
Defines the extent, visual appearance, and gesture handling of a row in a TreeView.
TreeRowDecoration = SpanDecoration
A decoration for a TreeRow.
TreeRowDecorationPaintDetails = SpanDecorationPaintDetails
Provides the details of a given TreeRowDecoration for painting.
TreeRowExtent = SpanExtent
Defines the extent, or height, of a TreeRow.
TreeRowExtentCombiner = SpanExtentCombiner
Signature for a function that combines the result of two TreeRowExtent.calculateExtent invocations.
TreeRowExtentDelegate = SpanExtentDelegate
Delegate passed to TreeSpanExtent.calculateExtent from the RenderTreeViewport during layout.
TreeRowPadding = SpanPadding
Defines the leading and trailing padding values of a TreeRow.
TreeVicinityToRowBuilder = TreeRow Function(TreeVicinity)
Returns a TreeRow for the given TreeVicinity in the TreeView.
TreeViewNodeBuilder = Widget Function(BuildContext context, TreeViewNode<Object?> node, AnimationStyle toggleAnimationStyle)
Signature for a function that creates a Widget to represent the given TreeViewNode in the TreeView.
TreeViewNodeCallback = void Function(TreeViewNode<Object?> node)
Signature for a function that is called when a TreeViewNode is toggled, changing its expanded state.
TreeViewNodesAnimation = ({int fromIndex, int toIndex, double value})
Represents the animation of the children of a parent TreeViewNode that are animating into or out of view.
TreeViewRowBuilder = TreeRow Function(TreeViewNode<Object?> node)
Signature for a function that creates a TreeRow for a given TreeViewNode in a TreeView.