bzframework_foundation library

Classes

BaseCacheManager
Interface of the CacheManager. In general CacheManager can be used directly.
Bindings
Bindings should be extended or implemented. When using GetMaterialApp, all GetPages and navigation methods (like Get.to()) have a binding property that takes an instance of Bindings to manage the dependencies() (via Get.put()) for the Route you are opening.
BindingsBuilder<T>
Simplifies Bindings generation from a single callback. To avoid the creation of a custom Binding instance per route.
BZAndroidMarket
@Describe: Android Application market
BZAndroidMarketModel
Software information in the Android application market
BZAppConfig
BZBZEnumUtil
BZCacheService
BZDateUtil
BZDeviceUtil
BZDialogTheme
BZEventBus
Special thanks to package https://github.com/marcojakob/dart-event-bus
BzframeworkFoundation
BZLog
BZNumberUtil
BZObjectUtil
BZStorageService
BZStringUtil
BZSystemErrorLogger
BZSystemInfo
BZSystemLogger
BZTheme
BZWebLogger
BZWidgetsBindingObserver
CacheInfoRepository
Base class for cache info repositories
CacheLogger
CacheLogger which is used by the cache manager to log useful information
CacheManager
Flutter Cache Manager Copyright (c) 2019 Rene Floor Released under MIT License. Basic cache manager implementation, which should be used as a single instance.
CacheObjectProvider
Config
CustomTransition
DateFormats
一些常用格式参照。可以自定义格式，例如：'yyyy/MM/dd HH:mm:ss'，'yyyy/M/d HH:mm:ss'。 格式要求 year -> yyyy/yy month -> MM/M day -> dd/d hour -> HH/H minute -> mm/m second -> ss/s
DateUtil
Date Util.
DefaultCacheManager
The DefaultCacheManager that can be easily used directly. The code of this implementation can be used as inspiration for more complex cache managers.
DisposableInterface
DownloadProgress
Progress of the file that is being downloaded from the originalUrl.
EncryptUtil
Encrypt Util.
EnInfo
EnNormalInfo
FastList<T>
FileFetcherResponse
FileInfo
FileInfo contains the fetch File next to some info on the validity and the origin of the file.
FileResponse
FileService
Flutter Cache Manager Copyright (c) 2019 Rene Floor Released under MIT License. Defines the interface for a file service. Most common file service will be an HttpFileService, however one can also make something more specialized. For example you could fetch files from other apps or from local storage.
FileServiceResponse
Defines the interface for a get result of a FileService.
FloatFormatter
FontSizeResolvers
Formatter
FormData
FullLifeCycleController
GetBar
GetBuilder<T extends GetxController>
GetBuilderState<T extends GetxController>
GetConnect
GetConnectInterface
GetCupertinoApp
GetDelegate
GetHttpClient
GetInformationParser
GetInstance
GetInterface
GetInterface allows any auxiliary package to be merged into the "Get" class through extensions
GetLifeCycle
GetMaterialApp
GetMaterialController
GetMicrotask
GetMiddleware
The Page Middlewares. The Functions will be called in this order (( redirect -> onPageCalled -> onBindingsStart -> onPageBuildStart -> onPageBuilt -> onPageDispose ))
GetModalBottomSheetRoute<T>
GetNavConfig
This config enables us to navigate directly to a sub-url
GetNavigator
GetNotifier<T>
GetObserver
GetPage<T>
GetPageRoute<T>
GetPlatform
GetQueue
GetResponsiveView<T>
Extend this widget to build responsive view. this widget contains the screen property that have all information about the screen size and type. You have two options to build it. 1- with builder method you return the widget to build. 2- with methods desktop, tablet,phone, watch. the specific method will be built when the screen type matches the method when the screen is ScreenType.Tablet the tablet method will be exuded and so on. Note if you use this method please set the property alwaysUseBuilder to false With settings property you can set the width limit for the screen types.
GetResponsiveWidget<T extends GetLifeCycleBase?>
GetRouterOutlet
GetSnackBar
GetSnackBarState
GetSocket
GetStream<T>
GetStream is the lightest and most performative way of working with events at Dart. You sintaxe is like StreamController, but it works with simple callbacks. In this way, every event calls only one function. There is no buffering, to very low memory consumption. event add will add a object to stream. addError will add a error to stream. listen is a very light StreamSubscription interface. Is possible take the last value with value property.
GetStreamTransformation<T>
GetUtils
GetView<T>
GetView is a great way of quickly access your Controller without having to call Get.find
GetWidget<S extends GetLifeCycleBase?>
GetWidget is a great way of quickly access your individual Controller without having to call Get.find
GetX<T extends DisposableInterface>
GetxController
GetxService
Unlike GetxController, which serves to control events on each of its pages, GetxService is not automatically disposed (nor can be removed with Get.delete()). It is ideal for situations where, once started, that service will remain in memory, such as Auth control for example. Only way to remove it is Get.reset().
GetXState<T extends DisposableInterface>
GraphQLResponse<T>
HeaderValue
HttpFileFetcherResponse
Deprecated
HttpFileService
HttpFileService is the most common file service and the default for WebHelper. One can easily adapt it to use dio or any other http client.
HttpGetResponse
Basic implementation of a FileServiceResponse for http requests.
InstanceInfo
InternalFinalCallback<T>
Special callable class to keep the contract of a regular method, and avoid overrides if you extend the class that uses it, as Dart has no final methods. Used in DisposableInterface to avoid the danger of overriding onStart.
IntFormatter
JsonCacheInfoRepository
JsonUtil
Json Util.
LightSubscription<T>
LogUtil
Log Util.
MiddlewareRunner
MiniStream<T>
MiniSubscription<T>
MixinBuilder<T extends GetxController>
MoneyUtil
Money Util.
MultipartFile
Node<T>
NonStoringObjectProvider
NumUtil
Num Util.
ObjectUtil
Object Util.
Obx
The simplest reactive widget in GetX.
ObxState
ObxValue<T extends RxInterface>
Similar to Obx, but manages a local state. Pass the initial data in constructor. Useful for simple local states, like toggles, visibility, themes, button states, etc. Sample: ObxValue((data) => Switch( value: data.value, onChanged: (flag) => data.value = flag, ), false.obs, ),
ObxWidget
The ObxWidget is the base for all GetX reactive widgets
PageRedirect
PathDecoded
Permission
Defines the permissions which can be checked and requested.
PermissionWithService
A special kind of permission, used to access a service.
PrintFormat
RebuildFactors
REdgeInsets
REdgeInsetsDirectional
RegexUtil
Regex Util.
Response<T>
ResponsiveScreen
ResponsiveScreenSettings
RouterOutlet<TDelegate extends RouterDelegate<T>, T extends Object>
RouterOutletState<TDelegate extends RouterDelegate<T>, T extends Object>
Routing
RPadding
RSizedBox
Rx<T>
Foundation class used for custom Types outside the common native Dart types. For example, any custom "Model" class, like User().obs will use Rx as wrapper.
RxBool
RxController
RxDouble
RxInt
RxInterface<T>
This class is the foundation for all reactive (Rx) classes that makes Get so powerful. This interface is the contract that _RxImpl]
RxList<E>
Create a list similar to List<T>
RxMap<K, V>
Rxn<T>
RxnBool
RxnDouble
RxnInt
RxnNum
RxNotifier<T>
RxnString
Rx class for String Type.
RxNum
RxSet<E>
RxStatus
RxString
Rx class for String Type.
ScreenUtil
ScreenUtilInit
SimpleBuilder
SimpleBuilderState
SnackbarController
StringFormatter
SuperController<T>
TextUtil
Text Util.
TimelineInfo
Timeline information configuration. Timeline信息配置.
TimelineUtil
TimelineUtil
TimerUtil
TimerUtil.
Translations
TrustedCertificate
Value<T>
ValueBuilder<T>
Manages a local state like ObxValue, but uses a callback instead of a Rx value.
ValueBuilderState<T>
Worker
Workers
ZhInfo
ZhNormalInfo

