localizations.dart 14.1 KB
Newer Older
Ian Hickson's avatar
Ian Hickson committed
1
// Copyright 2014 The Flutter Authors. All rights reserved.
2 3 4 5 6 7
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.

import 'package:flutter/foundation.dart';
import 'package:flutter/widgets.dart';

8
import 'debug.dart';
9

10 11 12 13 14
/// Determines the order of the columns inside [CupertinoDatePicker] in
/// time and date time mode.
enum DatePickerDateTimeOrder {
  /// Order of the columns, from left to right: date, hour, minute, am/pm.
  ///
15
  /// Example: Fri Aug 31 | 02 | 08 | PM.
16 17 18
  date_time_dayPeriod,
  /// Order of the columns, from left to right: date, am/pm, hour, minute.
  ///
19
  /// Example: Fri Aug 31 | PM | 02 | 08.
20 21 22
  date_dayPeriod_time,
  /// Order of the columns, from left to right: hour, minute, am/pm, date.
  ///
23
  /// Example: 02 | 08 | PM | Fri Aug 31.
24 25 26
  time_dayPeriod_date,
  /// Order of the columns, from left to right: am/pm, hour, minute, date.
  ///
27
  /// Example: PM | 02 | 08 | Fri Aug 31.
28 29 30 31 32 33 34
  dayPeriod_time_date,
}

/// Determines the order of the columns inside [CupertinoDatePicker] in date mode.
enum DatePickerDateOrder {
  /// Order of the columns, from left to right: day, month, year.
  ///
35
  /// Example: 12 | March | 1996.
36 37 38
  dmy,
  /// Order of the columns, from left to right: month, day, year.
  ///
39
  /// Example: March | 12 | 1996.
40 41 42
  mdy,
  /// Order of the columns, from left to right: year, month, day.
  ///
43
  /// Example: 1996 | March | 12.
44 45 46
  ymd,
  /// Order of the columns, from left to right: year, day, month.
  ///
47
  /// Example: 1996 | 12 | March.
48 49
  ydm,
}
50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65

/// Defines the localized resource values used by the Cupertino widgets.
///
/// See also:
///
///  * [DefaultCupertinoLocalizations], the default, English-only, implementation
///    of this interface.
// TODO(xster): Supply non-english strings.
abstract class CupertinoLocalizations {
  /// Year that is shown in [CupertinoDatePicker] spinner corresponding to the
  /// given year index.
  ///
  /// Examples: datePickerYear(1) in:
  ///
  ///  - US English: 2018
  ///  - Korean: 2018년
66
  // The global version uses date symbols data from the intl package.
67 68 69 70 71 72 73 74 75
  String datePickerYear(int yearIndex);

  /// Month that is shown in [CupertinoDatePicker] spinner corresponding to
  /// the given month index.
  ///
  /// Examples: datePickerMonth(1) in:
  ///
  ///  - US English: January
  ///  - Korean: 1월
76
  // The global version uses date symbols data from the intl package.
77 78 79 80 81 82 83 84 85
  String datePickerMonth(int monthIndex);

  /// Day of month that is shown in [CupertinoDatePicker] spinner corresponding
  /// to the given day index.
  ///
  /// Examples: datePickerDayOfMonth(1) in:
  ///
  ///  - US English: 1
  ///  - Korean: 1일
86
  // The global version uses date symbols data from the intl package.
87 88 89 90 91 92 93 94 95
  String datePickerDayOfMonth(int dayIndex);

  /// The medium-width date format that is shown in [CupertinoDatePicker]
  /// spinner. Abbreviates month and days of week.
  ///
  /// Examples:
  ///
  /// - US English: Wed Sep 27
  /// - Russian: ср сент. 27
96
  // The global version is based on intl package's DateFormat.MMMEd.
97 98 99 100 101 102 103
  String datePickerMediumDate(DateTime date);

