UpdatableDataViewSetting<T> class
A list of behavior and display settings for UpdatableDataView.
Constructors
-
UpdatableDataViewSetting({EdgeInsetsGeometry? padding, ScrollPhysics? physics = const AlwaysScrollableScrollPhysics(), bool? reverse = false, bool? shrinkWrap = false, double? cacheExtent, DragStartBehavior? dragStartBehavior = DragStartBehavior.start, ScrollViewKeyboardDismissBehavior? keyboardDismissBehavior = ScrollViewKeyboardDismissBehavior.manual, String? restorationId, Clip? clipBehavior = Clip.hardEdge, bool? wantKeepAlive = true, Duration? flashListDuration = kFlashListDuration, bool? scrollbar = true, bool? alwaysShowScrollbar = false, bool? interactiveScrollbar = false, Radius? scrollbarRadius, double? scrollbarThickness, double? scrollbarMainAxisMargin, double? scrollbarCrossAxisMargin, EdgeInsets? scrollbarExtraMargin, Color? refreshIndicatorColor, Color? refreshIndicatorBackgroundColor, double? refreshIndicatorDisplacement = 40.0, double? refreshIndicatorStrokeWidth = RefreshProgressIndicator.defaultStrokeWidth, ScrollNotificationPredicate? refreshNotificationPredicate = defaultScrollNotificationPredicate, Color? appendIndicatorColor, Color? appendIndicatorBackgroundColor, double? appendIndicatorMinHeight = 5.0, ScrollNotificationPredicate? appendNotificationPredicate = defaultScrollNotificationPredicate, PlaceholderSetting? placeholderSetting = const PlaceholderSetting(), PlaceholderDisplayRule? placeholderDisplayRule = PlaceholderDisplayRule.dataFirst, PlaceholderStateChangedCallback? onPlaceholderStateChanged, bool? refreshFirst = true, bool? clearWhenRefresh = false, bool? clearWhenError = false, bool? updateOnlyIfNotEmpty = false, bool? ensureKeepScrollOffsetWhenAppend = false, bool? automaticallyScrollDownWhenAppend = true, void onStartRefreshing()?, void onStartGettingData()?, void onAppend(dynamic indicator, List<
T> appendedData)?, void onError(dynamic error)?, void onStopGettingData()?, void onStopRefreshing()?, void onFinalSetState()?}) -
const
Properties
- alwaysShowScrollbar → bool?
-
The check to always show Scrollbar, defaults to false.
final
- appendIndicatorBackgroundColor → Color?
-
The BackgroundColor for AppendIndicator, only used for pagination.
final
- appendIndicatorColor → Color?
-
The Color for AppendIndicator, only used for pagination.
final
- appendIndicatorMinHeight → double?
-
The MinHeight for AppendIndicator, defaults to 5.0, only used for pagination.
final
- appendNotificationPredicate → ScrollNotificationPredicate?
-
The notificationPredicate for AppendIndicator, defaults to defaultScrollNotificationPredicate, only used for pagination.
final
- automaticallyScrollDownWhenAppend → bool?
-
The flag to scroll down automatically when data appended, defaults to true, only used for pagination.
final
- cacheExtent → double?
-
The cacheExtent for ScrollView.
final
- clearWhenError → bool?
-
The switcher to clear list when error aroused, defaults to false.
final
- clearWhenRefresh → bool?
-
The switcher to clear list and error message when refresh data, defaults to false.
final
- clipBehavior → Clip?
-
The clipBehavior for ScrollView, defaults to Clip.hardEdge.
final
- dragStartBehavior → DragStartBehavior?
-
The dragStartBehavior for ScrollView, defaults to DragStartBehavior.start.
final
- ensureKeepScrollOffsetWhenAppend → bool?
-
The flag to ensure keeping scroll offset when data appended, default to false, only used for pagination.
final
- flashListDuration → Duration?
-
The duration to flash the displaying of ScrollView when refreshing, defaults to kFlashListDuration.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- interactiveScrollbar → bool?
-
The interactive for Scrollbar, defaults to false, you must pass non-null ScrollController if you set this to true.
final
- keyboardDismissBehavior → ScrollViewKeyboardDismissBehavior?
-
The keyboardDismissBehavior for ScrollView, defaults to ScrollViewKeyboardDismissBehavior.manual.
final
-
onAppend
→ (void Function(dynamic indicator, List<
T> appendedData)?) -
The callback when data has been replaced or appended.
final
- onError → (void Function(dynamic error)?)
-
The callback when error aroused.
final
- onFinalSetState → (void Function()?)
-
The callback when final setState is called.
final
- onPlaceholderStateChanged → PlaceholderStateChangedCallback?
-
The callback when PlaceholderText state changed.
final
- onStartGettingData → (void Function()?)
-
The callback when start getting data.
final
- onStartRefreshing → (void Function()?)
-
The callback when start refreshing.
final
- onStopGettingData → (void Function()?)
-
The callback when stop getting data.
final
- onStopRefreshing → (void Function()?)
-
The callback when stop refreshing.
final
- padding → EdgeInsetsGeometry?
-
The padding for ScrollView.
final
- physics → ScrollPhysics?
-
The physics for ScrollView, defaults to AlwaysScrollableScrollPhysics().
final
- placeholderDisplayRule → PlaceholderDisplayRule?
-
The display rule for PlaceholderText, defaults to PlaceholderDisplayRule.dataFirst.
final
- placeholderSetting → PlaceholderSetting?
-
The setting for PlaceholderText, defaults to PlaceholderSetting().
final
- refreshFirst → bool?
-
The switcher to do refresh when init view, defaults to true.
final
- refreshIndicatorBackgroundColor → Color?
-
The background color for RefreshIndicator, defaults to ThemeData.canvasColor.
final
- refreshIndicatorColor → Color?
-
The color for RefreshIndicator, defaults to ColorScheme.primary.
final
- refreshIndicatorDisplacement → double?
-
The displacement for RefreshIndicator, defaults to 40.0.
final
- refreshIndicatorStrokeWidth → double?
-
The stroke width for RefreshIndicator, defaults to RefreshProgressIndicator.defaultStrokeWidth.
final
- refreshNotificationPredicate → ScrollNotificationPredicate?
-
The notificationPredicate for RefreshIndicator, defaults to defaultScrollNotificationPredicate.
final
- restorationId → String?
-
The restorationId for ScrollView.
final
- reverse → bool?
-
The reverse for ScrollView, defaults to false.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- scrollbar → bool?
-
The visibility for Scrollbar, defaults to true.
final
- scrollbarCrossAxisMargin → double?
-
The crossAxisMargin for Scrollbar.
final
- scrollbarExtraMargin → EdgeInsets?
-
The extraMargin for Scrollbar.
final
- scrollbarMainAxisMargin → double?
-
The mainAxisMargin for Scrollbar.
final
- scrollbarRadius → Radius?
-
The radius for Scrollbar.
final
- scrollbarThickness → double?
-
The thickness for Scrollbar.
final
- shrinkWrap → bool?
-
The shrinkWrap for ScrollView, defaults to false.
final
- updateOnlyIfNotEmpty → bool?
-
The switcher to update list only when returned data is not empty, defaults to false, only used for pagination.
final
- wantKeepAlive → bool?
-
The wantKeepAlive for AutomaticKeepAliveClientMixin, defaults to true.
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited