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

5 6
import 'package:flutter/foundation.dart';
import 'package:flutter/widgets.dart';
7

8
import 'debug.dart';
9
import 'time.dart';
10
import 'typography.dart';
11

12 13 14 15 16 17 18 19 20 21 22 23 24 25 26
// ADDING A NEW STRING
//
// If you (someone contributing to the Flutter framework) want to add a new
// string to the MaterialLocalizations object (e.g. because you've added a new
// widget and it has a tooltip), follow these steps:
//
// 1. Add the new getter to MaterialLocalizations below.
//
// 2. Implement a default value in DefaultMaterialLocalizations below.
//
// 3. Add a test to test/material/localizations_test.dart that verifies that
//    this new value is implemented.
//
// 4. Update the flutter_localizations package. To add a new string to the
//    flutter_localizations package, you must first add it to the English
27 28
//    translations (lib/src/l10n/material_en.arb), including a description.
//
29
//    Then you need to add new entries for the string to all of the other
30 31 32 33
//    language locale files by running:
//    ```
//    dart dev/tools/localization/bin/gen_missing_localizations.dart
//    ```
34 35
//    Which will copy the english strings into the other locales as placeholders
//    until they can be translated.
36 37 38 39 40 41
//
//    Finally you need to re-generate lib/src/l10n/localizations.dart by running:
//    ```
//    dart dev/tools/localization/bin/gen_localizations.dart --overwrite
//    ```
//
42 43
//    There is a README file with further information in the lib/src/l10n/
//    directory.
44 45 46
//
// 5. If you are a Google employee, you should then also follow the instructions
//    at go/flutter-l10n. If you're not, don't worry about it.
47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73
//
// UPDATING AN EXISTING STRING
//
// If you (someone contributing to the Flutter framework) want to modify an
// existing string in the MaterialLocalizations objects, follow these steps:
//
// 1. Modify the default value of the relevant getter(s) in
//    DefaultMaterialLocalizations below.
//
// 2. Update the flutter_localizations package. Modify the out-of-date English
//    strings in lib/src/l10n/material_en.arb.
//
//    You also need to re-generate lib/src/l10n/localizations.dart by running:
//    ```
//    dart dev/tools/localization/bin/gen_localizations.dart --overwrite
//    ```
//
//    This script may result in your updated getters being created in newer
//    locales and set to the old value of the strings. This is to be expected.
//    Leave them as they were generated, and they will be picked up for
//    translation.
//
//    There is a README file with further information in the lib/src/l10n/
//    directory.
//
// 3. If you are a Google employee, you should then also follow the instructions
//    at go/flutter-l10n. If you're not, don't worry about it.
74

Yegor's avatar
Yegor committed
75
/// Defines the localized resource values used by the Material widgets.
76 77 78
///
/// See also:
///
79 80 81 82
///  * [DefaultMaterialLocalizations], the default, English-only, implementation
///    of this interface.
///  * [GlobalMaterialLocalizations], which provides material localizations for
///    many languages.
83
abstract class MaterialLocalizations {
84
  /// The tooltip for the leading [AppBar] menu (a.k.a. 'hamburger') button.
85
  String get openAppDrawerTooltip;
86 87

  /// The [BackButton]'s tooltip.
88
  String get backButtonTooltip;
89 90

  /// The [CloseButton]'s tooltip.
91
  String get closeButtonTooltip;
92

93 94 95
  /// The tooltip for the delete button on a [Chip].
  String get deleteButtonTooltip;

96 97 98
  /// The tooltip for the more button on an overflowing text selection menu.
  String get moreButtonTooltip;

99
  /// The tooltip for the [MonthPicker]'s "next month" button.
100
  String get nextMonthTooltip;
101 102

  /// The tooltip for the [MonthPicker]'s "previous month" button.
103
  String get previousMonthTooltip;
104

105 106 107 108 109 110
  /// The tooltip for the [PaginatedDataTable]'s "first page" button.
  String get firstPageTooltip;

  /// The tooltip for the [PaginatedDataTable]'s "last page" button.
  String get lastPageTooltip;

111
  /// The tooltip for the [PaginatedDataTable]'s "next page" button.
112 113
  String get nextPageTooltip;

114
  /// The tooltip for the [PaginatedDataTable]'s "previous page" button.
115 116 117 118 119
  String get previousPageTooltip;

  /// The default [PopupMenuButton] tooltip.
  String get showMenuTooltip;

Hans Muller's avatar
Hans Muller committed
120 121 122
  /// The default title for [AboutListTile].
  String aboutListTileTitle(String applicationName);

123 124 125
  /// Title for the [LicensePage] widget.
  String get licensesPageTitle;

126 127 128
  /// Subtitle for a package in the [LicensePage] widget.
  String licensesPackageDetailText(int licenseCount);

129 130 131 132 133 134
  /// Title for the [PaginatedDataTable]'s row info footer.
  String pageRowsInfoTitle(int firstRow, int lastRow, int rowCount, bool rowCountIsApproximate);