Enums

CacheManagerLogLevel
Log levels of the cache manager. Debug shows failed downloads and verbose also shows successful downloads and cache retrievals.
DayFormat
(xx)Configurable output. (xx)为可配置输出.
DeviceType
FileSource
Flutter Cache Manager Copyright (c) 2019 Rene Floor Released under MIT License. Enum for whether the file is coming from the cache or is just downloaded.
MoneyFormat
MoneyUnit
PermissionStatus
Defines the state of a Permission.
PopMode
Enables the user to customize the intended pop behavior
PreventDuplicateHandlingMode
Enables the user to customize the behavior when pushing multiple routes that shouldn't be duplicates
RowStyle
ScreenType
ServiceStatus
Defines the different states a service can be in.
SmartManagement
GetX by default disposes unused controllers from memory, Through different behaviors. SmartManagement.full SmartManagement.full is the default one. Dispose classes that are not being used and were not set to be permanent. In the majority of the cases you will want to keep this config untouched. If you new to GetX then don't change this. SmartManagement.onlyBuilder only controllers started in init: or loaded into a Binding with Get.lazyPut() will be disposed. If you use Get.put() or Get.putAsync() or any other approach, SmartManagement will not have permissions to exclude this dependency. With the default behavior, even widgets instantiated with "Get.put" will be removed, unlike SmartManagement.onlyBuilders. SmartManagement.keepFactoryJust like SmartManagement.full, it will remove it's dependencies when it's not being used anymore. However, it will keep their factory, which means it will recreate the dependency if you need that instance again.
SnackbarStatus
Indicates Status of snackbar SnackbarStatus.OPEN Snack is fully open, SnackbarStatus.CLOSED Snackbar has closed, SnackbarStatus.OPENING Starts with the opening animation and ends with the full snackbar display, SnackbarStatus.CLOSING Starts with the closing animation and ends with the full snackbar dispose
SnackPosition
Indicates if snack is going to start at the TOP or at the BOTTOM
SnackStyle
Indicates if snack will be attached to the edge of the screen or not
StorageDirectory
Corresponds to constants defined in Androids android.os.Environment class.
TimeUnit
Transition

