Skip to content

Commit

Permalink
Review feedback round 2
Browse files Browse the repository at this point in the history
  • Loading branch information
@Piinks
Piinks committed May 14, 2024
1 parent a6b2b6e commit d56702e
Show file tree
Hide file tree
Showing 6 changed files with 147 additions and 192 deletions.
1 change: 1 addition & 0 deletions packages/two_dimensional_scrollables/example/lib/tree_view/custom_tree.dart
View file
Original file line number Diff line number Diff line change
Expand Up @@ -233,6 +233,7 @@ class CustomTreeExampleState extends State<CustomTreeExample> {

@override
Widget build(BuildContext context) {
// This example is assumes the full screen is available.
final Size screenSize = MediaQuery.sizeOf(context);
final List<Widget> selectedChildren = <Widget>[];
if (_selectedNode != null) {
Expand Down
28 changes: 3 additions & 25 deletions packages/two_dimensional_scrollables/lib/src/tree_view/render_tree.dart
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@ class RenderTreeViewport extends RenderTwoDimensionalViewport {
RenderTreeViewport({
required Map<UniqueKey, TreeViewNodesAnimation> activeAnimations,
required Map<int, int> rowDepths,
required TreeViewTraversalOrder traversalOrder,
required double indentation,
required super.horizontalOffset,
required super.horizontalAxisDirection,
Expand All @@ -42,15 +41,11 @@ class RenderTreeViewport extends RenderTwoDimensionalViewport {
super.clipBehavior,
}) : _activeAnimations = activeAnimations,
_rowDepths = rowDepths,
_traversalOrder = traversalOrder,
_indentation = indentation,
assert(indentation >= 0),
assert(verticalAxisDirection == AxisDirection.down &&
horizontalAxisDirection == AxisDirection.right),
super(
mainAxis: traversalOrder == TreeViewTraversalOrder.depthFirst
? Axis.vertical
: Axis.horizontal,
);
super(mainAxis: Axis.vertical);

@override
TreeRowDelegateMixin get delegate => super.delegate as TreeRowDelegateMixin;
Expand Down Expand Up @@ -78,7 +73,7 @@ class RenderTreeViewport extends RenderTwoDimensionalViewport {

/// The depth of each currently active node in the tree.
///
/// This is used to properly set the [TreeVicinity] for the [traversalOrder].
/// This is used to properly set the [TreeVicinity].
Map<int, int> get rowDepths => _rowDepths;
Map<int, int> _rowDepths;
set rowDepths(Map<int, int> value) {
Expand All @@ -89,23 +84,6 @@ class RenderTreeViewport extends RenderTwoDimensionalViewport {
markNeedsLayout();
}

/// The order in which child nodes of the tree will be traversed.
///
/// The default traversal order is [TreeViewTraversalOrder.depthFirst].
TreeViewTraversalOrder get traversalOrder => _traversalOrder;
TreeViewTraversalOrder _traversalOrder;
set traversalOrder(TreeViewTraversalOrder value) {
if (_traversalOrder == value) {
return;
}
_traversalOrder = value;
// Changing mainAxis will call markNeedsLayout.
mainAxis = switch (value) {
TreeViewTraversalOrder.depthFirst => Axis.vertical,
TreeViewTraversalOrder.breadthFirst => Axis.horizontal,
};
}

/// The number of pixels by which child nodes will be offset in the cross axis
/// based on [rowDepths].
///
Expand Down
74 changes: 23 additions & 51 deletions packages/two_dimensional_scrollables/lib/src/tree_view/tree.dart
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,13 @@ import 'tree_core.dart';
import 'tree_delegate.dart';
import 'tree_span.dart';

// SHARED WITH FRAMEWORK - TreeViewNode (SliverTreeNode), TreeViewController (SliverTreeController)
// Should not deviate from the core components of the framework.
// The classes in these files follow the same pattern as the one dimensional
// sliver tree in the framework.
//
// These classes share the same surface as SliverTree in the framework since
// they are not currently available on the stable branch. After rolling to
// stable, these classes may be deprecated, or more likely made to be
// typedefs/subclasses of the framework core tree components. They could also
// live on if at a later date the 2D TreeView deviates or adds special features
// not relevant to the 1D sliver components of the framework.
// After rolling to stable, these classes may be deprecated, or more likely
// made to be typedefs/subclasses of the framework core tree components. They
// could also live on if at a later date the 2D TreeView deviates or adds
// special features not relevant to the 1D sliver components of the framework.

const double _kDefaultRowExtent = 40.0;

Expand All @@ -43,9 +41,6 @@ class TreeViewNode<T> {
/// The subject matter of the node.
///
/// Must correspond with the type of [TreeView].
///
/// The content is used to generate a unique [Key] in
/// [TreeView.defaultTreeNodeBuilder] for maintain animation performance.
T get content => _content;
final T _content;

Expand Down Expand Up @@ -275,11 +270,14 @@ class TreeViewController {
}
}

// END of framework shared classes.
// END of shared surfaces from the framework.

/// A widget that displays [TreeViewNode]s that expand and collapse in a
/// vertically and horizontally scrolling [TreeViewport].
///
/// The type [T] correlates to the type of [TreeView] and [TreeViewNode],
/// representing the type of [TreeViewNode.content].
///
/// The rows of the tree are laid out on demand by the [TreeViewport]'s render
/// object, using [TreeView.treeNodeBuilder]. This will only be called for the
/// nodes that are visible, or within the [TreeViewport.cacheExtent].
Expand All @@ -296,8 +294,7 @@ class TreeViewController {
///
/// Each active node of the tree will have a [TreeVicinity], representing the
/// resolved row index of the node, based on what nodes are active, as well as
/// the depth. This vicinity is used to traverse the tree as indicated by
/// [traversalOrder].
/// the depth.
///
/// A [TreeView] only supports a vertical axis direction of
/// [AxisDirection.down] and a horizontal axis direction of
Expand All @@ -313,7 +310,6 @@ class TreeView<T> extends StatefulWidget {
this.controller,
this.onNodeToggle,
this.toggleAnimationStyle,
this.traversalOrder = TreeViewTraversalOrder.depthFirst,
this.indentation = TreeViewIndentationType.standard,
this.primary,
this.mainAxis = Axis.vertical,
Expand Down Expand Up @@ -378,15 +374,6 @@ class TreeView<T> extends StatefulWidget {
/// To disable the tree animation, use [AnimationStyle.noAnimation].
final AnimationStyle? toggleAnimationStyle;

/// The order in which [TreeViewNode]s are visited.
///
/// This value will influence [TreeViewport.mainAxis] so nodes are traversed
/// properly when they are converted to a [TreeVicinity] in the context of the
/// active nodes of the tree.
///
/// Defaults to [TreeViewTraversalOrder.depthFirst].
final TreeViewTraversalOrder traversalOrder;

/// The number of pixels children will be offset by in the cross axis based on
/// their [TreeViewNode.depth].
///
Expand Down Expand Up @@ -507,6 +494,13 @@ class TreeView<T> extends StatefulWidget {
/// Defaults to true.
final bool addRepaintBoundaries;

/// The default [AnimationStyle] used for node expand and collapse animations,
/// when one has not been provided in [toggleAnimationStyle].
static AnimationStyle defaultToggleAnimationStyle = AnimationStyle(
curve: defaultAnimationCurve,
duration: defaultAnimationDuration,
);

/// A default of [Curves.linear], which is used in the tree's expanding and
/// collapsing node animation.
static const Curve defaultAnimationCurve = Curves.linear;
Expand Down Expand Up @@ -553,7 +547,8 @@ class TreeView<T> extends StatefulWidget {
);
}

/// Returns the default tree row for a given [TreeViewNode].
/// Default builder for the widget representing a given [TreeViewNode] in the
/// tree.
///
/// Used by [TreeView.treeNodeBuilder].
///
Expand Down Expand Up @@ -582,7 +577,7 @@ class TreeView<T> extends StatefulWidget {
dimension: 30.0,
child: node.children.isNotEmpty
? AnimatedRotation(
key: Key('$index - ${node.content}'),
key: Key('$index'),
turns: node.isExpanded ? 0.25 : 0.0,
duration: animationDuration,
curve: animationCurve,
Expand Down Expand Up @@ -744,11 +739,7 @@ class _TreeViewState<T> extends State<TreeView<T>>
Widget child = widget.treeNodeBuilder(
context,
node,
widget.toggleAnimationStyle ??
AnimationStyle(
curve: TreeView.defaultAnimationCurve,
duration: TreeView.defaultAnimationDuration,
),
widget.toggleAnimationStyle ?? TreeView.defaultToggleAnimationStyle,
);

if (widget.addRepaintBoundaries) {
Expand All @@ -761,7 +752,6 @@ class _TreeViewState<T> extends State<TreeView<T>>
return widget.treeRowBuilder(_activeNodes[vicinity.row]);
},
addAutomaticKeepAlives: widget.addAutomaticKeepAlives,
traversalOrder: widget.traversalOrder,
indentation: widget.indentation.value,
);
}
Expand Down Expand Up @@ -971,7 +961,6 @@ class _TreeView extends TwoDimensionalScrollView {
super.clipBehavior,
required TwoDimensionalIndexedWidgetBuilder nodeBuilder,
required TreeVicinityToRowBuilder rowBuilder,
this.traversalOrder = TreeViewTraversalOrder.depthFirst,
required this.activeAnimations,
required this.rowDepths,
required this.indentation,
Expand All @@ -989,7 +978,6 @@ class _TreeView extends TwoDimensionalScrollView {

final Map<UniqueKey, TreeViewNodesAnimation> activeAnimations;
final Map<int, int> rowDepths;
final TreeViewTraversalOrder traversalOrder;
final double indentation;

@override
Expand All @@ -1008,7 +996,6 @@ class _TreeView extends TwoDimensionalScrollView {
clipBehavior: clipBehavior,
activeAnimations: activeAnimations,
rowDepths: rowDepths,
traversalOrder: traversalOrder,
indentation: indentation,
);
}
Expand All @@ -1030,15 +1017,10 @@ class TreeViewport extends TwoDimensionalViewport {
super.clipBehavior,
required this.activeAnimations,
required this.rowDepths,
this.traversalOrder = TreeViewTraversalOrder.depthFirst,
required this.indentation,
}) : assert(verticalAxisDirection == AxisDirection.down &&
horizontalAxisDirection == AxisDirection.right),
super(
mainAxis: traversalOrder == TreeViewTraversalOrder.depthFirst
? Axis.vertical
: Axis.horizontal,
);
super(mainAxis: Axis.vertical);

/// The currently active [TreeViewNode] animations.
///
Expand All @@ -1048,16 +1030,8 @@ class TreeViewport extends TwoDimensionalViewport {
final Map<UniqueKey, TreeViewNodesAnimation> activeAnimations;

/// The depth of each active [TreeNode].
///
/// This is used to properly traverse nodes according to
/// [traversalOrder].
final Map<int, int> rowDepths;

/// The order in which child nodes of the tree will be traversed.
///
/// The default traversal order is [TreeViewTraversalOrder.depthFirst].
final TreeViewTraversalOrder traversalOrder;

/// The number of pixels by which child nodes will be offset in the cross axis
/// based on their [TreeViewNode.depth].
///
Expand All @@ -1070,7 +1044,6 @@ class TreeViewport extends TwoDimensionalViewport {
return RenderTreeViewport(
activeAnimations: activeAnimations,
rowDepths: rowDepths,
traversalOrder: traversalOrder,
indentation: indentation,
horizontalOffset: horizontalOffset,
horizontalAxisDirection: horizontalAxisDirection,
Expand All @@ -1091,7 +1064,6 @@ class TreeViewport extends TwoDimensionalViewport {
renderObject
..activeAnimations = activeAnimations
..rowDepths = rowDepths
..traversalOrder = traversalOrder
..indentation = indentation
..horizontalOffset = horizontalOffset
..horizontalAxisDirection = horizontalAxisDirection
Expand Down
35 changes: 6 additions & 29 deletions packages/two_dimensional_scrollables/lib/src/tree_view/tree_core.dart
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,13 @@ import 'package:flutter/widgets.dart';

import 'tree.dart';

// SHARED WITH FRAMEWORK (whole file)
// Should not deviate from the core components of the framework.
// The classes in these files follow the same pattern as the one dimensional
// sliver tree in the framework.
//
// These classes share the same surface as SliverTree in the framework since
// they are not currently available on the stable branch. After rolling to
// stable, these classes may be deprecated, or more likely made to be
// typedefs/subclasses of the framework core tree components. They could also
// live on if at a later date the 2D TreeView deviates or adds special features
// not relevant to the 1D sliver components of the framework.
// After rolling to stable, these classes may be deprecated, or more likely
// made to be typedefs/subclasses of the framework core tree components. They
// could also live on if at a later date the 2D TreeView deviates or adds
// special features not relevant to the 1D sliver components of the framework.

/// Signature for a function that is called when a [TreeViewNode] is toggled,
/// changing its expanded state.
Expand Down Expand Up @@ -94,27 +92,6 @@ typedef TreeViewNodesAnimation = ({
double value,
});

/// Traversal order pattern for [TreeViewNode]s that are children of a
/// [TreeView].
enum TreeViewTraversalOrder {
/// Pre-order depth traversal.
///
/// This traversal pattern will visit each given [TreeViewNode] before
/// visiting each of its children.
///
/// This is the default traversal pattern for [TreeView.traversalOrder].
depthFirst,

/// Lever order traversal.
///
/// This traversal pattern will visit each node that exists at the same
/// [TreeViewNode.depth], before progressing to the next depth of nodes in
/// the tree.
///
/// Can be used in [TreeView.traversalOrder], which defaults to [depthFirst].
breadthFirst,
}

/// The style of indentation for [TreeViewNode]s in a [TreeView], as handled
/// by [RenderTreeViewport].
///
Expand Down
46 changes: 0 additions & 46 deletions packages/two_dimensional_scrollables/test/tree_view/render_tree_test.dart
View file
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,6 @@ void main() {
activeAnimations: const <UniqueKey, TreeViewNodesAnimation>{},
rowDepths: const <int, int>{},
indentation: 0.0,
traversalOrder: TreeViewTraversalOrder.depthFirst,
childManager: _NullBuildContext(),
);
},
Expand Down Expand Up @@ -123,7 +122,6 @@ void main() {
activeAnimations: const <UniqueKey, TreeViewNodesAnimation>{},
rowDepths: const <int, int>{},
indentation: 0.0,
traversalOrder: TreeViewTraversalOrder.depthFirst,
childManager: _NullBuildContext(),
);
},
Expand All @@ -138,50 +136,6 @@ void main() {
expect(treeViewport, isNull);
});

test('Sets mainAxis based on traversal order', () {
RenderTreeViewport treeViewport = RenderTreeViewport(
verticalOffset: TestOffset(),
verticalAxisDirection: AxisDirection.down,
horizontalOffset: TestOffset(),
horizontalAxisDirection: AxisDirection.right,
delegate: TreeRowBuilderDelegate(
rowCount: 0,
nodeBuilder: (_, __) => const SizedBox(),
rowBuilder: (_) => const TreeRow(
extent: FixedTreeRowExtent(40.0),
),
),
activeAnimations: const <UniqueKey, TreeViewNodesAnimation>{},
rowDepths: const <int, int>{},
indentation: 0.0,
traversalOrder: TreeViewTraversalOrder.depthFirst,
childManager: _NullBuildContext(),
);
expect(treeViewport.mainAxis, Axis.vertical);
expect(treeViewport.traversalOrder, TreeViewTraversalOrder.depthFirst);

treeViewport = RenderTreeViewport(
verticalOffset: TestOffset(),
verticalAxisDirection: AxisDirection.down,
horizontalOffset: TestOffset(),
horizontalAxisDirection: AxisDirection.right,
delegate: TreeRowBuilderDelegate(
rowCount: 0,
nodeBuilder: (_, __) => const SizedBox(),
rowBuilder: (_) => const TreeRow(
extent: FixedTreeRowExtent(40.0),
),
),
activeAnimations: const <UniqueKey, TreeViewNodesAnimation>{},
rowDepths: const <int, int>{},
indentation: 0.0,
traversalOrder: TreeViewTraversalOrder.breadthFirst,
childManager: _NullBuildContext(),
);
expect(treeViewport.mainAxis, Axis.horizontal);
expect(treeViewport.traversalOrder, TreeViewTraversalOrder.breadthFirst);
});

testWidgets('TreeRow gesture hit testing', (WidgetTester tester) async {
int tapCounter = 0;
final List<String> log = <String>[];
Expand Down

0 comments on commit d56702e

Please sign in to comment.