  /// Title for the [PaginatedDataTable]'s "rows per page" footer.
  String get rowsPerPageTitle;

135 136 137 138 139 140
  /// The accessibility label used on a tab in a [TabBar].
  ///
  /// 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.
141
  String tabLabel({ required int tabIndex, required int tabCount });
142

143
  /// Title for the [PaginatedDataTable]'s selected row count header.
144 145
  String selectedRowCountTitle(int selectedRowCount);

146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169
  /// Label for "cancel" buttons and menu items.
  String get cancelButtonLabel;

  /// Label for "close" buttons and menu items.
  String get closeButtonLabel;

  /// Label for "continue" buttons and menu items.
  String get continueButtonLabel;

  /// Label for "copy" edit buttons and menu items.
  String get copyButtonLabel;

  /// Label for "cut" edit buttons and menu items.
  String get cutButtonLabel;

  /// Label for OK buttons and menu items.
  String get okButtonLabel;

  /// Label for "paste" edit buttons and menu items.
  String get pasteButtonLabel;

  /// Label for "select all" edit buttons and menu items.
  String get selectAllButtonLabel;

170
  /// Label for the [AboutDialog] button that shows the [LicensePage].
171 172
  String get viewLicensesButtonLabel;

Yegor's avatar
Yegor committed
173 174 175 176 177 178
  /// The abbreviation for ante meridiem (before noon) shown in the time picker.
  String get anteMeridiemAbbreviation;

  /// The abbreviation for post meridiem (after noon) shown in the time picker.
  String get postMeridiemAbbreviation;

179 180 181 182 183 184 185 186
  /// The text-to-speech announcement made when a time picker invoked using
  /// [showTimePicker] is set to the hour picker mode.
  String get timePickerHourModeAnnouncement;

  /// The text-to-speech announcement made when a time picker invoked using
  /// [showTimePicker] is set to the minute picker mode.
  String get timePickerMinuteModeAnnouncement;

Josh Soref's avatar
Josh Soref committed
187
  /// Label read out by accessibility tools (TalkBack or VoiceOver) for a modal
188 189
  /// barrier to indicate that a tap dismisses the barrier.
  ///
190
  /// A modal barrier can for example be found behind an alert or popup to block
191 192 193
  /// user interaction with elements behind it.
  String get modalBarrierDismissLabel;

194
  /// Label read out by accessibility tools (TalkBack or VoiceOver) when a
195 196
  /// drawer widget is opened.
  String get drawerLabel;
197 198

  /// Label read out by accessibility tools (TalkBack or VoiceOver) when a
199 200 201
  /// popup menu widget is opened.
  String get popupMenuLabel;

202
  /// Label read out by accessibility tools (TalkBack or VoiceOver) when a
203 204 205
  /// dialog widget is opened.
  String get dialogLabel;

206
  /// Label read out by accessibility tools (TalkBack or VoiceOver) when an
207 208 209
  /// alert dialog widget is opened.
  String get alertDialogLabel;

210 211 212 213
  /// Label indicating that a text field is a search field. This will be used
  /// as a hint text in the text field.
  String get searchFieldLabel;

Yegor's avatar
Yegor committed
214 215 216 217
  /// The format used to lay out the time picker.
  ///
  /// The documentation for [TimeOfDayFormat] enum values provides details on
  /// each supported layout.
218
  TimeOfDayFormat timeOfDayFormat({ bool alwaysUse24HourFormat = false });
Yegor's avatar
Yegor committed
219

220
  /// Defines the localized [TextStyle] geometry for [ThemeData.textTheme].
221
  ///
222
  /// The [scriptCategory] defines the overall geometry of a [TextTheme] for
Dan Field's avatar
Dan Field committed
223
  /// the [Typography.geometryThemeFor] method in terms of the
224
  /// three language categories defined in https://material.io/go/design-typography.
225
  ///
226 227 228 229 230
  /// Generally speaking, font sizes for [ScriptCategory.tall] and
  /// [ScriptCategory.dense] scripts - for text styles that are smaller than the
  /// title style - are one unit larger than they are for
  /// [ScriptCategory.englishLike] scripts.
  ScriptCategory get scriptCategory;
231

232 233 234 235
  /// Formats [number] as a decimal, inserting locale-appropriate thousands
  /// separators as necessary.
  String formatDecimal(int number);

236 237
  /// Formats [TimeOfDay.hour] in the given time of day according to the value
  /// of [timeOfDayFormat].
238 239 240
  ///
  /// If [alwaysUse24HourFormat] is true, formats hour using [HourFormat.HH]
  /// rather than the default for the current locale.
241
  String formatHour(TimeOfDay timeOfDay, { bool alwaysUse24HourFormat = false });
242 243 244 245 246 247