Mixins

FullLifeCycleMixin
GetLifeCycleBase
The GetLifeCycle
GetResponsiveMixin
GetSingleTickerProviderStateMixin
Used like SingleTickerProviderMixin but only with Get Controllers. Simplifies AnimationController creation inside GetxController.
GetStateUpdaterMixin<T extends StatefulWidget>
Complies with GetStateUpdater
GetTickerProviderStateMixin
Used like TickerProviderMixin but only with Get Controllers. Simplifies multiple AnimationController creation inside GetxController.
GetxServiceMixin
Allow track difference between GetxServices and GetxControllers
ImageCacheManager
NotifyManager<T>
PageRouteReportMixin<T>
RxObjectMixin<T>
global object that registers against GetX and Obx, and allows the reactivity of those Widgets and Rx values.
ScrollMixin
SingleGetTickerProviderMixin
Used like SingleTickerProviderMixin but only with Get Controllers. Simplifies AnimationController creation inside GetxController.
StateMixin<T>
SU

Extensions

BoolExtension on bool
BorderRadiusExtension on BorderRadius
BoxConstraintsExtension on BoxConstraints
BZBZEventBusPower on GetInterface
GetBZEventBusExtension
BZColorPower on Color
extension for List<T extends Widget> To make it is possible to use function calling instead of Widget Constructor for example: list.intoRow(); list.intoColumn(); list.intoCustomScrollView(); list.intoListView(); list.intoGridView();
BZDateTimePower on DateTime
BZFilePower on File
BZListPower on List<E>
BZMapPower on Map<K, V>
BZNumPower on num
BZObjectPower on Object
BZStringPower on String
extension for List<T extends Widget> To make it is possible to use function calling instead of Widget Constructor for example: list.intoRow(); list.intoColumn(); list.intoCustomScrollView(); list.intoListView(); list.intoGridView();
ContextExtensionss on BuildContext
DoubleExtension on double
EdgeInsetsExtension on EdgeInsets
ExtensionBottomSheet on GetInterface
ExtensionDialog on GetInterface
ExtensionSnackbar on GetInterface
FirstWhereExt on List<T>
FuturePermissionStatusGetters on Future<PermissionStatus>
Utility getter extensions for the Future<PermissionStatus> type.
FutureServiceStatusGetters on Future<ServiceStatus>
Utility getter extensions for the Future<ServiceStatus> type.
GetDurationUtils on Duration
Duration utilities.
GetDynamicUtils on dynamic
GetNavigation on GetInterface
GetNumUtils on num
GetResetExt on GetInterface
GetStringUtils on String
Inst on GetInterface
IntExtension on int
IterableExtensions on Iterable<T>
ListExtension on List<E>
LocalesIntl on GetInterface
LoopEventsExt on GetInterface
MapExtension on Map<K, V>
MigrationExtension on CacheInfoRepository
OverlayExt on GetInterface
PagesListExt on List<GetPage>
PermissionActions on Permission
Actions that can be executed on a permission.
PermissionCheckShortcuts on Permission
Shortcuts for checking the status of a Permission.
PermissionListActions on List<Permission>
Actions that can be taken on a List of Permissions.
PermissionStatusGetters on PermissionStatus
Utility getter extensions for the PermissionStatus type.
Precision on double
RadiusExtension on Radius
ReactiveT on T
RxBoolExt on Rx<bool>
RxDoubleExt on Rx<double>
RxIntExt on Rx<int>
RxnBoolExt on Rx<bool?>
RxnDoubleExt on Rx<double?>
RxnIntExt on Rx<int?>
RxnNumExt on Rx<T?>
RxnStringExt on Rx<String?>
RxNumExt on Rx<T>
RxStringExt on Rx<String>
RxT on T
ServicePermissionActions on PermissionWithService
Actions that apply only to permissions that have an associated service.
ServiceStatusGetters on ServiceStatus
Utility getter extensions for the ServiceStatus type.
SetExtension on Set<E>
SizeExtension on num
StateExt on StateMixin<T>
StringExtension on String
Trans on String
WidgetMarginX on Widget
Add margin property to widget
WidgetPaddingX on Widget
add Padding Property to widget
WidgetSliverBoxX on Widget
Allows you to insert widgets inside a CustomScrollView

