update pagination listener

2024-01-23 17:48:34 +06:30
parent f3f75a80c6
commit 5ec51c31fd
13 changed files with 186 additions and 181 deletions
--- a/lib/pagination/paginator_listener.dart
+++ b/lib/pagination/paginator_listener.dart
@@ -1,9 +1,11 @@
 import 'dart:async';

 import 'package:cloud_firestore/cloud_firestore.dart';
-import 'package:fcs/pages/widgets/callbacks.dart';
+import 'package:flutter/foundation.dart';
 import 'package:logging/logging.dart';

+import '../pages/widgets/callbacks.dart';
+
 typedef ToObj = Function(Map<String, dynamic> data, String id);

 /*
@@ -11,7 +13,7 @@ typedef ToObj = Function(Map<String, dynamic> data, String id);
 * and listen to document change based on 'update_time' and 'delete_time' fields
 * of the document
 */
-class PaginatorListener<T> {
+class PaginatorListener<T> extends ChangeNotifier {
  final log = Logger('PaginatorListener');

  List<String> ids = [];
@@ -25,15 +27,18 @@ class PaginatorListener<T> {
  CallBack? onChange;

  StreamSubscription<QuerySnapshot>? listener;
-  Query? listeningQuery;
-  Query? pageQuery;
+  Query listeningQuery;
+  Query pageQuery;
+  bool Function(T obj)? removeOnDataChange;

-  PaginatorListener(this.toObj,
-      {this.onChange, this.rowPerLoad = 10, this.insertNewByListener = false});
+  PaginatorListener(this.listeningQuery, this.pageQuery, this.toObj,
+      {this.rowPerLoad = 10,
+      this.insertNewByListener = true,
+      this.removeOnDataChange}) {
+    refresh();
+  }

-  Future<bool> refresh({Query? listeningQuery, Query? pageQuery}) {
-    this.listeningQuery = listeningQuery ?? this.listeningQuery;
-    this.pageQuery = pageQuery ?? this.pageQuery;
+  Future<bool> refresh() {
    _clearState();
    _initListener();
    return _load();
@@ -45,8 +50,9 @@ class PaginatorListener<T> {
    data = [];
    ended = false;
    isLoading = false;
-    if (listener != null) listener!.cancel();
+    listener?.cancel();
    listener = null;
+    notifyListeners();
  }

  void close() {
@@ -58,26 +64,25 @@ class PaginatorListener<T> {
  final String isDeletedField = 'is_deleted';
  void _initListener() {
    Query _query =
-        listeningQuery!.orderBy(updateTimeField, descending: true).limit(1);
+        listeningQuery.orderBy(updateTimeField, descending: true).limit(1);
    _query
-        .get(GetOptions(source: Source.server))
+        .get(const GetOptions(source: Source.server))
        .then((QuerySnapshot snapshot) {
      int count = snapshot.docs.length;
      int updateTime = 0;
      if (count == 1) {
-        Map<String, dynamic> data =
-            snapshot.docs[0].data()! as Map<String, dynamic>;
-        updateTime = data[updateTimeField];
+        updateTime =
+            (snapshot.docs[0].data() as Map<String, dynamic>)[updateTimeField];
      }

-      Query _queryListener = listeningQuery!
+      Query _queryListener = listeningQuery
          .where(updateTimeField, isGreaterThan: updateTime)
+          // .where(deleteTimeField, isEqualTo: 0)
          .orderBy(updateTimeField, descending: true);

-      if (listener != null) listener!.cancel();
      listener =
          _queryListener.snapshots(includeMetadataChanges: true).listen((qs) {
-        qs.docChanges.forEach((c) {
+        for (var c in qs.docChanges) {
          switch (c.type) {
            case DocumentChangeType.added:
              _update(c.doc.id, c.doc.data() as Map<String, dynamic>);
@@ -91,7 +96,8 @@ class PaginatorListener<T> {
            default:
          }
          if (onChange != null) onChange!();
-        });
+          notifyListeners();
+        }
      });
    });
  }
@@ -104,11 +110,15 @@ class PaginatorListener<T> {
      if ((deleted ?? 0) > 0 || (isDeleted ?? false)) {
        data.removeAt(ids.indexOf(id));
        ids.remove(id);
+      } else if (removeOnDataChange != null && removeOnDataChange!(t)) {
+        data.removeAt(ids.indexOf(id));
+        ids.remove(id);
      } else {
        data.removeAt(ids.indexOf(id));
        data.insert(ids.indexOf(id), t);
      }
    } else if (insertNewByListener) {
+      if (removeOnDataChange != null && removeOnDataChange!(t)) return;
      data.insert(0, t);
      ids.insert(0, id);
    }
@@ -130,37 +140,38 @@ class PaginatorListener<T> {
  }

  Future<bool> loadMore() {
-    return this._load();
+    return _load();
  }

  Future<bool> _load({CallBack? onStarted, CallBack? onFinished}) async {
    if (ended) return ended;
    Query _query =
-        prev != null ? pageQuery!.startAfterDocument(prev!) : pageQuery!;
+        prev != null ? pageQuery.startAfterDocument(prev!) : pageQuery;
    try {
      isLoading = true;
      if (onStarted != null) {
        onStarted();
      }
      if (onChange != null) onChange!();
-      await _query
-          .where(isDeletedField, isEqualTo: false)
+      notifyListeners();
+      QuerySnapshot snapshot = await _query
+          .where(deleteTimeField, isEqualTo: 0)
          .limit(rowPerLoad)
-          .get(GetOptions(source: Source.server))
-          .then((QuerySnapshot snapshot) {
-        int count = snapshot.docs.length;
-        ended = count < rowPerLoad;
-        prev = count > 0 ? snapshot.docs[count - 1] : prev;
-        snapshot.docs.forEach((e) {
-          _add(e.id, e.data() as Map<String, dynamic>);
-        });
-      });
+          .get(const GetOptions(source: Source.server));
+
+      int count = snapshot.docs.length;
+      ended = count < rowPerLoad;
+      prev = count > 0 ? snapshot.docs[count - 1] : prev;
+      for (var e in snapshot.docs) {
+        _add(e.id, e.data() as Map<String, dynamic>);
+      }
    } catch (e) {
      log.warning("Error!! $e");
    } finally {
      isLoading = false;
      if (onFinished != null) onFinished();
      if (onChange != null) onChange!();
+      notifyListeners();
    }
    return ended;
  }
--- a/lib/pagination/paginator_listview.dart
+++ b/lib/pagination/paginator_listview.dart
@@ -1,4 +1,3 @@
-import 'package:flutter/cupertino.dart';
 import 'package:flutter/material.dart';
 import 'package:flutter/rendering.dart';

@@ -6,20 +5,25 @@ import 'paginator_listener.dart';

 typedef RowBuilder = Widget Function(dynamic);
 typedef OnScroll = void Function(bool down);
+typedef OnRemove = Function(dynamic t);

-class PaginatorListView<T> extends StatelessWidget {
+class PaginatorListView<T> extends StatefulWidget {
  final PaginatorListener<T> paginatorListener;
  final RowBuilder rowBuilder;
  final OnScroll? onScroll;
  final ScrollController _scrollController;
  final Color color;
+  final OnRemove? onRemove;
+  final Widget? noMoreData;

  PaginatorListView(
      {Key? key,
      required this.paginatorListener,
      required this.rowBuilder,
      this.onScroll,
-      this.color = Colors.blueAccent})
+      this.color = Colors.blueAccent,
+      this.noMoreData,
+      this.onRemove})
      : _scrollController = ScrollController(),
        super(key: key) {
    _scrollController.addListener(() async {
@@ -35,10 +39,37 @@ class PaginatorListView<T> extends StatelessWidget {
    });
  }

+  @override
+  State<PaginatorListView<T>> createState() => _PaginatorListViewState<T>();
+}
+
+class _PaginatorListViewState<T> extends State<PaginatorListView<T>> {
+  late PaginatorListener<T> _paginatorListener;
+  @override
+  initState() {
+    super.initState();
+    initListener();
+  }
+
+  @override
+  void didUpdateWidget(covariant PaginatorListView<T> oldWidget) {
+    super.didUpdateWidget(oldWidget);
+    initListener();
+  }
+
+  initListener() {
+    _paginatorListener = widget.paginatorListener;
+    widget.paginatorListener.addListener(() {
+      if (mounted) {
+        setState(() {});
+      }
+    });
+  }
+
  @override
  Widget build(BuildContext context) {
-    bool ended = paginatorListener.ended;
-    int count = paginatorListener.data.length;
+    bool ended = _paginatorListener.ended;
+    int count = _paginatorListener.data.length;
    if (ended) count++;

    return Column(
@@ -46,12 +77,12 @@ class PaginatorListView<T> extends StatelessWidget {
        Expanded(
          child: RefreshIndicator(
            onRefresh: () {
-              return paginatorListener.refresh();
+              return _paginatorListener.refresh();
            },
            child: ListView.separated(
                separatorBuilder: (context, index) =>
                    Divider(height: 1, color: Colors.black),
-                controller: _scrollController,
+                controller: widget._scrollController,
                scrollDirection: Axis.vertical,
                physics: const AlwaysScrollableScrollPhysics(),
                shrinkWrap: true,
@@ -60,22 +91,24 @@ class PaginatorListView<T> extends StatelessWidget {
                  if (ended && index == count - 1) {
                    return Padding(
                      padding: const EdgeInsets.all(8.0),
-                      child: Center(child: Text("No more data")),
+                      child: Center(
+                          child:
+                              widget.noMoreData ?? const Text("No more data")),
                    );
                  }
-                  T t = paginatorListener.data[index];
-                  return rowBuilder(t);
+                  T t = _paginatorListener.data[index];
+                  return widget.rowBuilder(t);
                }),
          ),
        ),
-        paginatorListener.isLoading ? _loadingRow() : Container()
+        _paginatorListener.isLoading ? _loadingRow() : Container()
      ],
    );
  }

  Widget _loadingRow() {
    return Container(
-      padding: EdgeInsets.all(8),
+      padding: const EdgeInsets.all(8),
      color: Colors.transparent,
      child: Row(
        mainAxisAlignment: MainAxisAlignment.center,
@@ -83,10 +116,10 @@ class PaginatorListView<T> extends StatelessWidget {
          Column(
            children: [
              CircularProgressIndicator(
-                  valueColor: new AlwaysStoppedAnimation<Color>(color)),
+                  valueColor: AlwaysStoppedAnimation<Color>(widget.color)),
              Text(
                "Loading...",
-                style: TextStyle(color: color),
+                style: TextStyle(color: widget.color),
              )
            ],
          ),