  /// Formats [TimeOfDay.minute] in the given time of day according to the value
  /// of [timeOfDayFormat].
  String formatMinute(TimeOfDay timeOfDay);

  /// Formats [timeOfDay] according to the value of [timeOfDayFormat].
248 249 250 251 252
  ///
  /// If [alwaysUse24HourFormat] is true, formats hour using [HourFormat.HH]
  /// rather than the default for the current locale. This value is usually
  /// passed from [MediaQueryData.alwaysUse24HourFormat], which has platform-
  /// specific behavior.
253
  String formatTimeOfDay(TimeOfDay timeOfDay, { bool alwaysUse24HourFormat = false });
254

Yegor's avatar
Yegor committed
255 256 257
  /// Full unabbreviated year format, e.g. 2017 rather than 17.
  String formatYear(DateTime date);

258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280
  /// Formats the date in a compact format.
  ///
  /// Usually just the numeric values for the for day, month and year are used.
  ///
  /// Examples:
  ///
  /// - US English: 02/21/2019
  /// - Russian: 21.02.2019
  ///
  /// See also:
  ///   * [parseCompactDate], which will convert a compact date string to a [DateTime].
  String formatCompactDate(DateTime date);

  /// Formats the date using a short-width format.
  ///
  /// Includes the abbreviation of the month, the day and year.
  ///
  /// Examples:
  ///
  /// - US English: Feb 21, 2019
  /// - Russian: 21 февр. 2019 г.
  String formatShortDate(DateTime date);

Yegor's avatar
Yegor committed
281 282 283 284 285 286 287 288 289 290 291
  /// Formats the date using a medium-width format.
  ///
  /// Abbreviates month and days of week. This appears in the header of the date
  /// picker invoked using [showDatePicker].
  ///
  /// Examples:
  ///
  /// - US English: Wed, Sep 27
  /// - Russian: ср, сент. 27
  String formatMediumDate(DateTime date);

292 293 294 295 296 297 298 299 300 301 302
  /// Formats day of week, month, day of month and year in a long-width format.
  ///
  /// Does not abbreviate names. Appears in spoken announcements of the date
  /// picker invoked using [showDatePicker], when accessibility mode is on.
  ///
  /// Examples:
  ///
  /// - US English: Wednesday, September 27, 2017
  /// - Russian: Среда, Сентябрь 27, 2017
  String formatFullDate(DateTime date);

Yegor's avatar
Yegor committed
303 304 305 306 307 308
  /// Formats the month and the year of the given [date].
  ///
  /// The returned string does not contain the day of the month. This appears
  /// in the date picker invoked using [showDatePicker].
  String formatMonthYear(DateTime date);

309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324
  /// Formats the month and day of the given [date].
  ///
  /// Examples:
  ///
  /// - US English: Feb 21
  /// - Russian: 21 февр.
  String formatShortMonthDay(DateTime date);

  /// Converts the given compact date formatted string into a [DateTime].
  ///
  /// The format of the string must be a valid compact date format for the
  /// given locale. If the text doesn't represent a valid date, `null` will be
  /// returned.
  ///
  /// See also:
  ///   * [formatCompactDate], which will convert a [DateTime] into a string in the compact format.
325
  DateTime? parseCompactDate(String? inputString);
326

Yegor's avatar
Yegor committed
327 328 329 330 331 332 333 334 335 336 337 338
  /// List of week day names in narrow format, usually 1- or 2-letter
  /// abbreviations of full names.
  ///
  /// The list begins with the value corresponding to Sunday and ends with
  /// Saturday. Use [firstDayOfWeekIndex] to find the first day of week in this
  /// list.
  ///
  /// Examples:
  ///
  /// - US English: S, M, T, W, T, F, S
  /// - Russian: вс, пн, вт, ср, чт, пт, сб - notice that the list begins with
  ///   вс (Sunday) even though the first day of week for Russian is Monday.
339
  List<String> get narrowWeekdays;
Yegor's avatar
Yegor committed
340 341 342 343

  /// Index of the first day of week, where 0 points to Sunday, and 6 points to
  /// Saturday.
  ///
344
  /// This getter is compatible with [narrowWeekdays]. For example:
Yegor's avatar
Yegor committed
345 346 347 348
  ///
  /// ```dart
  /// var localizations = MaterialLocalizations.of(context);
  /// // The name of the first day of week for the current locale.
349
  /// var firstDayOfWeek = localizations.narrowWeekdays[localizations.firstDayOfWeekIndex];
Yegor's avatar
Yegor committed
350 351 352
  /// ```
  int get firstDayOfWeekIndex;

353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424
  /// The character string used to separate the parts of a compact date format
  /// (i.e. mm/dd/yyyy has a separator of '/').
  String get dateSeparator;

  /// The help text used on an empty [InputDatePickerFormField] to indicate
  /// to the user the date format being asked for.
  String get dateHelpText;

