# 国际化-I18n > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** > - 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 > > - I18N模块包含国际化能力增强接口（未在ECMA 402中定义）。 ## 导入模块 ``` import i18n from '@ohos.i18n'; ``` ## i18n.getDisplayLanguage getDisplayLanguage(language: string, locale: string, sentenceCase?: boolean): string 获取指定语言的本地化显示文本。 **系统能力**：SystemCapability.Global.I18n - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | language | string | 是 | 指定语言。 | | locale | string | 是 | 显示指定语言的区域ID。 | | sentenceCase | boolean | 否 | 本地化显示文本是否要首字母大写。 | - 返回值： | 类型 | 说明 | | -------- | -------- | | string | 指定语言的本地化显示文本。 | - 示例： ``` i18n.getDisplayLanguage("zh", "en-GB", true); i18n.getDisplayLanguage("zh", "en-GB"); ``` ## i18n.getDisplayCountry getDisplayCountry(country: string, locale: string, sentenceCase?: boolean): string 获取指定国家的本地化显示文本。 **系统能力**：SystemCapability.Global.I18n - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | country | string | 是 | 指定国家。 | | locale | string | 是 | 显示指定国家的区域ID。 | | sentenceCase | boolean | 否 | 本地化显示文本是否要首字母大写。 | - 返回值： | 类型 | 说明 | | -------- | -------- | | string | 指定国家的本地化显示文本。 | - 示例： ``` i18n.getDisplayCountry("zh-CN", "en-GB", true); i18n.getDisplayCountry("zh-CN", "en-GB"); ``` ## i18n.isRTL8+ isRTL(locale: string): boolean 获取是否为从右至左显示语言。 **系统能力**：SystemCapability.Global.I18n - 参数： | 参数名 | 类型 | 说明 | | -------- | -------- | -------- | | locale | string | 指定区域ID。 | - 返回值： | 类型 | 说明 | | -------- | -------- | | boolean | true表示该locale从右至左显示语言；false表示该locale从左至右显示语言。 | - 示例： ``` i18n.isRTL("zh-CN");// 中文不是RTL语言，返回false i18n.isRTL("ar-EG");// 阿语是RTL语言，返回true ``` ## i18n.getSystemLanguage getSystemLanguage(): string 获取系统语言。 **系统能力**：SystemCapability.Global.I18n - 返回值： | 类型 | 说明 | | -------- | -------- | | string | 系统语言ID。 | - 示例： ``` i18n.getSystemLanguage(); ``` ## i18n.setSystemLanguage setSystemLanguage(): boolean 设置系统语言。 **系统能力**：SystemCapability.Global.I18n - 返回值： | 类型 | 说明 | | -------- | -------- | | boolean | 返回true，表示系统语言设置成功；返回false，表示系统语言设置失败。 | - 示例： ``` i18n.setSystemLanguage(); ``` ## i18n.getSystemLanguages getSystemLanguages(): Array 获取系统支持的语言列表。 **系统能力**：SystemCapability.Global.I18n - 返回值： | 类型 | 说明 | | -------- | -------- | | Array | 系统支持的语言ID列表。 | - 示例： ``` i18n.getSystemLanguages(); ``` ## i18n.getSystemCountries getSystemCountries(): Array 获取系统支持的区域列表。 **系统能力**：SystemCapability.Global.I18n - 返回值： | 类型 | 说明 | | -------- | -------- | | Array | 系统支持的区域ID列表。 | - 示例： ``` i18n.getSystemCountries(); ``` ## i18n.getSystemRegion getSystemRegion(): string 获取系统地区。 **系统能力**：SystemCapability.Global.I18n - 返回值： | 类型 | 说明 | | -------- | -------- | | string | 系统地区ID。 | - 示例： ``` i18n.getSystemRegion(); ``` ## i18n.setSystemRegion setSystemRegion(): boolean 设置系统区域。 **系统能力**：SystemCapability.Global.I18n - 返回值： | 类型 | 说明 | | -------- | -------- | | boolean | 返回true，表示系统区域设置成功；返回false，表示系统区域设置失败。 | - 示例： ``` i18n.setSystemRegion(); ``` ## i18n.getSystemLocale getSystemLocale(): string 获取系统区域。 **系统能力**：SystemCapability.Global.I18n - 返回值： | 类型 | 说明 | | -------- | -------- | | string | 系统区域ID。 | - 示例： ``` i18n.getSystemLocale(); ``` ## i18n.setSystemLocale setSystemLocale(locale: string): boolean 设置系统Locale。 **系统能力**：SystemCapability.Global.I18n - 参数： | 参数名 | 类型 | 说明 | | -------- | -------- | -------- | | locale | string | 指定区域ID，例如zh-CN。 | - 返回值： | 类型 | 说明 | | -------- | -------- | | boolean | 返回true，表示系统Locale设置成功；返回false，表示系统Locale设置失败。 | - 示例： ``` i18n.setSystemLocale('zh-CN'); ``` ## i18n.isSuggested isSuggested(language: string, region?: string): boolean 判断当前语言和区域是否匹配。 **系统能力**：SystemCapability.Global.I18n - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | language | string | 是 | 合法的语言ID，例如zh。 | | region | string | 否 | 合法的地区ID，例如CN | - 返回值： | 类型 | 说明 | | -------- | -------- | | boolean | 返回true，表示当前语言和地区匹配；返回false，表示当前语言和地区不匹配。 | - 示例： ``` i18n.isSuggested('zh', 'CN'); ``` ## i18n.getCalendar8+ getCalendar(locale: string, type? : string): Calendar 获取日历对象。 **系统能力**：SystemCapability.Global.I18n - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | locale | string | 是 | 合法的locale值，例如zh-Hans-CN。 | | type | string | 否 | 合法的日历类型，目前合法的类型有buddhist, chinese, coptic, ethiopic, hebrew, gregory, indian, islamic_civil, islamic_tbla, islamic_umalqura, japanese, persian。当type没有给出时，采用区域默认的日历类型。 | - 返回值： | 类型 | 说明 | | -------- | -------- | | [Calendar](#calendar8) | 日历对象。 | - 示例： ``` i18n.getCalendar("zh-Hans", "gregory"); ``` ## Calendar8+ ### setTime8+ setTime(date: Date): void 设置日历对象内部的时间日期。 **系统能力**：SystemCapability.Global.I18n - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | date | Date | 是 | 将要设置的日历对象的内部时间日期。 | - 示例： ``` var calendar = I18n.getCalendar("en-US", "gregory"); var date = new Date(2021, 10, 7, 8, 0, 0, 0); calendar.setTime(date); ``` ### setTime8+ setTime(time: number): void 设置日历对象内部的时间日期, time为从1970.1.1 00:00:00 GMT逝去的毫秒数。 **系统能力**：SystemCapability.Global.I18n - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | time | number | 是 | time为从1970.1.1 00:00:00 GMT逝去的毫秒数。 | - 示例： ``` var calendar = I18n.getCalendar("en-US", "gregory"); calendar.setTime(10540800000); ``` ### set8+ set(year: number, month: number, date:number, hour?: number, minute?: number, second?: number): void 设置日历对象的年、月、日、时、分、秒。 **系统能力**：SystemCapability.Global.I18n - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | year | number | 是 | 设置的年。 | | month | number | 是 | 设置的月。 | | date | number | 是 | 设置的日。 | | hour | number | 否 | 设置的小时。 | | minute | number | 否 | 设置的分钟。 | | second | number | 否 | 设置的秒。 | - 示例： ``` var calendar = i18n.getCalendar("zh-Hans"); calendar.setTime(2021, 10, 1, 8, 0, 0); // set time to 2021.10.1 08:00:00 ``` ### setTimeZone8+ setTimeZone(timezone: string): void 设置日历对象的时区。 **系统能力**：SystemCapability.Global.I18n - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | timezone | string | 是 | 设置的时区id，如“Asia/Shanghai”。 | - 示例： ``` var calendar = i18n.getCalendar("zh-Hans"); calendar.setTimeZone("Asia/Shanghai"); ``` ### getTimeZone8+ getTimeZone(): string 获取日历对象的时区。 **系统能力**：SystemCapability.Global.I18n - 返回值： | 类型 | 说明 | | -------- | -------- | | string | 日历对象的时区id。 | - 示例： ``` var calendar = i18n.getCalendar("zh-Hans"); calendar.setTimeZone("Asia/Shanghai"); calendar.getTimeZone(); // Asia/Shanghai" ``` ### getFirstDayOfWeek8+ getFirstDayOfWeek(): number 获取日历对象的一周起始日。 **系统能力**：SystemCapability.Global.I18n - 返回值： | 类型 | 说明 | | -------- | -------- | | number | 获取一周的起始日，1代表周日，7代表周六。 | - 示例： ``` var calendar = I18n.getCalendar("en-US", "gregory"); calendar.getFirstDayOfWeek(); ``` ### setFirstDayOfWeek8+ setFirstDayOfWeek(value: number): void 设置每一周的起始日。 **系统能力**：SystemCapability.Global.I18n - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | value | number | 否 | 设置一周的起始日，1代表周日，7代表周六。 | - 示例： ``` var calendar = i18n.getCalendar("zh-Hans"); calendar.setFirstDayOfWeek(0); ``` ### getMinimalDaysInFirstWeek8+ getMinimalDaysInFirstWeek(): number 获取一年中第一周的最小天数。 **系统能力**：SystemCapability.Global.I18n - 返回值： | 类型 | 说明 | | -------- | -------- | | number | 一年中第一周的最小天数。 | - 示例： ``` var calendar = i18n.getCalendar("zh-Hans"); calendar.getMinimalDaysInFirstWeek(); ``` ### setMinimalDaysInFirstWeek8+ setMinimalDaysInFirstWeek(value: number): void 设置一年中第一周的最小天数。 **系统能力**：SystemCapability.Global.I18n - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | value | number | 否 | 一年中第一周的最小天数。 | - 示例： ``` var calendar = i18n.getCalendar("zh-Hans"); calendar.setMinimalDaysInFirstWeek(3); ``` ### get8+ get(field: string): number 获取日历对象中与field相关联的值。 **系统能力**：SystemCapability.Global.I18n - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | field | string | 是 | 通过field来获取日历对象相应的值。目前支持的field值有 era, year, month, week_of_year, week_of_month, date, day_of_year, day_of_week, day_of_week_in_month, hour, hour_of_day, minute, second, millisecond, zone_offset, dst_offset, year_woy, dow_local, extended_year, julian_day, milliseconds_in_day, is_leap_month。 | - 返回值： | 类型 | 说明 | | -------- | -------- | | number | 与field相关联的值，如当前Calendar对象的内部日期的年份为1990，get("year")返回1990。 | - 示例： ``` var calendar = i18n.getCalendar("zh-Hans"); calendar.setTime(2021, 10, 1, 8, 0, 0); // set time to 2021.10.1 08:00:00 calendar.get("hour_of_day"); // 8 ``` ### getDisplayName8+ getDisplayName(locale: string): string 获取日历对象在locale所指定的区域的名字。 **系统能力**：SystemCapability.Global.I18n - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | locale | string | 是 | locale指定获取哪个区域下该calendar的名字，如buddhist在en-US上显示的名称为“Buddhist Calendar”。 | - 返回值： | 类型 | 说明 | | -------- | -------- | | string | 日历在locale所指示的区域的名字。 | - 示例： ``` var calendar = i18n.getCalendar("en-US", "buddhist"); calendar.getDisplayName("zh"); // 佛历 ``` ### isWeekend8+ isWeekend(date?: Date): boolean 判断给定的日期是否在日历中是周末。 **系统能力**：SystemCapability.Global.I18n - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | date | Date | 否 | 判断日期在日历中是否是周末。如果date没有给出，判断calendar当前日期是否为周末。 | - 返回值： | 类型 | 说明 | | -------- | -------- | | boolean | 当所判断的日期为周末时，返回 true，否则返回false。 | - 示例： ``` var calendar = i18n.getCalendar("zh-Hans"); calendar.setTime(2021, 11, 11, 8, 0, 0); // set time to 2021.11.11 08:00:00 calendar.isWeekend(); // false var date = new Date(2011, 11, 6, 9, 0, 0); calendar.isWeekend(date); // true ``` ## PhoneNumberFormat8+ ### constructor8+ constructor(country: string, options?: PhoneNumberFormatOptions) 创建电话号码格式化对象。 **系统能力**：SystemCapability.Global.I18n 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | country | string | 是 | 表示电话号码所属国家或地区代码。 | | options | [PhoneNumberFormatOptions](#phonenumberformatoptions8) | 否 | 电话号码格式化对象的相关选项。 | - 示例： ``` var phoneNumberFormat= new i18n.PhoneNumberFormat("CN", {"type": "E164"}); ``` ### isValidNumber8+ isValidNumber(number: string): boolean 判断传入的电话号码格式是否正确。 **系统能力**：SystemCapability.Global.I18n - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | number | string | 是 | 待判断的电话号码。 | - 返回值： | 类型 | 说明 | | -------- | -------- | | boolean | 返回true表示电话号码的格式正确，返回false表示电话号码的格式错误。 | - 示例： ``` var phonenumberfmt = new i18n.PhoneNumberFormat("CN"); phonenumberfmt.isValidNumber("15812312312"); ``` ### format8+ format(number: string): string 对电话号码进行格式化。 **系统能力**：SystemCapability.Global.I18n - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | number | string | 是 | 待格式化的电话号码。 | - 返回值： | 类型 | 说明 | | -------- | -------- | | string | 格式化后的电话号码。 | - 示例： ``` var phonenumberfmt = new i18n.PhoneNumberFormat("CN"); phonenumberfmt.format("15812312312"); ``` ## PhoneNumberFormatOptions8+ 表示电话号码格式化对象可设置的属性。 | 名称 | 参数类型 | 可读 | 可写 | 说明 | | -------- | -------- | -------- | -------- | -------- | | type | string | 是 | 是 | 表示对电话号码格式化的类型，取值范围："E164", "INTERNATIONAL", "NATIONAL", "RFC3966"。
**系统能力**：SystemCapability.Global.I18n | ## UnitInfo8+ 度量衡单位信息。 | 名称 | 参数类型 | 可读 | 可写 | 说明 | | -------- | -------- | -------- | -------- | -------- | | unit | string | 是 | 是 | 单位的名称，如："meter", "inch", "cup"等。 | | measureSystem | string | 是 | 是 | 单位的度量体系，取值包括："SI", "US", "UK"。
**系统能力**：SystemCapability.Global.I18n | ## Util8+ ### unitConvert8+ unitConvert(fromUnit: UnitInfo, toUnit: UnitInfo, value: number, locale: string, style?: string): string 将fromUnit的单位转换为toUnit的单位，并根据区域与风格进行格式化。 **系统能力**：SystemCapability.Global.I18n - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | fromUnit | [UnitInfo](#unitinfo8) | 是 | 要被转换的单位。 | | toUnit | [UnitInfo](#unitinfo8) | 是 | 要转换为的单位。 | | value | number | 是 | 要被转换的单位的数量值。 | | locale | string | 是 | 格式化时使用的区域参数，如：zh-Hans-CN。 | | style | string | 否 | 格式化使用的风格，取值包括："long", "short", "medium"。 | - 返回值： | 类型 | 说明 | | -------- | -------- | | string | 按照toUnit的单位格式化后，得到的字符串。 | - 示例： ``` I18n.Util.unitConvert({unit: "cup", measureSystem: "US"}, {unit: "liter", measureSystem: "SI"}, 1000, "en-US", "long"); ``` ## getInstance8+ getInstance(): IndexUtil 创建并返回IndexUtil对象。 **系统能力**：SystemCapability.Global.I18n - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | locale | string | 否 | 包含区域设置信息的字符串，包括语言以及可选的脚本和区域。 | - 返回值： | 类型 | 说明 | | -------- | -------- | | [IndexUtil](#indexutil8) | locale对应的IndexUtil对象。 | - 示例： ``` var indexUtil= i18n.IndexUtil.getInstance("zh-CN"); ``` ## IndexUtil8+ ### getIndexList8+ getIndexList(): Array<string> 获取当前locale对应的索引列表。 **系统能力**：SystemCapability.Global.I18n - 返回值： | 类型 | 说明 | | -------- | -------- | | Array<string> | 返回当前locale对应的索引列表。 | - 示例： ``` var indexUtil = i18n.getInstance("zh-CN"); var indexList = indexUtil.getIndexList(); ``` ### addLocale8+ addLocale(locale: string) 将新的locale对应的索引加入当前索引列表。 **系统能力**：SystemCapability.Global.I18n - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | locale | string | 是 | 包含区域设置信息的字符串，包括语言以及可选的脚本和区域。 | - 示例： ``` var indexUtil = i18n.getInstance("zh-CN"); indexUtil.addLocale("en-US"); ``` ### getIndex8+ getIndex(text: string): string 获取text对应的索引。 **系统能力**：SystemCapability.Global.I18n - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | text | string | 是 | 待计算索引值的输入文本。 | - 返回值： | 类型 | 说明 | | -------- | -------- | | string | 输入文本对应的索引值。 | - 示例： ``` var indexUtil= i18n.getInstance("zh-CN"); indexUtil.getIndex("hi"); // 返回h ``` ## Character8+ ### isDigit8+ isDigit(char: string): boolean 判断字符串char是否是数字。 **系统能力**：SystemCapability.Global.I18n - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | char | string | 是 | 输入字符。 | - 返回值： | 类型 | 说明 | | -------- | -------- | | boolean | 返回true表示输入的字符是数字，返回false表示输入的字符不是数字。 | - 示例： ``` var isdigit = Character.isDigit("1"); // 返回true ``` ### isSpaceChar8+ isSpaceChar(char: string): boolean 判断字符串char是否是空格符。 **系统能力**：SystemCapability.Global.I18n - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | char | string | 是 | 输入字符。 | - 返回值： | 类型 | 说明 | | -------- | -------- | | boolean | 返回true表示输入的字符是空格符，返回false表示输入的字符不是空格符。 | - 示例： ``` var isspacechar = Character.isSpaceChar("a"); // 返回false ``` ### isWhitespace8+ isWhitespace(char: string): boolean 判断字符串char是否是空白符。 **系统能力**：SystemCapability.Global.I18n - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | char | string | 是 | 输入字符。 | - 返回值： | 类型 | 说明 | | -------- | -------- | | boolean | 返回true表示输入的字符是空白符，返回false表示输入的字符不是空白符。 | - 示例： ``` var iswhitespace = Character.isWhitespace("a"); // 返回false ``` ### isRTL8+ isRTL(char: string): boolean 判断字符串char是否是从右到左语言的字符。 **系统能力**：SystemCapability.Global.I18n - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | char | string | 是 | 输入字符。 | - 返回值： | 类型 | 说明 | | -------- | -------- | | boolean | 返回true表示输入的字符是从右到左语言的字符，返回false表示输入的字符不是从右到左语言的字符。 | - 示例： ``` var isrtl = Character.isRTL("a"); // 返回false ``` ### isIdeograph8+ isIdeograph(char: string): boolean 判断字符串char是否是表意文字。 **系统能力**：SystemCapability.Global.I18n - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | char | string | 是 | 输入字符。 | - 返回值： | 类型 | 说明 | | -------- | -------- | | boolean | 返回true表示输入的字符是表意文字，返回false表示输入的字符不是表意文字。 | - 示例： ``` var isideograph = Character.isIdeograph("a"); // 返回false ``` ### isLetter8+ isLetter(char: string): boolean 判断字符串char是否是字母。 **系统能力**：SystemCapability.Global.I18n - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | char | string | 是 | 输入字符。 | - 返回值： | 类型 | 说明 | | -------- | -------- | | boolean | 返回true表示输入的字符是字母，返回false表示输入的字符不是字母。 | - 示例： ``` var isletter = Character.isLetter("a"); // 返回true ``` ### isLowerCase8+ isLowerCase(char: string): boolean 判断字符串char是否是小写字母。 **系统能力**：SystemCapability.Global.I18n - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | char | string | 是 | 输入字符。 | - 返回值： | 类型 | 说明 | | -------- | -------- | | boolean | 返回true表示输入的字符是小写字母，返回false表示输入的字符不是小写字母。 | - 示例： ``` var islowercase = Character.isLowerCase("a"); // 返回true ``` ### isUpperCase8+ isUpperCase(char: string): boolean 判断字符串char是否是大写字母。 **系统能力**：SystemCapability.Global.I18n - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | char | string | 是 | 输入字符。 | - 返回值： | 类型 | 说明 | | -------- | -------- | | boolean | 返回true表示输入的字符是大写字母，返回false表示输入的字符不是大写字母。 | - 示例： ``` var isuppercase = Character.isUpperCase("a"); // 返回false ``` ### getType8+ getType(char: string): string 获取输入字符串的一般类别值。 **系统能力**：SystemCapability.Global.I18n - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | char | string | 是 | 输入字符。 | - 返回值： | 类型 | 说明 | | -------- | -------- | | string | 输入字符的一般类别值。 | - 示例： ``` var type = Character.getType("a"); ``` ## i18n.getLineInstance8+ getLineInstance(locale: string): BreakIterator 获取一个用于断句的[BreakIterator](#breakiterator8)对象。 **系统能力**：SystemCapability.Global.I18n - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | locale | string | 是 | 合法的locale值，例如zh-Hans-CN。生成的[BreakIterator](#breakiterator8)将按照locale所指定的区域的规则来进行断句。 | - 返回值： | 类型 | 说明 | | -------- | -------- | | [BreakIterator](#breakiterator8) | 用于进行断句的处理器。 | - 示例： ``` i18n.getLineInstance("en"); ``` ## BreakIterator8+ ### setLineBreakText8+ setLineBreakText(text: string): void 设置[BreakIterator](#breakiterator8)要处理的文本。 **系统能力**：SystemCapability.Global.I18n - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | text | string | 是 | 指定BreakIterator进行断句的文本。 | - 示例： ``` iterator = I18n.getLineInstance("en"); iterator.setLineBreakText("Apple is my favorite fruit."); ``` ### getLineBreakText8+ getLineBreakText(): string 获取[BreakIterator](#breakiterator8)当前处理的文本。 **系统能力**：SystemCapability.Global.I18n - 返回值： | 类型 | 说明 | | -------- | -------- | | string | BreakIterator对象正在处理的文本 | - 示例： ``` iterator = I18n.getLineInstance("en"); iterator.setLineBreakText("Apple is my favorite fruit."); iterator.getLineBreakText(); // Apple is my favorite fruit. ``` ### current8+ current(): number 获取[BreakIterator](#breakiterator8)对象在当前处理的文本中的位置。 **系统能力**：SystemCapability.Global.I18n - 返回值： | 类型 | 说明 | | -------- | -------- | | number | BreakIterator在当前所处理的文本中的位置。 | - 示例： ``` iterator = I18n.getLineInstance("en"); iterator.setLineBreakText("Apple is my favorite fruit."); breakIter.current(); // 0 ``` ### first8+ first(): number 将[BreakIterator](#breakiterator8)对象设置到第一个可断句的分割点。第一个分割点总是被处理的文本的起始位置。 **系统能力**：SystemCapability.Global.I18n - 返回值： | 类型 | 说明 | | -------- | -------- | | number | 被处理文本的第一个分割点的偏移量。 | - 示例： ``` iterator = I18n.getLineInstance("en"); iterator.setLineBreakText("Apple is my favorite fruit."); breakIter.first(); // 0 ``` ### last8+ last(): number 将[BreakIterator](#breakiterator8)对象的位置设置到最后一个可断句的分割点。最后一个分割点总是被处理文本末尾的下一个位置。 **系统能力**：SystemCapability.Global.I18n - 返回值： | 类型 | 说明 | | -------- | -------- | | number | 被处理的文本的最后一个分割点的偏移量 | - 示例： ``` iterator = I18n.getLineInstance("en"); iterator.setLineBreakText("Apple is my favorite fruit."); iterator.last(); // 27 ``` ### next8+ next(index?: number): number 如果index给出，并且index是一个正数将[BreakIterator](#breakiterator8)向后移动number个可断句的分割点，如果n是一个负数，向前移动相应个分割点。若index没有给出，则相当于index = 1。 **系统能力**：SystemCapability.Global.I18n - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | index | number | 否 | [BreakIterator](#breakiterator8)将要移动的分割点数，正数代表向后移动，负数代表向前移动。若index没有给出，则按照index=1处理。 | - 返回值： | 类型 | 说明 | | -------- | -------- | | number | 返回移动了index个分割点后，当前[BreakIterator](#breakiterator8)在文本中的位置。若移动index个分割点后超出了所处理的文本的长度范围，返回-1。 | - 示例： ``` iterator = I18n.getLineInstance("en"); iterator.setLineBreakText("Apple is my favorite fruit."); iterator.first(); // 0 iterator.next(); // 6 iterator.next(10); // -1 ``` ### previous8+ previous(): number 将[BreakIterator](#breakiterator8)移动到前一个分割点处。 **系统能力**：SystemCapability.Global.I18n - 返回值： | 类型 | 说明 | | -------- | -------- | | number | 返回移动到前一个分割点后，当前[BreakIterator](#breakiterator8)在文本中的位置。若移动index个分割点后超出了所处理的文本的长度范围，返回-1。 | - 示例： ``` iterator = I18n.getLineInstance("en"); iterator.setLineBreakText("Apple is my favorite fruit."); iterator.first(); // 0 iterator.next(3); // 12 iterator.previous(); // 9 ``` ### following8+ following(offset: number): number 将[BreakIterator](#breakiterator8)设置到由offset指定的位置的后面一个分割点。返回移动后[BreakIterator](#breakiterator8)的位置。 **系统能力**：SystemCapability.Global.I18n - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | offset | number | 是 | 将[BreakIterator](#breakiterator8)对象的位置设置到由offset所指定的位置的下一个分割点。 | - 返回值： | 类型 | 说明 | | -------- | -------- | | number | 返回[BreakIterator](#breakiterator8)移动后的位置，如果由offset所指定的位置的下一个分割点超出了文本的范围则返回-1。 | - 示例： ``` iterator = I18n.getLineInstance("en"); iterator.setLineBreakText("Apple is my favorite fruit."); iterator.following(0); // 6 iterator.following(100); // -1 iterator.current(); // 27 ``` ### isBoundary8+ isBoundary(offset: number): boolean 如果offset所指定的文本位置是一个分割点，那么返回true，否则返回false。如果返回true, 将[BreakIterator](#breakiterator8)对象设置到offset所指定的位置, 否则相当于调用[following](#following8)(offset)。 **系统能力**：SystemCapability.Global.I18n - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | offset | number | 是 | 指定需要进行判断的位置 | - 返回值： | 类型 | 说明 | | -------- | -------- | | boolean | 如果是一个分割点返回true, 否则返回false。 | - 示例： ``` iterator = I18n.getLineInstance("en"); iterator.setLineBreakText("Apple is my favorite fruit."); iterator.isBoundary(0); // true; iterator.isBoundary(5); // false; ``` ## i18n.is24HourClock8+ is24HourClock(): boolean 判断系统时间是否为24小时制。 **系统能力**：SystemCapability.Global.I18n - 返回值： | 类型 | 说明 | | -------- | -------- | | boolean | 返回true，表示系统24小时开关开启；返回false，表示系统24小时开关关闭。 | - 示例： ``` var is24HourClock = i18n.is24HourClock(); ``` ## i18n.set24HourClock8+ set24HourClock(option: boolean): boolean 修改系统时间的24小时制设置。 **系统能力**：SystemCapability.Global.I18n - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | option | boolean | 是 | option为true，表示开启系统24小时制开关；返回false，表示关闭系统24小时开关。 | - 返回值： | 类型 | 说明 | | -------- | -------- | | boolean | 返回true，表示修改成功；返回false，表示修改失败。 | - 示例： ``` // 将系统时间设置为24小时制 var success = I18n.set24HourClock(true); ``` ## i18n.addPreferredLanguage8+ addPreferredLanguage(language: string, index?: number): boolean 在系统偏好语言列表中的指定位置添加偏好语言。 **系统能力**：SystemCapability.Global.I18n - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | language | string | 是 | 待添加的偏好语言。 | | index | number | 否 | 偏好语言的添加位置。 | - 返回值： | 类型 | 说明 | | -------- | -------- | | boolean | 返回true，表示添加成功；返回false，表示添加失败。 | - 示例： ``` // 将语言zh-CN添加到系统偏好语言列表中 var language = 'zh-CN'; var index = 0; var success = i18n.addPreferredLanguage(language, index); ``` ## i18n.removePreferredLanguage8+ removePreferredLanguage(index: number): boolean 删除系统偏好语言列表中指定位置的偏好语言。 **系统能力**：SystemCapability.Global.I18n - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | index | number | 是 | 待删除偏好语言在系统偏好语言列表中的位置。 | - 返回值： | 类型 | 说明 | | -------- | -------- | | boolean | 返回true，表示删除成功；返回false，表示删除失败。 | - 示例： ``` // 删除系统偏好语言列表中的第一个偏好语言 var index = 0; var success = i18n.removePreferredLanguage(index); ``` ## i18n.getPreferredLanguageList8+ getPreferredLanguageList(): Array 获取系统偏好语言列表。 **系统能力**：SystemCapability.Global.I18n - 返回值： | 类型 | 说明 | | -------- | -------- | | Array | 系统偏好语言列表。 | - 示例： ``` var preferredLanguageList = i18n.getPreferredLanguageList(); ``` ## i18n.getFirstPreferredLanguage8+ getFirstPreferredLanguage(): string 获取偏好语言列表中的第一个偏好语言。 **系统能力**：SystemCapability.Global.I18n - 返回值： | 类型 | 说明 | | -------- | -------- | | string | 偏好语言列表中的第一个语言。 | - 示例： ``` var firstPreferredLanguage = i18n.getFirstPreferredLanguage(); ```