  /// Hour that is shown in [CupertinoDatePicker] spinner corresponding
  /// to the given hour value.
  ///
  /// Examples: datePickerHour(1) in:
  ///
104
  ///  - US English: 1
105
  ///  - Arabic: ٠١
106
  // The global version uses date symbols data from the intl package.
107 108
  String datePickerHour(int hour);

109
  /// Semantics label for the given hour value in [CupertinoDatePicker].
110
  // The global version uses the translated string from the arb file.
111
  String? datePickerHourSemanticsLabel(int hour);
112

113 114 115 116 117 118 119
  /// Minute that is shown in [CupertinoDatePicker] spinner corresponding
  /// to the given minute value.
  ///
  /// Examples: datePickerMinute(1) in:
  ///
  ///  - US English: 01
  ///  - Arabic: ٠١
120
  // The global version uses date symbols data from the intl package.
121 122
  String datePickerMinute(int minute);

123
  /// Semantics label for the given minute value in [CupertinoDatePicker].
124
  // The global version uses the translated string from the arb file.
125
  String? datePickerMinuteSemanticsLabel(int minute);
126

127
  /// The order of the date elements that will be shown in [CupertinoDatePicker].
128
  // The global version uses the translated string from the arb file.
129 130 131
  DatePickerDateOrder get datePickerDateOrder;

  /// The order of the time elements that will be shown in [CupertinoDatePicker].
132
  // The global version uses the translated string from the arb file.
133
  DatePickerDateTimeOrder get datePickerDateTimeOrder;
134 135

  /// The abbreviation for ante meridiem (before noon) shown in the time picker.
136
  // The global version uses the translated string from the arb file.
137 138 139
  String get anteMeridiemAbbreviation;

  /// The abbreviation for post meridiem (after noon) shown in the time picker.
140
  // The global version uses the translated string from the arb file.
141 142
  String get postMeridiemAbbreviation;

143 144 145 146
  /// Label shown in date pickers when the date is today.
  // The global version uses the translated string from the arb file.
  String get todayLabel;

147
  /// The term used by the system to announce dialog alerts.
148
  // The global version uses the translated string from the arb file.
149 150
  String get alertDialogLabel;

151 152 153 154 155 156
  /// The accessibility label used on a tab in a [CupertinoTabBar].
  ///
  /// This message describes the index of the selected tab and how many tabs
  /// there are, e.g. 'tab, 1 of 2' in United States English.
  ///
  /// `tabIndex` and `tabCount` must be greater than or equal to one.
157
  String tabSemanticsLabel({required int tabIndex, required int tabCount});
158

159
  /// Hour that is shown in [CupertinoTimerPicker] corresponding to
160 161 162 163 164 165
  /// the given hour value.
  ///
  /// Examples: timerPickerHour(1) in:
  ///
  ///  - US English: 1
  ///  - Arabic: ١
166
  // The global version uses date symbols data from the intl package.
167 168
  String timerPickerHour(int hour);

169
  /// Minute that is shown in [CupertinoTimerPicker] corresponding to
170 171 172 173 174 175
  /// the given minute value.
  ///
  /// Examples: timerPickerMinute(1) in:
  ///
  ///  - US English: 1
  ///  - Arabic: ١
176
  // The global version uses date symbols data from the intl package.
177 178
  String timerPickerMinute(int minute);

179
  /// Second that is shown in [CupertinoTimerPicker] corresponding to
180 181 182 183 184 185
  /// the given second value.
  ///
  /// Examples: timerPickerSecond(1) in:
  ///
  ///  - US English: 1
  ///  - Arabic: ١
186
  // The global version uses date symbols data from the intl package.
187 188 189
  String timerPickerSecond(int second);

