BaseLocaleSettings<E extends BaseAppLocale<E, T>, T extends BaseTranslations<E, T>> class abstract

Implementers
Available extensions

Constructors

BaseLocaleSettings({required BaseAppLocaleUtils<E, T> utils, required bool lazy})

Properties

currentLocale → E

Available on BaseLocaleSettings<E, T>, provided by the LocaleSettingsExt extension

Gets the current locale.
no setter
currentTranslations → T

Available on BaseLocaleSettings<E, T>, provided by the LocaleSettingsExt extension

Gets the current translations. Falls back to the base locale if the current locale is not loaded.
no setter
hashCode → int
The hash code for this object.
no setterinherited
lazy → bool
If true, then only the base locale is loaded initially. Secondary locales are loaded on demand:
final
listenToDeviceLocale ↔ bool
If true, then TranslationProvider will trigger setLocale on device locale change (e.g. due to user interaction in device settings).
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
supportedLocalesRaw → List<String>

Available on BaseLocaleSettings<E, T>, provided by the LocaleSettingsExt extension

Gets supported locales in string format.
no setter
translationMap → Map<E, T>
Internal: Manages all translation instances. The base locale is always included. Additional locales are added when calling loadLocale. May be modified when setting a custom plural resolver.
final
translationsLoading → Set<E>
Internal: Keeps track of loading translations to prevent multiple requests. This lock is sufficient because Dart's async loop is single-threaded.
final
utils → BaseAppLocaleUtils<E, T>
Internal: Reference to utils instance
final

Methods

getLocaleStream() → Stream<E>

Available on BaseLocaleSettings<E, T>, provided by the LocaleSettingsExt extension

Gets the broadcast stream to keep track of every locale change.
getTranslations(E locale) → T

Available on BaseLocaleSettings<E, T>, provided by the LocaleSettingsExt extension

Gets the translations of the given locale. Falls back to the base locale if the given locale is not loaded.
isLocaleLoaded(E locale) → bool

Available on BaseLocaleSettings<E, T>, provided by the LocaleSettingsExt extension

Returns true if the translations of the given locale are loaded.
loadAllLocales() → Future<void>

Available on BaseLocaleSettings<E, T>, provided by the LocaleSettingsExt extension

Loads all locales.
loadAllLocalesSync() → void

Available on BaseLocaleSettings<E, T>, provided by the LocaleSettingsExt extension

Sync version of loadAllLocales.
loadLocale(E locale) → Future<void>

Available on BaseLocaleSettings<E, T>, provided by the LocaleSettingsExt extension

Loads the translations of the given locale if not already loaded.
loadLocaleSync(E locale) → void

Available on BaseLocaleSettings<E, T>, provided by the LocaleSettingsExt extension

Sync version of loadLocale.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
overrideTranslations({required E locale, required FileType fileType, required String content}) → Future<void>

Available on BaseLocaleSettings<E, T>, provided by the LocaleSettingsExt extension

Overrides existing translations of locale with new ones from content. The content should be formatted and structured exactly the same way as the original files.
overrideTranslationsFromMap({required E locale, required bool isFlatMap, required Map map}) → Future<void>

Available on BaseLocaleSettings<E, T>, provided by the LocaleSettingsExt extension

Overrides existing translations of locale with new ones from the map.
overrideTranslationsFromMapSync({required E locale, required bool isFlatMap, required Map map}) → void

Available on BaseLocaleSettings<E, T>, provided by the LocaleSettingsExt extension

Sync version of overrideTranslationsFromMap.
overrideTranslationsSync({required E locale, required FileType fileType, required String content}) → void

Available on BaseLocaleSettings<E, T>, provided by the LocaleSettingsExt extension

Sync version of overrideTranslations.
setLocale(E locale, {bool? listenToDeviceLocale = false}) → Future<E>

Available on BaseLocaleSettings<E, T>, provided by the LocaleSettingsExt extension

Sets locale. Returns the locale which has been set.
setLocaleRaw(String rawLocale, {bool? listenToDeviceLocale = false}) → Future<E>

Available on BaseLocaleSettings<E, T>, provided by the LocaleSettingsExt extension

Sets locale using string tag (e.g. en_US, de-DE, fr) Fallbacks to base locale. Returns the locale which has been set.
setLocaleRawSync(String rawLocale, {bool? listenToDeviceLocale = false}) → E

Available on BaseLocaleSettings<E, T>, provided by the LocaleSettingsExt extension

Sync version of setLocaleRaw.
setLocaleSync(E locale, {bool? listenToDeviceLocale = false}) → E

Available on BaseLocaleSettings<E, T>, provided by the LocaleSettingsExt extension

Sync version of setLocale.
setPluralResolver({String? language, E? locale, PluralResolver? cardinalResolver, PluralResolver? ordinalResolver}) → Future<void>

Available on BaseLocaleSettings<E, T>, provided by the LocaleSettingsExt extension

Sets plural resolvers. See https://www.unicode.org/cldr/charts/latest/supplemental/language_plural_rules.html See https://github.com/slang-i18n/slang/blob/main/slang/lib/src/api/plural_resolver_map.dart Either specify language, or locale. locale has precedence.
setPluralResolverSync({String? language, E? locale, PluralResolver? cardinalResolver, PluralResolver? ordinalResolver}) → void

Available on BaseLocaleSettings<E, T>, provided by the LocaleSettingsExt extension

Sync version of setPluralResolver.
toString() → String
A string representation of this object.
inherited
updateProviderState(BaseAppLocale<BaseAppLocale, BaseTranslations> locale) → void
Updates the provider state and therefore triggers a rebuild on all widgets listening to this provider.

Operators

operator ==(Object other) → bool
The equality operator.
inherited