  /// The semantic label used to announce when the user has entered the year
  /// selection mode of the [CalendarDatePicker] which is used in the data picker
  /// dialog created with [showDatePicker].
  String get selectYearSemanticsLabel;

  /// The label used to indicate a date that has not been entered or selected
  /// yet in the date picker.
  String get unspecifiedDate;

  /// The label used to indicate a date range that has not been entered or
  /// selected yet in the date range picker.
  String get unspecifiedDateRange;

  /// The label used to describe the text field used in an [InputDatePickerFormField].
  String get dateInputLabel;

  /// The label used for the starting date input field in the date range picker
  /// created with [showDateRangePicker].
  String get dateRangeStartLabel;

  /// The label used for the ending date input field in the date range picker
  /// created with [showDateRangePicker].
  String get dateRangeEndLabel;

  /// The semantics label used for the selected start date in the date range
  /// picker's day grid.
  String dateRangeStartDateSemanticLabel(String formattedDate);

  /// The semantics label used for the selected end date in the date range
  /// picker's day grid.
  String dateRangeEndDateSemanticLabel(String formattedDate);

  /// Error message displayed to the user when they have entered a text string
  /// in an [InputDatePickerFormField] that is not in a valid date format.
  String get invalidDateFormatLabel;

  /// Error message displayed to the user when they have entered an invalid
  /// date range in the input mode of the date range picker created with
  /// [showDateRangePicker].
  String get invalidDateRangeLabel;

  /// Error message displayed to the user when they have entered a date that
  /// is outside the valid range for the date picker.
  /// [showDateRangePicker].
  String get dateOutOfRangeLabel;

  /// Label for a 'SAVE' button. Currently used by the full screen mode of the
  /// date range picker.
  String get saveButtonLabel;

  /// Label used in the header of the date picker dialog created with
  /// [showDatePicker].
  String get datePickerHelpText;

  /// Label used in the header of the date range picker dialog created with
  /// [showDateRangePicker].
  String get dateRangePickerHelpText;

  /// Tooltip used for the calendar mode button of the date pickers.
  String get calendarModeButtonLabel;

  /// Tooltip used for the text input mode button of the date pickers.
  String get inputDateModeButtonLabel;

425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450
  /// Label used in the header of the time picker dialog created with
  /// [showTimePicker] when in [TimePickerEntryMode.dial].
  String get timePickerDialHelpText;

  /// Label used in the header of the time picker dialog created with
  /// [showTimePicker] when in [TimePickerEntryMode.input].
  String get timePickerInputHelpText;

  /// Label used below the hour text field of the time picker dialog created
  /// with [showTimePicker] when in [TimePickerEntryMode.input].
  String get timePickerHourLabel;

  /// Label used below the minute text field of the time picker dialog created
  /// with [showTimePicker] when in [TimePickerEntryMode.input].
  String get timePickerMinuteLabel;

  /// Error message for the time picker dialog created with [showTimePicker]
  /// when in [TimePickerEntryMode.input].
  String get invalidTimeLabel;

  /// Tooltip used to put the time picker into [TimePickerEntryMode.dial].
  String get dialModeButtonLabel;

  /// Tooltip used to put the time picker into [TimePickerEntryMode.input].
  String get inputTimeModeButtonLabel;

451 452 453 454 455 456 457 458 459 460 461 462
  /// The semantics label used to indicate which account is signed in in the
  /// [UserAccountsDrawerHeader] widget.
  String get signedInLabel;

  /// The semantics label used for the button on [UserAccountsDrawerHeader] that
  /// hides the list of accounts.
  String get hideAccountsLabel;

  /// The semantics label used for the button on [UserAccountsDrawerHeader] that
  /// shows the list of accounts.
  String get showAccountsLabel;

463
  /// The semantics label used for [ReorderableListView] to reorder an item in the
464 465 466
  /// list to the start of the list.
  String get reorderItemToStart;

467
  /// The semantics label used for [ReorderableListView] to reorder an item in the
468 469 470
  /// list to the end of the list.
  String get reorderItemToEnd;

471
  /// The semantics label used for [ReorderableListView] to reorder an item in the
472 473 474
  /// list one space up the list.
  String get reorderItemUp;

475
  /// The semantics label used for [ReorderableListView] to reorder an item in the
476 477 478
  /// list one space down the list.
  String get reorderItemDown;

479
  /// The semantics label used for [ReorderableListView] to reorder an item in the
480 481 482
  /// list one space left in the list.
  String get reorderItemLeft;

483
  /// The semantics label used for [ReorderableListView] to reorder an item in the
484 485 486
  /// list one space right in the list.
  String get reorderItemRight;

487 488 489 490 491 492
  /// The semantics hint to describe the tap action on an expanded [ExpandIcon].
  String get expandedIconTapHint => 'Collapse';