  /// Label that appears next to the hour picker in
190
  /// [CupertinoTimerPicker] when selected hour value is `hour`.
191
  /// This function will deal with pluralization based on the `hour` parameter.
192
  // The global version uses the translated string from the arb file.
193
  String? timerPickerHourLabel(int hour);
194

195 196 197 198
  /// All possible hour labels that appears next to the hour picker in
  /// [CupertinoTimerPicker]
  List<String> get timerPickerHourLabels;

199
  /// Label that appears next to the minute picker in
200
  /// [CupertinoTimerPicker] when selected minute value is `minute`.
201
  /// This function will deal with pluralization based on the `minute` parameter.
202
  // The global version uses the translated string from the arb file.
203
  String? timerPickerMinuteLabel(int minute);
204

205 206 207 208
  /// All possible minute labels that appears next to the minute picker in
  /// [CupertinoTimerPicker]
  List<String> get timerPickerMinuteLabels;

209
  /// Label that appears next to the minute picker in
210
  /// [CupertinoTimerPicker] when selected minute value is `second`.
211
  /// This function will deal with pluralization based on the `second` parameter.
212
  // The global version uses the translated string from the arb file.
213
  String? timerPickerSecondLabel(int second);
214

215 216 217 218
  /// All possible second labels that appears next to the second picker in
  /// [CupertinoTimerPicker]
  List<String> get timerPickerSecondLabels;

219
  /// The term used for cutting.
220
  // The global version uses the translated string from the arb file.
221 222
  String get cutButtonLabel;

223
  /// The term used for copying.
224
  // The global version uses the translated string from the arb file.
225 226
  String get copyButtonLabel;

227
  /// The term used for pasting.
228
  // The global version uses the translated string from the arb file.
229 230
  String get pasteButtonLabel;

231
  /// The term used for selecting everything.
232
  // The global version uses the translated string from the arb file.
233 234
  String get selectAllButtonLabel;

235 236
  /// The default placeholder used in [CupertinoSearchTextField].
  // The global version uses the translated string from the arb file.
237
  String get searchTextFieldPlaceholderLabel;
238

239 240 241 242 243 244 245
  /// Label read out by accessibility tools (VoiceOver) for a modal
  /// barrier to indicate that a tap dismisses the barrier.
  ///
  /// A modal barrier can for example be found behind an alert or popup to block
  /// user interaction with elements behind it.
  String get modalBarrierDismissLabel;

246 247 248
  /// The `CupertinoLocalizations` from the closest [Localizations] instance
  /// that encloses the given context.
  ///
249 250 251
  /// If no [CupertinoLocalizations] are available in the given `context`, this
  /// method throws an exception.
  ///
252
  /// This method is just a convenient shorthand for:
253
  /// `Localizations.of<CupertinoLocalizations>(context, CupertinoLocalizations)!`.
254 255 256 257 258 259 260
  ///
  /// References to the localized resources defined by this class are typically
  /// written in terms of this method. For example:
  ///
  /// ```dart
  /// CupertinoLocalizations.of(context).anteMeridiemAbbreviation;
  /// ```
261
  static CupertinoLocalizations of(BuildContext context) {
262
    assert(debugCheckHasCupertinoLocalizations(context));
263
    return Localizations.of<CupertinoLocalizations>(context, CupertinoLocalizations)!;
264 265 266 267 268 269 270 271 272 273 274 275 276 277
  }
}

class _CupertinoLocalizationsDelegate extends LocalizationsDelegate<CupertinoLocalizations> {
  const _CupertinoLocalizationsDelegate();

  @override
  bool isSupported(Locale locale) => locale.languageCode == 'en';

  @override
  Future<CupertinoLocalizations> load(Locale locale) => DefaultCupertinoLocalizations.load(locale);

  @override
  bool shouldReload(_CupertinoLocalizationsDelegate old) => false;
278 279 280

  @override
  String toString() => 'DefaultCupertinoLocalizations.delegate(en_US)';
281 282
}

283
/// US English strings for the Cupertino widgets.
284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331
class DefaultCupertinoLocalizations implements CupertinoLocalizations {
  /// Constructs an object that defines the cupertino widgets' localized strings
  /// for US English (only).
  ///
  /// [LocalizationsDelegate] implementations typically call the static [load]
  /// function, rather than constructing this class directly.
  const DefaultCupertinoLocalizations();

  static const List<String> _shortWeekdays = <String>[
    'Mon',
    'Tue',
    'Wed',
    'Thu',
    'Fri',
    'Sat',
    'Sun',
  ];

  static const List<String> _shortMonths = <String>[
    'Jan',
    'Feb',
    'Mar',
    'Apr',
    'May',
    'Jun',
    'Jul',
    'Aug',
    'Sep',
    'Oct',
    'Nov',
    'Dec',
  ];