Properties

cacheLogger ↔ CacheLogger
Instance of the cache manager. Can be set to a custom one if preferred.
getter/setter pair
disablePathProviderPlatformOverride ← bool
no getter
Get → _GetImpl
final
ID_CARD_PROVINCE_DICT ↔ List<String>
id card province dict.
getter/setter pair
MONTH_DAY ↔ Map<int, int>
month->days.
getter/setter pair
It replaces the Flutter Navigator, but needs no context. You can to use navigator.push(YourRoute()) rather Navigator.push(context, YourRoute());
no setter
sprintf ↔ PrintFormat
getter/setter pair

Functions

ambiguate<T>(T? value) → T?
appBarContrastColor(BuildContext context) → Color
计算反差色
bodyBytesToString(Stream<List<int>> bodyBytes, Map<String, String> headers) → Future<String>
debounce<T>(RxInterface<T> listener, WorkerCallback<T> callback, {Duration? time, Function? onError, void onDone()?, bool? cancelOnError}) → Worker
debounce is similar to interval, but sends the last value. Useful for Anti DDos, every time the user stops typing for 1 second, for instance. When listener emits the last "value", when time hits, it calls callback with the last "value" emitted.
defaultLogWriterCallback(String value, {bool isError = false}) → void
default logger from GetX
ever<T>(RxInterface<T> listener, WorkerCallback<T> callback, {dynamic condition = true, Function? onError, void onDone()?, bool? cancelOnError}) → Worker
Called every time listener changes. As long as the condition returns true.
everAll(List<RxInterface> listeners, WorkerCallback callback, {dynamic condition = true, Function? onError, void onDone()?, bool? cancelOnError}) → Worker
Similar to ever, but takes a list of listeners, the condition for the callback is common to all listeners, and the callback is executed to each one of them. The Worker is common to all, so worker.dispose() will cancel all streams.
getApplicationCacheDirectory() → Future<Directory>
Path to a directory where the application may place application-specific cache files.
getApplicationDocumentsDirectory() → Future<Directory>
Path to a directory where the application may place data that is user-generated, or that cannot otherwise be recreated by your application.
getApplicationSupportDirectory() → Future<Directory>
Path to a directory where the application may place application support files.
getDownloadsDirectory() → Future<Directory?>
Path to the directory where downloaded files can be stored.
getExternalCacheDirectories() → Future<List<Directory>?>
Paths to directories where application specific cache data can be stored externally.
getExternalStorageDirectories({StorageDirectory? type}) → Future<List<Directory>?>
Paths to directories where application specific data can be stored externally.
getExternalStorageDirectory() → Future<Directory?>
Path to a directory where the application may access top level storage.
getLibraryDirectory() → Future<Directory>
Path to the directory where application can store files that are persistent, backed up, and not visible to the user, such as sqlite.db.
getTemporaryDirectory() → Future<Directory>
Path to the temporary directory on the device that is not backed up and is suitable for storing caches of downloaded files.
hexToColor(String hex) → Color
interval<T>(RxInterface<T> listener, WorkerCallback<T> callback, {Duration time = const Duration(seconds: 1), dynamic condition = true, Function? onError, void onDone()?, bool? cancelOnError}) → Worker
Ignore all changes in listener during time (1 sec by default) or until condition is met (can be a bool expression or a bool Function()), It brings the 1st "value" since the period of time, so if you click a counter button 3 times in 1 sec, it will show you "1" (after 1 sec of the first press) click counter 3 times in 1 sec, it will show you "4" (after 1 sec) click counter 2 times in 1 sec, it will show you "7" (after 1 sec).
once<T>(RxInterface<T> listener, WorkerCallback<T> callback, {dynamic condition = true, Function? onError, void onDone()?, bool? cancelOnError}) → Worker
once() will execute only 1 time when condition is met and cancel the subscription to the listener stream right after that. condition defines when callback is called, and can be a bool or a bool Function().
openAppSettings() → Future<bool>
Opens the app settings page.
setLocaleInfo(String locale, TimelineInfo timelineInfo) → void
add custom configuration.