  /// The semantics hint to describe the tap action on a collapsed [ExpandIcon].
  String get collapsedIconTapHint => 'Expand';

493 494 495
  /// The label for the [TextField]'s character counter.
  String remainingTextFieldCharacterCount(int remaining);

496 497 498
  /// The default semantics label for a [RefreshIndicator].
  String get refreshIndicatorSemanticLabel;

499 500 501
  /// The `MaterialLocalizations` from the closest [Localizations] instance
  /// that encloses the given context.
  ///
502 503 504
  /// If no [MaterialLocalizations] are available in the given `context`, this
  /// method throws an exception.
  ///
505
  /// This method is just a convenient shorthand for:
506
  /// `Localizations.of<MaterialLocalizations>(context, MaterialLocalizations)!`.
507 508 509
  ///
  /// References to the localized resources defined by this class are typically
  /// written in terms of this method. For example:
510
  ///
511 512 513
  /// ```dart
  /// tooltip: MaterialLocalizations.of(context).backButtonTooltip,
  /// ```
514
  static MaterialLocalizations of(BuildContext context) {
515
    assert(debugCheckHasMaterialLocalizations(context));
516
    return Localizations.of<MaterialLocalizations>(context, MaterialLocalizations)!;
517 518
  }
}
519

520 521 522
class _MaterialLocalizationsDelegate extends LocalizationsDelegate<MaterialLocalizations> {
  const _MaterialLocalizationsDelegate();

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

526 527 528 529 530
  @override
  Future<MaterialLocalizations> load(Locale locale) => DefaultMaterialLocalizations.load(locale);

  @override
  bool shouldReload(_MaterialLocalizationsDelegate old) => false;
531 532 533

  @override
  String toString() => 'DefaultMaterialLocalizations.delegate(en_US)';
534 535 536 537 538 539 540 541
}

/// US English strings for the material widgets.
///
/// See also:
///
///  * [GlobalMaterialLocalizations], which provides material localizations for
///    many languages.
Dan Field's avatar
Dan Field committed
542
///  * [MaterialApp.localizationsDelegates], which automatically includes
543
///    [DefaultMaterialLocalizations.delegate] by default.
544
class DefaultMaterialLocalizations implements MaterialLocalizations {
Yegor's avatar
Yegor committed
545
  /// Constructs an object that defines the material widgets' localized strings
546
  /// for US English (only).
547 548 549
  ///
  /// [LocalizationsDelegate] implementations typically call the static [load]
  /// function, rather than constructing this class directly.
550 551
  const DefaultMaterialLocalizations();

552
  // Ordered to match DateTime.monday=1, DateTime.sunday=6
553
  static const List<String> _shortWeekdays = <String>[
554 555 556 557 558 559 560 561 562
    'Mon',
    'Tue',
    'Wed',
    'Thu',
    'Fri',
    'Sat',
    'Sun',
  ];

563
  // Ordered to match DateTime.monday=1, DateTime.sunday=6
564
  static const List<String> _weekdays = <String>[
565 566 567 568 569 570 571 572 573
    'Monday',
    'Tuesday',
    'Wednesday',
    'Thursday',
    'Friday',
    'Saturday',
    'Sunday',
  ];

574
  static const List<String> _narrowWeekdays = <String>[
575 576 577 578 579 580 581 582 583
    'S',
    'M',
    'T',
    'W',
    'T',
    'F',
    'S',
  ];

584
  static const List<String> _shortMonths = <String>[
585 586 587 588 589 590 591 592 593 594 595 596 597 598
    'Jan',
    'Feb',
    'Mar',
    'Apr',
    'May',
    'Jun',
    'Jul',
    'Aug',
    'Sep',
    'Oct',
    'Nov',
    'Dec',
  ];

599
  static const List<String> _months = <String>[
600 601 602 603 604 605 606 607 608 609 610 611 612
    'January',
    'February',
    'March',
    'April',
    'May',
    'June',
    'July',
    'August',
    'September',
    'October',
    'November',
    'December',
  ];
613

614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630
  /// Returns the number of days in a month, according to the proleptic
  /// Gregorian calendar.
  ///
  /// This applies the leap year logic introduced by the Gregorian reforms of
  /// 1582. It will not give valid results for dates prior to that time.
  int _getDaysInMonth(int year, int month) {
    if (month == DateTime.february) {
      final bool isLeapYear = (year % 4 == 0) && (year % 100 != 0) ||
          (year % 400 == 0);
      if (isLeapYear)
        return 29;
      return 28;
    }
    const List<int> daysInMonth = <int>[31, -1, 31, 30, 31, 30, 31, 31, 30, 31, 30, 31];
    return daysInMonth[month - 1];
  }

631
  @override
632
  String formatHour(TimeOfDay timeOfDay, { bool alwaysUse24HourFormat = false }) {
633 634 635 636 637 638 639
    final TimeOfDayFormat format = timeOfDayFormat(alwaysUse24HourFormat: alwaysUse24HourFormat);
    switch (format) {
      case TimeOfDayFormat.h_colon_mm_space_a:
        return formatDecimal(timeOfDay.hourOfPeriod == 0 ? 12 : timeOfDay.hourOfPeriod);
      case TimeOfDayFormat.HH_colon_mm:
        return _formatTwoDigitZeroPad(timeOfDay.hour);
      default:
640
        throw AssertionError('$runtimeType does not support $format.');
641 642 643 644 645 646 647 648 649 650 651 652
    }
  }