  static const List<String> _months = <String>[
    'January',
    'February',
    'March',
    'April',
    'May',
    'June',
    'July',
    'August',
    'September',
    'October',
    'November',
    'December',
  ];

332 333


334 335 336 337 338 339 340 341 342 343
  @override
  String datePickerYear(int yearIndex) => yearIndex.toString();

  @override
  String datePickerMonth(int monthIndex) => _months[monthIndex - 1];

  @override
  String datePickerDayOfMonth(int dayIndex) => dayIndex.toString();

  @override
344
  String datePickerHour(int hour) => hour.toString();
345

346
  @override
347
  String datePickerHourSemanticsLabel(int hour) => "$hour o'clock";
348

349 350 351
  @override
  String datePickerMinute(int minute) => minute.toString().padLeft(2, '0');

352 353 354
  @override
  String datePickerMinuteSemanticsLabel(int minute) {
    if (minute == 1)
355
      return '1 minute';
356
    return '$minute minutes';
357 358
  }

359 360 361 362
  @override
  String datePickerMediumDate(DateTime date) {
    return '${_shortWeekdays[date.weekday - DateTime.monday]} '
      '${_shortMonths[date.month - DateTime.january]} '
363
      '${date.day.toString().padRight(2)}';
364 365 366
  }

  @override
367 368 369 370
  DatePickerDateOrder get datePickerDateOrder => DatePickerDateOrder.mdy;

  @override
  DatePickerDateTimeOrder get datePickerDateTimeOrder => DatePickerDateTimeOrder.date_time_dayPeriod;
371 372 373 374 375 376 377

  @override
  String get anteMeridiemAbbreviation => 'AM';

  @override
  String get postMeridiemAbbreviation => 'PM';

378 379 380
  @override
  String get todayLabel => 'Today';

381 382 383
  @override
  String get alertDialogLabel => 'Alert';

384
  @override
385
  String tabSemanticsLabel({required int tabIndex, required int tabCount}) {
386 387
    assert(tabIndex >= 1);
    assert(tabCount >= 1);
388
    return 'Tab $tabIndex of $tabCount';
389 390
  }

391 392 393 394 395 396 397 398 399 400 401 402
  @override
  String timerPickerHour(int hour) => hour.toString();

  @override
  String timerPickerMinute(int minute) => minute.toString();

  @override
  String timerPickerSecond(int second) => second.toString();

  @override
  String timerPickerHourLabel(int hour) => hour == 1 ? 'hour' : 'hours';

403 404 405
  @override
  List<String> get timerPickerHourLabels => const <String>['hour', 'hours'];

406
  @override
407
  String timerPickerMinuteLabel(int minute) => 'min.';
408

409 410 411
  @override
  List<String> get timerPickerMinuteLabels => const <String>['min.'];

412
  @override
413
  String timerPickerSecondLabel(int second) => 'sec.';
414

415 416 417
  @override
  List<String> get timerPickerSecondLabels => const <String>['sec.'];

418 419 420 421 422 423 424 425 426 427 428 429
  @override
  String get cutButtonLabel => 'Cut';

  @override
  String get copyButtonLabel => 'Copy';

  @override
  String get pasteButtonLabel => 'Paste';

  @override
  String get selectAllButtonLabel => 'Select All';

430
  @override
431
  String get searchTextFieldPlaceholderLabel => 'Search';
432

433 434 435
  @override
  String get modalBarrierDismissLabel => 'Dismiss';

436 437 438 439 440 441 442
  /// Creates an object that provides US English resource values for the
  /// cupertino library widgets.
  ///
  /// The [locale] parameter is ignored.
  ///
  /// This method is typically used to create a [LocalizationsDelegate].
  static Future<CupertinoLocalizations> load(Locale locale) {
443
    return SynchronousFuture<CupertinoLocalizations>(const DefaultCupertinoLocalizations());
444 445 446 447 448 449
  }

  /// A [LocalizationsDelegate] that uses [DefaultCupertinoLocalizations.load]
  /// to create an instance of this class.
  static const LocalizationsDelegate<CupertinoLocalizations> delegate = _CupertinoLocalizationsDelegate();
}