Typedefs

AddSubscription<T> = FutureOr<void> Function(LightSubscription<T> subs)
AsyncInstanceBuilderCallback<S> = Future<S> Function()
BindingBuilderCallback = void Function()
BZCellCallback<T> = void Function(T value, int? index)
BZFutureValueConfirmCallback<T> = Future<bool> Function(T value)
BZTwoValueCallback<T, F> = void Function(T value, T twoValue)
BZValueCallback<T> = void Function(T value)
BZValueConfirmCallback<T> = bool Function(T value)
Condition = bool Function()
ConvertBean = dynamic Function(dynamic data)
Decoder<T> = T Function(dynamic data)
FileFetcher = Future<FileFetcherResponse> Function(String url, {Map<String, String>? headers})
Flutter Cache Manager Copyright (c) 2019 Rene Floor Released under MIT License. Deprecated FileFetcher function
FontSizeResolver = double Function(num fontSize, ScreenUtil instance)
GetControllerBuilder<T extends DisposableInterface> = Widget Function(T controller)
GetPageBuilder = Widget Function()
GetXControllerBuilder<T extends DisposableInterface> = Widget Function(T controller)
InjectorBuilderCallback<S> = S Function(GetInstance)
InstanceBuilderCallback<S> = S Function()
LogWriterCallback = void Function(String text, {bool isError})
VoidCallback from logs
NotifierBuilder<T> = Widget Function(T state)
OnTap = void Function(GetSnackBar snack)
OnTimerTickCallback = void Function(int millisUntilFinished)
timer callback.(millisUntilFinished 毫秒).
PrintFormatFormatter = Formatter Function(dynamic arg, dynamic options)
PrintFunctionCallback = void Function(String prefix, dynamic value, String info, {bool? isError})
Progress = dynamic Function(double percent)
RebuildFactor = bool Function(MediaQueryData old, MediaQueryData data)
RemoveSubscription<T> = FutureOr<bool?> Function(LightSubscription<T> subs)
ScreenUtilInitBuilder = Widget Function(BuildContext context, Widget? child)
SnackbarStatusCallback = void Function(SnackbarStatus? status)
ValueBuilderBuilder<T> = Widget Function(T snapshot, ValueBuilderUpdateCallback<T> updater)
ValueBuilderUpdateCallback<T> = void Function(T snapshot)
ValueUpdater<T> = T Function()
WidgetCallback = Widget Function()
WorkerCallback<T> = dynamic Function(T callback)

Exceptions / Errors

HttpExceptionWithStatus
MissingPlatformDirectoryException
An exception thrown when a directory that should always be available on the current platform cannot be obtained.