  /// Formats [number] using two digits, assuming it's in the 0-99 inclusive
  /// range. Not designed to format values outside this range.
  String _formatTwoDigitZeroPad(int number) {
    assert(0 <= number && number < 100);

    if (number < 10)
      return '0$number';

    return '$number';
653 654 655 656
  }

  @override
  String formatMinute(TimeOfDay timeOfDay) {
657 658
    final int minute = timeOfDay.minute;
    return minute < 10 ? '0$minute' : minute.toString();
659 660
  }

Yegor's avatar
Yegor committed
661
  @override
662
  String formatYear(DateTime date) => date.year.toString();
Yegor's avatar
Yegor committed
663

664 665 666 667 668 669 670 671 672 673 674 675 676 677 678
  @override
  String formatCompactDate(DateTime date) {
    // Assumes US mm/dd/yyyy format
    final String month = _formatTwoDigitZeroPad(date.month);
    final String day = _formatTwoDigitZeroPad(date.day);
    final String year = date.year.toString().padLeft(4, '0');
    return '$month/$day/$year';
  }

  @override
  String formatShortDate(DateTime date) {
    final String month = _shortMonths[date.month - DateTime.january];
    return '$month ${date.day}, ${date.year}';
  }

Yegor's avatar
Yegor committed
679 680
  @override
  String formatMediumDate(DateTime date) {
681 682
    final String day = _shortWeekdays[date.weekday - DateTime.monday];
    final String month = _shortMonths[date.month - DateTime.january];
683
    return '$day, $month ${date.day}';
Yegor's avatar
Yegor committed
684 685
  }

686 687
  @override
  String formatFullDate(DateTime date) {
688 689
    final String month = _months[date.month - DateTime.january];
    return '${_weekdays[date.weekday - DateTime.monday]}, $month ${date.day}, ${date.year}';
690 691
  }

Yegor's avatar
Yegor committed
692 693
  @override
  String formatMonthYear(DateTime date) {
694
    final String year = formatYear(date);
695
    final String month = _months[date.month - DateTime.january];
696
    return '$month $year';
Yegor's avatar
Yegor committed
697 698
  }

699 700 701 702 703 704 705
  @override
  String formatShortMonthDay(DateTime date) {
    final String month = _shortMonths[date.month - DateTime.january];
    return '$month ${date.day}';
  }

  @override
706 707 708 709 710
  DateTime? parseCompactDate(String? inputString) {
    if (inputString == null) {
      return null;
    }

711 712 713 714 715 716
    // Assumes US mm/dd/yyyy format
    final List<String> inputParts = inputString.split('/');
    if (inputParts.length != 3) {
      return null;
    }

717
    final int? year = int.tryParse(inputParts[2], radix: 10);
718 719 720 721
    if (year == null || year < 1) {
      return null;
    }

722
    final int? month = int.tryParse(inputParts[0], radix: 10);
723 724 725 726
    if (month == null || month < 1 || month > 12) {
      return null;
    }

727
    final int? day = int.tryParse(inputParts[1], radix: 10);
728 729 730 731 732 733
    if (day == null || day < 1 || day > _getDaysInMonth(year, month)) {
      return null;
    }
    return DateTime(year, month, day);
  }

Yegor's avatar
Yegor committed
734
  @override
735
  List<String> get narrowWeekdays => _narrowWeekdays;
Yegor's avatar
Yegor committed
736 737

  @override
738
  int get firstDayOfWeekIndex => 0; // narrowWeekdays[0] is 'S' for Sunday
Yegor's avatar
Yegor committed
739

740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793
  @override
  String get dateSeparator => '/';

  @override
  String get dateHelpText => 'mm/dd/yyyy';

  @override
  String get selectYearSemanticsLabel => 'Select year';

  @override
  String get unspecifiedDate => 'Date';

  @override
  String get unspecifiedDateRange => 'Date Range';

  @override
  String get dateInputLabel => 'Enter Date';

  @override
  String get dateRangeStartLabel => 'Start Date';

  @override
  String get dateRangeEndLabel => 'End Date';

  @override
  String dateRangeStartDateSemanticLabel(String fullDate) => 'Start date $fullDate';

  @override
  String dateRangeEndDateSemanticLabel(String fullDate) => 'End date $fullDate';

  @override
  String get invalidDateFormatLabel => 'Invalid format.';

