From 9d59e59e4d75539c1749996871ac25ffbfcc9455 Mon Sep 17 00:00:00 2001 From: Sai Naw Wun Date: Thu, 15 Oct 2020 19:40:03 +0630 Subject: [PATCH] add paginator --- .../{pagination.dart => paginator.dart} | 48 +++--- lib/pages/fcs_shipment/fcs_shipment_list.dart | 80 +++++++--- .../model/fcs_shipment_model.dart | 58 ++++++- lib/pages/package/model/package_model.dart | 146 +++++++++++------- lib/pages/package/package_list.dart | 69 +++++---- 5 files changed, 259 insertions(+), 142 deletions(-) rename lib/helpers/{pagination.dart => paginator.dart} (56%) diff --git a/lib/helpers/pagination.dart b/lib/helpers/paginator.dart similarity index 56% rename from lib/helpers/pagination.dart rename to lib/helpers/paginator.dart index 56a60d8..cb89f15 100644 --- a/lib/helpers/pagination.dart +++ b/lib/helpers/paginator.dart @@ -1,50 +1,50 @@ import 'dart:async'; import 'package:cloud_firestore/cloud_firestore.dart'; +import 'package:fcs/pages/widgets/callbacks.dart'; import 'package:logging/logging.dart'; +typedef ToObj = Function(Map data, String id); + /* * Pagination load data in page */ -class Pagination { - final log = Logger('PaginationModel'); +class Paginator { + final log = Logger('Paginator'); final int rowPerLoad; DocumentSnapshot prev; bool ended = false; + bool isLoading = false; + List values = []; + ToObj toObj; Query pageQuery; - Pagination(Query pageQuery, {this.rowPerLoad = 20}) { - this.pageQuery = pageQuery; - initData(); - } - - void initData() async { + Paginator(this.pageQuery, {this.rowPerLoad = 20, this.toObj}) { _clearState(); - load(); } void _clearState() { prev = null; ended = false; - if (controller != null) controller.close(); - } - - StreamController controller; - Stream get stream { - if (controller != null) { - controller.close(); - } - controller = StreamController(onCancel: _clearState); - return controller.stream; + isLoading = false; + values = []; } void close() { _clearState(); } - Future load() async { + Future refresh({CallBack onFinished}) async { + _clearState(); + await load(); + if (onFinished != null) onFinished(); + } + + Future load({CallBack onFinished}) async { + if (ended) return null; + isLoading = true; Query _query = prev != null ? pageQuery.startAfterDocument(prev) : pageQuery; try { @@ -56,14 +56,14 @@ class Pagination { ended = count < rowPerLoad; prev = count > 0 ? snapshot.documents[count - 1] : prev; snapshot.documents.forEach((e) { - controller.add(e); + values.add(toObj(e.data, e.documentID)); }); - if (ended) { - controller.add(null); - } }); } catch (e) { log.warning("Error!! $e"); + } finally { + isLoading = false; + if (onFinished != null) onFinished(); } return ended; } diff --git a/lib/pages/fcs_shipment/fcs_shipment_list.dart b/lib/pages/fcs_shipment/fcs_shipment_list.dart index 8303721..b983e2b 100644 --- a/lib/pages/fcs_shipment/fcs_shipment_list.dart +++ b/lib/pages/fcs_shipment/fcs_shipment_list.dart @@ -1,13 +1,13 @@ +import 'package:fcs/helpers/paginator.dart'; import 'package:fcs/helpers/theme.dart'; -import 'package:fcs/localization/app_translations.dart'; import 'package:fcs/pages/fcs_shipment/model/fcs_shipment_model.dart'; -import 'package:fcs/pages/widgets/bottom_up_page_route.dart'; +import 'package:fcs/pages/widgets/local_popup_menu_button.dart'; +import 'package:fcs/pages/widgets/local_popupmenu.dart'; import 'package:fcs/pages/widgets/local_text.dart'; import 'package:fcs/pages/widgets/progress.dart'; import 'package:flutter/cupertino.dart'; -import 'package:provider/provider.dart'; - import 'package:flutter/material.dart'; +import 'package:provider/provider.dart'; import 'fcs_shipment_editor.dart'; import 'fcs_shipment_list_row.dart'; @@ -19,21 +19,39 @@ class FcsShipmentList extends StatefulWidget { class _FcsShipmentListState extends State { bool _isLoading = false; + var _controller = ScrollController(); @override void initState() { super.initState(); - } - @override - void dispose() { - super.dispose(); + _controller.addListener(() async { + if (_controller.position.pixels == _controller.position.maxScrollExtent) { + Provider.of(context, listen: false).loadMore(); + } + }); } @override Widget build(BuildContext context) { var shipmentModel = Provider.of(context); + final popupMenu = LocalPopupMenuButton( + popmenus: [ + LocalPopupMenu( + id: 1, + textKey: "package.popupmenu.active", + selected: shipmentModel.selectedIndex == 1), + LocalPopupMenu( + id: 2, + textKey: "package.popupmenu.delivered", + selected: shipmentModel.selectedIndex == 2) + ], + popupMenuCallback: (p) => this.setState(() { + shipmentModel.selectedIndex = p.id; + }), + ); + return LocalProgress( inAsyncCall: _isLoading, child: Scaffold( @@ -46,6 +64,7 @@ class _FcsShipmentListState extends State { backgroundColor: primaryColor, title: LocalText(context, 'FCSshipment.list.title', color: Colors.white, fontSize: 20), + actions: [popupMenu], ), floatingActionButton: FloatingActionButton.extended( onPressed: () { @@ -58,20 +77,39 @@ class _FcsShipmentListState extends State { body: Column( children: [ Expanded( - child: new ListView.separated( - separatorBuilder: (context, index) => Divider( - color: Colors.black, - ), - scrollDirection: Axis.vertical, - padding: EdgeInsets.only(top: 15), - shrinkWrap: true, - itemCount: shipmentModel.fcsShipments.length, - itemBuilder: (BuildContext context, int index) { - return FcsShipmentListRow( - key: ValueKey(shipmentModel.fcsShipments[index].id), - shipment: shipmentModel.fcsShipments[index]); - }), + child: RefreshIndicator( + child: ListView.separated( + physics: AlwaysScrollableScrollPhysics(), + controller: _controller, + separatorBuilder: (context, index) => Divider( + color: Colors.black, + ), + scrollDirection: Axis.vertical, + padding: EdgeInsets.only(top: 15), + shrinkWrap: true, + itemCount: shipmentModel.fcsShipments.length, + itemBuilder: (BuildContext context, int index) { + return FcsShipmentListRow( + key: ValueKey( + shipmentModel.fcsShipments[index].id), + shipment: shipmentModel.fcsShipments[index]); + }), + onRefresh: () => shipmentModel.refresh(), + ), ), + shipmentModel.isLoading + ? Container( + padding: EdgeInsets.all(8), + color: primaryColor, + child: Row( + mainAxisAlignment: MainAxisAlignment.center, + children: [ + Text("Loading...", + style: TextStyle(color: Colors.white)), + ], + ), + ) + : Container(), ], ))); } diff --git a/lib/pages/fcs_shipment/model/fcs_shipment_model.dart b/lib/pages/fcs_shipment/model/fcs_shipment_model.dart index d0da185..dd1d8ec 100644 --- a/lib/pages/fcs_shipment/model/fcs_shipment_model.dart +++ b/lib/pages/fcs_shipment/model/fcs_shipment_model.dart @@ -4,6 +4,7 @@ import 'package:cloud_firestore/cloud_firestore.dart'; import 'package:fcs/data/services/services.dart'; import 'package:fcs/domain/constants.dart'; import 'package:fcs/domain/entities/fcs_shipment.dart'; +import 'package:fcs/helpers/paginator.dart'; import 'package:fcs/pages/main/model/base_model.dart'; import 'package:logging/logging.dart'; @@ -11,27 +12,43 @@ class FcsShipmentModel extends BaseModel { final log = Logger('FcsShipmentModel'); StreamSubscription listener; - List fcsShipments = []; + List _fcsShipments = []; + List get fcsShipments => _selectedIndex == 1 + ? _fcsShipments + : List.from(_delivered.values); + + Paginator _delivered; + bool isLoading = false; + int _selectedIndex = 1; + set selectedIndex(int index) { + _selectedIndex = index; + notifyListeners(); + } + + get selectedIndex => _selectedIndex; @override void privilegeChanged() { super.privilegeChanged(); _loadFcsShipments(); + + if (_delivered != null) _delivered.close(); + _delivered = _getDelivered(); } Future _loadFcsShipments() async { if (user == null || !user.hasFcsShipments()) return; String path = "/$fcs_shipment_collection/"; if (listener != null) listener.cancel(); - fcsShipments = []; + _fcsShipments = []; try { listener = Firestore.instance .collection("$path") .orderBy("shipment_number", descending: true) .snapshots() .listen((QuerySnapshot snapshot) { - fcsShipments.clear(); - fcsShipments = snapshot.documents.map((documentSnapshot) { + _fcsShipments.clear(); + _fcsShipments = snapshot.documents.map((documentSnapshot) { var s = FcsShipment.fromMap( documentSnapshot.data, documentSnapshot.documentID); return s; @@ -43,6 +60,36 @@ class FcsShipmentModel extends BaseModel { } } + Paginator _getDelivered() { + if (user == null || !user.hasFcsShipments()) return null; + + var pageQuery = Firestore.instance + .collection("/$fcs_shipment_collection") + .where("is_delivered", isEqualTo: true) + .where("is_deleted", isEqualTo: false) + .orderBy("current_status_date", descending: true); + var paginator = new Paginator(pageQuery, rowPerLoad: 20, toObj: (data, id) { + return FcsShipment.fromMap(data, id); + }); + return paginator; + } + + Future loadMore() async { + if (_delivered.ended) return; + isLoading = true; + notifyListeners(); + await _delivered.load(onFinished: () { + isLoading = false; + notifyListeners(); + }); + } + + Future refresh() async { + await _delivered.refresh(onFinished: () { + notifyListeners(); + }); + } + void initUser(user) { super.initUser(user); } @@ -50,7 +97,8 @@ class FcsShipmentModel extends BaseModel { @override logout() async { if (listener != null) await listener.cancel(); - fcsShipments = []; + if (_delivered != null) _delivered.close(); + _fcsShipments = []; } Future create(FcsShipment fcsShipment) { diff --git a/lib/pages/package/model/package_model.dart b/lib/pages/package/model/package_model.dart index 140f655..37e73e5 100644 --- a/lib/pages/package/model/package_model.dart +++ b/lib/pages/package/model/package_model.dart @@ -1,102 +1,132 @@ import 'dart:async'; import 'dart:io'; -import 'package:fcs/data/services/services.dart'; -import 'package:fcs/domain/vo/delivery_address.dart'; -import 'package:fcs/domain/vo/message.dart'; -import 'package:fcs/helpers/pagination.dart'; -import 'package:path/path.dart' as Path; import 'package:cloud_firestore/cloud_firestore.dart'; +import 'package:fcs/data/services/services.dart'; import 'package:fcs/domain/constants.dart'; import 'package:fcs/domain/entities/package.dart'; import 'package:fcs/domain/entities/user.dart'; +import 'package:fcs/domain/vo/delivery_address.dart'; +import 'package:fcs/domain/vo/message.dart'; import 'package:fcs/helpers/firebase_helper.dart'; +import 'package:fcs/helpers/paginator.dart'; import 'package:fcs/pages/main/model/base_model.dart'; import 'package:logging/logging.dart'; +import 'package:path/path.dart' as Path; class PackageModel extends BaseModel { final log = Logger('PackageModel'); StreamSubscription listener; StreamSubscription customerPackageListener; - Pagination pagination; - List packages = []; - List customerPackages = []; - List deliveredPackages = []; + List get packages => + _selectedIndex == 1 ? _packages : List.from(_delivered.values); + List get customerPackages => _selectedIndex == 1 + ? _customerPackages + : List.from(_customerDelivered.values); - bool endOfDeliveredPackages = false; + List _packages = []; + List _customerPackages = []; + + Paginator _delivered; + Paginator _customerDelivered; bool isLoading = false; + bool isPackagesEnded = false; + bool isCustomerPackagesEnded = false; + int _selectedIndex = 1; + set selectedIndex(int index) { + _selectedIndex = index; + notifyListeners(); + } + + get selectedIndex => _selectedIndex; @override void privilegeChanged() { super.privilegeChanged(); _loadPackages(); _loadCustomerPackages(); + + if (_delivered != null) _delivered.close(); + _delivered = _getDeliveredExample(false); + loadMore(isCustomer: false); + if (_customerDelivered != null) _customerDelivered.close(); + _customerDelivered = _getDeliveredExample(false); + loadMore(isCustomer: true); } @override logout() async { + if (_delivered != null) _delivered.close(); + if (_customerDelivered != null) _customerDelivered.close(); if (listener != null) await listener.cancel(); if (customerPackageListener != null) await customerPackageListener.cancel(); - if (pagination != null) pagination.close(); - packages = []; - customerPackages = []; - deliveredPackages = []; + _packages = []; + _customerPackages = []; } - Future initDeliveredPackages(bool onlyFcs) { - if (onlyFcs) { + Future loadMore({bool isCustomer}) async { + if (selectedIndex == 1) + return; // when delivered menu is not selected return + var p = isCustomer ? _customerDelivered : _delivered; + if (p.ended) return; + isLoading = true; + notifyListeners(); + await p.load(onFinished: () { + isLoading = false; + notifyListeners(); + }); + } + + Future refresh({bool isCustomer}) async { + if (selectedIndex == 1) + return; // when delivered menu is not selected return + var p = isCustomer ? _customerDelivered : _delivered; + await p.refresh(onFinished: () { + notifyListeners(); + }); + } + + Paginator _getDelivered(bool isCustomer) { + if (!isCustomer) { if (user == null || !((user.hasPackages() || user.hasReceiving() || - user.hasProcessing()))) return null; + user.hasProcessing()))) throw "No privilege"; } - if (pagination != null) pagination.close(); - deliveredPackages = []; - endOfDeliveredPackages = false; - isLoading = false; - var pageQuery = Firestore.instance .collection("/$packages_collection") - // .collection( - // "/users/8OTfsbVvsUOn1SLxy1OrKk7Y_yNKkVoGalPcIlcHnAY/messages") - // .orderBy("date", descending: true); .where("is_delivered", isEqualTo: true) .where("is_deleted", isEqualTo: false); - if (!onlyFcs) { + if (isCustomer) { pageQuery = pageQuery.where("user_id", isEqualTo: user.id); } pageQuery = pageQuery.orderBy("current_status_date", descending: true); - pagination = new Pagination(pageQuery, rowPerLoad: 20); - pagination.stream.listen((doc) { - if (doc == null) { - endOfDeliveredPackages = true; - } else { - deliveredPackages.add(Package.fromMap(doc.data, doc.documentID)); - // var m = Message.fromMap(doc.data, doc.documentID); - // deliveredPackages.add(Package( - // id: m.id, - // status: package_delivered_status, - // currentStatus: package_delivered_status, - // currentStatusDate: m.date, - // trackingID: (count++).toString(), - // market: m.message)); - } + var paginator = new Paginator(pageQuery, rowPerLoad: 20, toObj: (data, id) { + return Package.fromMap(data, id); }); - return null; + return paginator; } - Future loadMoreDeliveredPackages() { - if (pagination != null && !isLoading && !endOfDeliveredPackages) { - isLoading = true; - notifyListeners(); - pagination.load().then((value) { - isLoading = false; - notifyListeners(); - }); - } - return null; + int count = 0; + Paginator _getDeliveredExample(bool onlyFcs) { + count = 1; + var pageQuery = Firestore.instance + .collection( + "/users/8OTfsbVvsUOn1SLxy1OrKk7Y_yNKkVoGalPcIlcHnAY/messages") + .orderBy("date", descending: true); + var paginator = new Paginator(pageQuery, rowPerLoad: 20, toObj: (data, id) { + var m = Message.fromMap(data, id); + return Package( + id: m.id, + status: package_delivered_status, + currentStatus: package_delivered_status, + currentStatusDate: m.date, + trackingID: (count++).toString(), + market: m.message); + }); + return paginator; } Future _loadPackages() async { @@ -105,7 +135,7 @@ class PackageModel extends BaseModel { return; String path = "/$packages_collection"; if (listener != null) listener.cancel(); - packages = []; + _packages = []; try { var q = Firestore.instance @@ -114,8 +144,8 @@ class PackageModel extends BaseModel { .where("is_deleted", isEqualTo: false); listener = q.snapshots().listen((QuerySnapshot snapshot) { - packages.clear(); - packages = snapshot.documents.map((documentSnapshot) { + _packages.clear(); + _packages = snapshot.documents.map((documentSnapshot) { var package = Package.fromMap( documentSnapshot.data, documentSnapshot.documentID); return package; @@ -131,7 +161,7 @@ class PackageModel extends BaseModel { if (user == null) return; String path = "/$packages_collection"; if (customerPackageListener != null) customerPackageListener.cancel(); - customerPackages = []; + _customerPackages = []; try { var q = Firestore.instance @@ -141,8 +171,8 @@ class PackageModel extends BaseModel { .where("user_id", isEqualTo: user.id); customerPackageListener = q.snapshots().listen((QuerySnapshot snapshot) { - customerPackages.clear(); - customerPackages = snapshot.documents.map((documentSnapshot) { + _customerPackages.clear(); + _customerPackages = snapshot.documents.map((documentSnapshot) { var package = Package.fromMap( documentSnapshot.data, documentSnapshot.documentID); return package; diff --git a/lib/pages/package/package_list.dart b/lib/pages/package/package_list.dart index 8bce68e..ad400f0 100644 --- a/lib/pages/package/package_list.dart +++ b/lib/pages/package/package_list.dart @@ -1,10 +1,10 @@ import 'package:fcs/domain/entities/package.dart'; +import 'package:fcs/helpers/paginator.dart'; import 'package:fcs/helpers/theme.dart'; import 'package:fcs/pages/package/model/package_model.dart'; import 'package:fcs/pages/package/package_info.dart'; import 'package:fcs/pages/package/package_list_row.dart'; import 'package:fcs/pages/package_search/package_serach.dart'; -import 'package:fcs/pages/widgets/bottom_up_page_route.dart'; import 'package:fcs/pages/widgets/local_popup_menu_button.dart'; import 'package:fcs/pages/widgets/local_popupmenu.dart'; import 'package:fcs/pages/widgets/local_text.dart'; @@ -23,43 +23,40 @@ class PackageList extends StatefulWidget { class _PackageListState extends State { bool _isLoading = false; - bool _showDelivered = false; var _controller = ScrollController(); @override void initState() { super.initState(); - Provider.of(context, listen: false) - .initDeliveredPackages(widget.onlyFcs); - _controller.addListener(() { - if (_showDelivered && - _controller.position.pixels == _controller.position.maxScrollExtent) { + + _controller.addListener(() async { + if (_controller.position.pixels == _controller.position.maxScrollExtent) { Provider.of(context, listen: false) - .loadMoreDeliveredPackages(); + .loadMore(isCustomer: !widget.onlyFcs); } }); } - @override - void dispose() { - super.dispose(); - } - @override Widget build(BuildContext context) { var packageModel = Provider.of(context); bool onlyFcs = widget.onlyFcs; - var packages = _showDelivered - ? packageModel.deliveredPackages - : onlyFcs ? packageModel.packages : packageModel.customerPackages; + var packages = + onlyFcs ? packageModel.packages : packageModel.customerPackages; + final popupMenu = LocalPopupMenuButton( popmenus: [ LocalPopupMenu( - id: 1, textKey: "package.popupmenu.active", selected: true), - LocalPopupMenu(id: 2, textKey: "package.popupmenu.delivered") + id: 1, + textKey: "package.popupmenu.active", + selected: packageModel.selectedIndex == 1), + LocalPopupMenu( + id: 2, + textKey: "package.popupmenu.delivered", + selected: packageModel.selectedIndex == 2) ], popupMenuCallback: (p) => this.setState(() { - _showDelivered = p.id == 2; + packageModel.selectedIndex = p.id; }), ); @@ -97,21 +94,25 @@ class _PackageListState extends State { body: Column( children: [ Expanded( - child: ListView.separated( - controller: _controller, - separatorBuilder: (context, index) => Divider( - color: Colors.black, - ), - scrollDirection: Axis.vertical, - padding: EdgeInsets.only(top: 15), - shrinkWrap: true, - itemCount: packages.length, - itemBuilder: (BuildContext context, int index) { - return PackageListRow( - key: ValueKey(packages[index].id), - package: packages[index], - ); - }), + child: RefreshIndicator( + child: ListView.separated( + controller: _controller, + separatorBuilder: (context, index) => Divider( + color: Colors.black, + ), + scrollDirection: Axis.vertical, + padding: EdgeInsets.only(top: 15), + shrinkWrap: true, + itemCount: packages.length, + itemBuilder: (BuildContext context, int index) { + return PackageListRow( + key: ValueKey(packages[index].id), + package: packages[index], + ); + }), + onRefresh: () => + packageModel.refresh(isCustomer: !widget.onlyFcs), + ), ), packageModel.isLoading ? Container(