  @override
  String get invalidDateRangeLabel => 'Invalid range.';

  @override
  String get dateOutOfRangeLabel => 'Out of range.';

  @override
  String get saveButtonLabel => 'SAVE';

  @override
  String get datePickerHelpText => 'SELECT DATE';

  @override
  String get dateRangePickerHelpText => 'SELECT RANGE';

  @override
  String get calendarModeButtonLabel => 'Switch to calendar';

  @override
  String get inputDateModeButtonLabel => 'Switch to input';

794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814
  @override
  String get timePickerDialHelpText => 'SELECT TIME';

  @override
  String get timePickerInputHelpText => 'ENTER TIME';

  @override
  String get timePickerHourLabel => 'Hour';

  @override
  String get timePickerMinuteLabel => 'Minute';

  @override
  String get invalidTimeLabel => 'Enter a valid time';

  @override
  String get dialModeButtonLabel => 'Switch to dial picker mode';

  @override
  String get inputTimeModeButtonLabel => 'Switch to text input mode';

815 816 817 818 819 820 821 822 823
  String _formatDayPeriod(TimeOfDay timeOfDay) {
    switch (timeOfDay.period) {
      case DayPeriod.am:
        return anteMeridiemAbbreviation;
      case DayPeriod.pm:
        return postMeridiemAbbreviation;
    }
  }

824
  @override
825
  String formatDecimal(int number) {
826 827 828 829
    if (number > -1000 && number < 1000)
      return number.toString();

    final String digits = number.abs().toString();
830
    final StringBuffer result = StringBuffer(number < 0 ? '-' : '');
831 832 833 834 835 836 837
    final int maxDigitIndex = digits.length - 1;
    for (int i = 0; i <= maxDigitIndex; i += 1) {
      result.write(digits[i]);
      if (i < maxDigitIndex && (maxDigitIndex - i) % 3 == 0)
        result.write(',');
    }
    return result.toString();
838 839 840
  }

  @override
841
  String formatTimeOfDay(TimeOfDay timeOfDay, { bool alwaysUse24HourFormat = false }) {
842 843 844 845 846 847 848 849
    // Not using intl.DateFormat for two reasons:
    //
    // - DateFormat supports more formats than our material time picker does,
    //   and we want to be consistent across time picker format and the string
    //   formatting of the time of day.
    // - DateFormat operates on DateTime, which is sensitive to time eras and
    //   time zones, while here we want to format hour and minute within one day
    //   no matter what date the day falls on.
850
    final StringBuffer buffer = StringBuffer();
851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867

    // Add hour:minute.
    buffer
      ..write(formatHour(timeOfDay, alwaysUse24HourFormat: alwaysUse24HourFormat))
      ..write(':')
      ..write(formatMinute(timeOfDay));

    if (alwaysUse24HourFormat) {
      // There's no AM/PM indicator in 24-hour format.
      return '$buffer';
    }

    // Add AM/PM indicator.
    buffer
      ..write(' ')
      ..write(_formatDayPeriod(timeOfDay));
    return '$buffer';
868 869
  }

870
  @override
871
  String get openAppDrawerTooltip => 'Open navigation menu';
872 873

  @override
874
  String get backButtonTooltip => 'Back';
875 876

  @override
877
  String get closeButtonTooltip => 'Close';
878

879 880 881
  @override
  String get deleteButtonTooltip => 'Delete';

882 883 884
  @override
  String get moreButtonTooltip => 'More';

885
  @override
886
  String get nextMonthTooltip => 'Next month';
887 888

  @override
889
  String get previousMonthTooltip => 'Previous month';
890

891
  @override
892
  String get nextPageTooltip => 'Next page';
893 894

  @override
895
  String get previousPageTooltip => 'Previous page';
896

897 898 899 900 901 902
  @override
  String get firstPageTooltip => 'First page';

  @override
  String get lastPageTooltip => 'Last page';

903
  @override
904
  String get showMenuTooltip => 'Show menu';
905

906 907 908 909 910 911 912 913 914 915 916 917
  @override
  String get drawerLabel => 'Navigation menu';

  @override
  String get popupMenuLabel => 'Popup menu';

  @override
  String get dialogLabel => 'Dialog';

  @override
  String get alertDialogLabel => 'Alert';

918 919 920
  @override
  String get searchFieldLabel => 'Search';

Hans Muller's avatar
Hans Muller committed
921
  @override
922
  String aboutListTileTitle(String applicationName) => 'About $applicationName';
Hans Muller's avatar
Hans Muller committed
923

924
  @override
925
  String get licensesPageTitle => 'Licenses';
926

927 928
  @override
  String licensesPackageDetailText(int licenseCount) {
929
    assert (licenseCount >= 0);
930
    switch (licenseCount) {
931 932
      case 0:
        return 'No licenses.';
933
      case 1:
934
        return '1 license.';
935
      default:
936
        return '$licenseCount licenses.';
937 938 939
    }
  }

940 941
  @override
  String pageRowsInfoTitle(int firstRow, int lastRow, int rowCount, bool rowCountIsApproximate) {
942 943 944
    return rowCountIsApproximate
      ? '$firstRow$lastRow of about $rowCount'
      : '$firstRow$lastRow of $rowCount';
945 946 947
  }

  @override
948
  String get rowsPerPageTitle => 'Rows per page:';
949

950
  @override
951
  String tabLabel({ required int tabIndex, required int tabCount }) {
952 953 954 955 956
    assert(tabIndex >= 1);
    assert(tabCount >= 1);
    return 'Tab $tabIndex of $tabCount';
  }

957 958
  @override
  String selectedRowCountTitle(int selectedRowCount) {
959 960 961 962 963 964 965 966
    switch (selectedRowCount) {
      case 0:
        return 'No items selected';
      case 1:
        return '1 item selected';
      default:
        return '$selectedRowCount items selected';
    }
967
  }
968 969

  @override
970
  String get cancelButtonLabel => 'CANCEL';
971 972

  @override
973
  String get closeButtonLabel => 'CLOSE';
974 975

  @override
976
  String get continueButtonLabel => 'CONTINUE';
977 978

  @override
979
  String get copyButtonLabel => 'Copy';
980 981

  @override
982
  String get cutButtonLabel => 'Cut';
983 984

  @override
985
  String get okButtonLabel => 'OK';
986 987

  @override
988
  String get pasteButtonLabel => 'Paste';
989 990

  @override
991
  String get selectAllButtonLabel => 'Select all';
992 993

  @override
994
  String get viewLicensesButtonLabel => 'VIEW LICENSES';
995

Yegor's avatar
Yegor committed
996
  @override
997
  String get anteMeridiemAbbreviation => 'AM';
Yegor's avatar
Yegor committed
998 999

  @override
1000
  String get postMeridiemAbbreviation => 'PM';
Yegor's avatar
Yegor committed
1001

1002 1003 1004 1005 1006 1007
  @override
  String get timePickerHourModeAnnouncement => 'Select hours';

  @override
  String get timePickerMinuteModeAnnouncement => 'Select minutes';

1008 1009 1010
  @override
  String get modalBarrierDismissLabel => 'Dismiss';

1011 1012 1013
  @override
  ScriptCategory get scriptCategory => ScriptCategory.englishLike;

1014
  @override
1015
  TimeOfDayFormat timeOfDayFormat({ bool alwaysUse24HourFormat = false }) {
1016 1017 1018 1019
    return alwaysUse24HourFormat
      ? TimeOfDayFormat.HH_colon_mm
      : TimeOfDayFormat.h_colon_mm_space_a;
  }
Yegor's avatar
Yegor committed
1020

1021 1022 1023 1024 1025 1026 1027 1028 1029
  @override
  String get signedInLabel => 'Signed in';

  @override
  String get hideAccountsLabel => 'Hide accounts';

  @override
  String get showAccountsLabel => 'Show accounts';

1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047
  @override
  String get reorderItemUp => 'Move up';

  @override
  String get reorderItemDown => 'Move down';

  @override
  String get reorderItemLeft => 'Move left';

  @override
  String get reorderItemRight => 'Move right';

  @override
  String get reorderItemToEnd => 'Move to the end';

  @override
  String get reorderItemToStart => 'Move to the start';

1048 1049 1050 1051 1052 1053
  @override
  String get expandedIconTapHint => 'Collapse';

  @override
  String get collapsedIconTapHint => 'Expand';

1054 1055 1056
  @override
  String get refreshIndicatorSemanticLabel => 'Refresh';

1057 1058 1059 1060
  /// Creates an object that provides US English resource values for the material
  /// library widgets.
  ///
  /// The [locale] parameter is ignored.
1061 1062 1063 1064
  ///
  /// This method is typically used to create a [LocalizationsDelegate].
  /// The [MaterialApp] does so by default.
  static Future<MaterialLocalizations> load(Locale locale) {
1065
    return SynchronousFuture<MaterialLocalizations>(const DefaultMaterialLocalizations());
1066
  }
Yegor's avatar
Yegor committed
1067

1068 1069 1070 1071
  /// A [LocalizationsDelegate] that uses [DefaultMaterialLocalizations.load]
  /// to create an instance of this class.
  ///
  /// [MaterialApp] automatically adds this value to [MaterialApp.localizationsDelegates].
1072
  static const LocalizationsDelegate<MaterialLocalizations> delegate = _MaterialLocalizationsDelegate();
1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084

  @override
  String remainingTextFieldCharacterCount(int remaining) {
    switch (remaining) {
      case 0:
        return 'No characters remaining';
      case 1:
        return '1 character remaining';
      default:
        return '$remaining characters remaining';
    }
  }
Yegor's avatar
Yegor committed
1085
}