Add more semiotic class types for TtsSpan. (2e3f2c67) · Commits · e / os / android_frameworks_base

api/current.txt

+53 −0

Original line number	Diff line number	Diff line
		@@ -30323,10 +30323,34 @@ package android.text.style {
		field public static final java.lang.String ANIMACY_INANIMATE = "android.inanimate";
		field public static final java.lang.String ARG_ANIMACY = "android.arg.animacy";
		field public static final java.lang.String ARG_CASE = "android.arg.case";
		field public static final java.lang.String ARG_COUNTRY_CODE = "android.arg.country_code";
		field public static final java.lang.String ARG_DAY = "android.arg.day";
		field public static final java.lang.String ARG_DENOMINATOR = "android.arg.denominator";
		field public static final java.lang.String ARG_DIGITS = "android.arg.digits";
		field public static final java.lang.String ARG_DOMAIN = "android.arg.domain";
		field public static final java.lang.String ARG_EXTENSION = "android.arg.extension";
		field public static final java.lang.String ARG_FRACTIONAL_PART = "android.arg.fractional_part";
		field public static final java.lang.String ARG_FRAGMENT_ID = "android.arg.fragment_id";
		field public static final java.lang.String ARG_GENDER = "android.arg.gender";
		field public static final java.lang.String ARG_HOURS = "android.arg.hours";
		field public static final java.lang.String ARG_INTEGER_PART = "android.arg.integer_part";
		field public static final java.lang.String ARG_MINUTES = "android.arg.minutes";
		field public static final java.lang.String ARG_MONTH = "android.arg.month";
		field public static final java.lang.String ARG_MULTIPLICITY = "android.arg.multiplicity";
		field public static final java.lang.String ARG_NUMBER = "android.arg.number";
		field public static final java.lang.String ARG_NUMBER_PART = "android.arg.number_part";
		field public static final java.lang.String ARG_NUMERATOR = "android.arg.numerator";
		field public static final java.lang.String ARG_PASSWORD = "android.arg.password";
		field public static final java.lang.String ARG_PATH = "android.arg.path";
		field public static final java.lang.String ARG_PORT = "android.arg.port";
		field public static final java.lang.String ARG_PROTOCOL = "android.arg.protocol";
		field public static final java.lang.String ARG_QUERY_STRING = "android.arg.query_string";
		field public static final java.lang.String ARG_TEXT = "android.arg.text";
		field public static final java.lang.String ARG_UNIT = "android.arg.unit";
		field public static final java.lang.String ARG_USERNAME = "android.arg.username";
		field public static final java.lang.String ARG_VERBATIM = "android.arg.verbatim";
		field public static final java.lang.String ARG_WEEKDAY = "android.arg.weekday";
		field public static final java.lang.String ARG_YEAR = "android.arg.year";
		field public static final java.lang.String CASE_ABLATIVE = "android.ablative";
		field public static final java.lang.String CASE_ACCUSATIVE = "android.accusative";
		field public static final java.lang.String CASE_DATIVE = "android.dative";
		@@ -30338,11 +30362,40 @@ package android.text.style {
		field public static final java.lang.String GENDER_FEMALE = "android.female";
		field public static final java.lang.String GENDER_MALE = "android.male";
		field public static final java.lang.String GENDER_NEUTRAL = "android.neutral";
		field public static final int MONTH_APRIL = 3; // 0x3
		field public static final int MONTH_AUGUST = 7; // 0x7
		field public static final int MONTH_DECEMBER = 11; // 0xb
		field public static final int MONTH_FEBRUARY = 1; // 0x1
		field public static final int MONTH_JANUARY = 0; // 0x0
		field public static final int MONTH_JULY = 6; // 0x6
		field public static final int MONTH_JUNE = 5; // 0x5
		field public static final int MONTH_MARCH = 2; // 0x2
		field public static final int MONTH_MAY = 4; // 0x4
		field public static final int MONTH_NOVEMBER = 10; // 0xa
		field public static final int MONTH_OCTOBER = 9; // 0x9
		field public static final int MONTH_SEPTEMBER = 8; // 0x8
		field public static final java.lang.String MULTIPLICITY_DUAL = "android.dual";
		field public static final java.lang.String MULTIPLICITY_PLURAL = "android.plural";
		field public static final java.lang.String MULTIPLICITY_SINGLE = "android.single";
		field public static final java.lang.String TYPE_CARDINAL = "android.type.cardinal";
		field public static final java.lang.String TYPE_DATE = "android.type.date";
		field public static final java.lang.String TYPE_DECIMAL = "android.type.decimal";
		field public static final java.lang.String TYPE_DIGITS = "android.type.digits";
		field public static final java.lang.String TYPE_ELECTRONIC = "android.type.electronic";
		field public static final java.lang.String TYPE_FRACTION = "android.type.fraction";
		field public static final java.lang.String TYPE_MEASURE = "android.type.measure";
		field public static final java.lang.String TYPE_ORDINAL = "android.type.ordinal";
		field public static final java.lang.String TYPE_TELEPHONE = "android.type.telephone";
		field public static final java.lang.String TYPE_TEXT = "android.type.text";
		field public static final java.lang.String TYPE_TIME = "android.type.time";
		field public static final java.lang.String TYPE_VERBATIM = "android.type.verbatim";
		field public static final int WEEKDAY_FRIDAY = 6; // 0x6
		field public static final int WEEKDAY_MONDAY = 2; // 0x2
		field public static final int WEEKDAY_SATURDAY = 7; // 0x7
		field public static final int WEEKDAY_SUNDAY = 1; // 0x1
		field public static final int WEEKDAY_THURSDAY = 5; // 0x5
		field public static final int WEEKDAY_TUESDAY = 3; // 0x3
		field public static final int WEEKDAY_WEDNESDAY = 4; // 0x4
		}

		public class TypefaceSpan extends android.text.style.MetricAffectingSpan implements android.text.ParcelableSpan {

core/java/android/text/style/TtsSpan.java

+333 −25

Original line number	Diff line number	Diff line
		@@ -22,7 +22,7 @@ import android.text.ParcelableSpan;
		import android.text.TextUtils;

		/**
		* A span that supplies addition meta-data intended for text-to-speech rendering
		* A span that supplies additional meta-data intended for text-to-speech rendering
		* of the associated text. If the text is being processed by a text-to-speech
		* engine, the engine may use the data in this span in addition to or instead of
		* its associated text.
		@@ -35,37 +35,132 @@ public class TtsSpan implements ParcelableSpan {
		* This span type can be used to add morphosyntactic features to the text it
		* spans over, or synthesize a something else than the spanned text. Use
		* the argument {@link #ARG_TEXT} to set a different text.
		* Accepts the arguments {@link TtsSpan#ARG_GENDER},
		* {@link TtsSpan#ARG_ANIMACY}, {@link TtsSpan#ARG_MULTIPLICITY} and
		* {@link TtsSpan#ARG_CASE}.
		* Accepts the arguments {@link #ARG_GENDER},
		* {@link #ARG_ANIMACY}, {@link #ARG_MULTIPLICITY} and
		* {@link #ARG_CASE}.
		*/
		public static final String TYPE_TEXT = "android.type.text";

		/**
		* The text associated with this span is a cardinal. Must include the
		* number to be synthesized with {@link #ARG_NUMBER}.
		* Also accepts the arguments {@link TtsSpan#ARG_GENDER},
		* {@link TtsSpan#ARG_ANIMACY}, {@link TtsSpan#ARG_MULTIPLICITY} and
		* {@link TtsSpan#ARG_CASE}.
		* Also accepts the arguments {@link #ARG_GENDER},
		* {@link #ARG_ANIMACY}, {@link #ARG_MULTIPLICITY} and
		* {@link #ARG_CASE}.
		*/
		public static final String TYPE_CARDINAL = "android.type.cardinal";

		/**
		* String supplying the text to be synthesized. The synthesizer is free
		* to decide how to interpret the text.
		* The text associated with this span is an ordinal. Must include the
		* number to be synthesized with {@link #ARG_NUMBER}.
		* Also accepts the arguments {@link #ARG_GENDER},
		* {@link #ARG_ANIMACY}, {@link #ARG_MULTIPLICITY} and
		* {@link #ARG_CASE}.
		*/
		public static final String ARG_TEXT = "android.arg.text";
		public static final String TYPE_ORDINAL = "android.type.ordinal";

		/**
		* Argument used to specify a whole number. The value can be a string of
		* digits of any size optionally prefixed with a - or +.
		* The text associated with this span is a decimal number. Must include the
		* number to be synthesized with {@link #ARG_INTEGER_PART} and
		* {@link #ARG_FRACTIONAL_PART}.
		* Also accepts the arguments {@link #ARG_GENDER},
		* {@link #ARG_ANIMACY}, {@link #ARG_MULTIPLICITY} and
		* {@link #ARG_CASE}.
		*/
		public static final String ARG_NUMBER = "android.arg.number";
		public static final String TYPE_DECIMAL = "android.type.decimal";

		/**
		* The text associated with this span is a fractional number. Must include
		* the number to be synthesized with {@link #ARG_NUMERATOR} and
		* {@link #ARG_DENOMINATOR}. {@link #ARG_INTEGER_PART} is optional
		* Also accepts the arguments {@link #ARG_GENDER},
		* {@link #ARG_ANIMACY}, {@link #ARG_MULTIPLICITY} and
		* {@link #ARG_CASE}.
		*/
		public static final String TYPE_FRACTION = "android.type.fraction";

		/**
		* The text associated with this span is a measure, consisting of a number
		* and a unit. The number can be a cardinal, decimal or a fraction. Set the
		* number with the same arguments as {@link #TYPE_CARDINAL},
		* {@link #TYPE_DECIMAL} or {@link #TYPE_FRACTION}. The unit can be
		* specified with {@link #ARG_UNIT}.
		* Also accepts the arguments {@link #ARG_GENDER},
		* {@link #ARG_ANIMACY}, {@link #ARG_MULTIPLICITY} and
		* {@link #ARG_CASE}.
		*/
		public static final String TYPE_MEASURE = "android.type.measure";

		/**
		* The text associated with this span is a time, consisting of a number of
		* hours and minutes, specified with {@link #ARG_HOURS} and
		* {@link #ARG_MINUTES}.
		* Also accepts the arguments {@link #ARG_GENDER},
		* {@link #ARG_ANIMACY}, {@link #ARG_MULTIPLICITY} and
		* {@link #ARG_CASE}.
		*/
		public static final String TYPE_TIME = "android.type.time";

		/**
		* The text associated with this span is a date. All arguments are optional,
		* but at least one has to be provided: {@link #ARG_WEEKDAY},
		* {@link #ARG_DAY}, {@link #ARG_MONTH} and {@link #ARG_YEAR}.
		* Also accepts the arguments {@link #ARG_GENDER},
		* {@link #ARG_ANIMACY}, {@link #ARG_MULTIPLICITY} and
		* {@link #ARG_CASE}.
		*/
		public static final String TYPE_DATE = "android.type.date";

		/**
		* The text associated with this span is a telephone number. The argument
		* {@link #ARG_NUMBER_PART} is required. {@link #ARG_COUNTRY_CODE} and
		* {@link #ARG_EXTENSION} are optional.
		* Also accepts the arguments {@link #ARG_GENDER},
		* {@link #ARG_ANIMACY}, {@link #ARG_MULTIPLICITY} and
		* {@link #ARG_CASE}.
		*/
		public static final String TYPE_TELEPHONE = "android.type.telephone";


		/**
		* The text associated with this span is a URI (can be used for URLs and
		* email addresses). The full schema for URLs, which email addresses can
		* effectively be seen as a subset of, is:
		* protocol://username:password@domain:port/path?query_string#fragment_id
		* Hence populating just username and domain will read as an email address.
		* All arguments are optional, but at least one has to be provided:
		* {@link #ARG_PROTOCOL}, {@link #ARG_USERNAME}, {@link #ARG_PASSWORD},
		* {@link #ARG_DOMAIN}, {@link #ARG_PORT}, {@link #ARG_PATH},
		* {@link #ARG_QUERY_STRING} and {@link #ARG_FRAGMENT_ID}.
		* Also accepts the arguments {@link #ARG_GENDER},
		* {@link #ARG_ANIMACY}, {@link #ARG_MULTIPLICITY} and
		* {@link #ARG_CASE}.
		*/
		public static final String TYPE_ELECTRONIC = "android.type.electronic";

		/**
		* The text associated with this span is a series of digits that have to be
		* read sequentially. {@link #ARG_DIGITS} is required.
		* Also accepts the arguments {@link #ARG_GENDER},
		* {@link #ARG_ANIMACY}, {@link #ARG_MULTIPLICITY} and
		* {@link #ARG_CASE}.
		*/
		public static final String TYPE_DIGITS = "android.type.digits";

		/**
		* The text associated with this span is a series of characters that have to
		* be read verbatim. The engine will attempt to ready out any character like
		* punctuation but excluding whitespace. {@link #ARG_VERBATIM} is required.
		* Also accepts the arguments {@link #ARG_GENDER},
		* {@link #ARG_ANIMACY}, {@link #ARG_MULTIPLICITY} and
		* {@link #ARG_CASE}.
		*/
		public static final String TYPE_VERBATIM = "android.type.verbatim";

		/**
		* String argument supplying gender information. Can be any of
		* {@link TtsSpan#GENDER_NEUTRAL}, {@link TtsSpan#GENDER_MALE} and
		* {@link TtsSpan#GENDER_FEMALE}.
		* {@link #GENDER_NEUTRAL}, {@link #GENDER_MALE} and
		* {@link #GENDER_FEMALE}.
		*/
		public static final String ARG_GENDER = "android.arg.gender";

		@@ -75,8 +170,8 @@ public class TtsSpan implements ParcelableSpan {

		/**
		* String argument supplying animacy information. Can be
		* {@link TtsSpan#ANIMACY_ANIMATE} or
		* {@link TtsSpan#ANIMACY_INANIMATE}
		* {@link #ANIMACY_ANIMATE} or
		* {@link #ANIMACY_INANIMATE}
		*/
		public static final String ARG_ANIMACY = "android.arg.animacy";

		@@ -85,9 +180,9 @@ public class TtsSpan implements ParcelableSpan {

		/**
		* String argument supplying multiplicity information. Can be any of
		* {@link TtsSpan#MULTIPLICITY_SINGLE},
		* {@link TtsSpan#MULTIPLICITY_DUAL} and
		* {@link TtsSpan#MULTIPLICITY_PLURAL}
		* {@link #MULTIPLICITY_SINGLE},
		* {@link #MULTIPLICITY_DUAL} and
		* {@link #MULTIPLICITY_PLURAL}
		*/
		public static final String ARG_MULTIPLICITY = "android.arg.multiplicity";

		@@ -97,11 +192,11 @@ public class TtsSpan implements ParcelableSpan {

		/**
		* String argument supplying case information. Can be any of
		* {@link TtsSpan#CASE_NOMINATIVE}, {@link TtsSpan#CASE_ACCUSATIVE},
		* {@link TtsSpan#CASE_DATIVE}, {@link TtsSpan#CASE_ABLATIVE},
		* {@link TtsSpan#CASE_GENITIVE}, {@link TtsSpan#CASE_VOCATIVE},
		* {@link TtsSpan#CASE_LOCATIVE} and
		* {@link TtsSpan#CASE_INSTRUMENTAL}
		* {@link #CASE_NOMINATIVE}, {@link #CASE_ACCUSATIVE},
		* {@link #CASE_DATIVE}, {@link #CASE_ABLATIVE},
		* {@link #CASE_GENITIVE}, {@link #CASE_VOCATIVE},
		* {@link #CASE_LOCATIVE} and
		* {@link #CASE_INSTRUMENTAL}
		*/
		public static final String ARG_CASE = "android.arg.case";

		@@ -114,6 +209,219 @@ public class TtsSpan implements ParcelableSpan {
		public static final String CASE_LOCATIVE = "android.locative";
		public static final String CASE_INSTRUMENTAL = "android.instrumental";

		/**
		* String supplying the text to be synthesized. The synthesizer is free
		* to decide how to interpret the text.
		* Can be used with {@link #TYPE_TEXT}.
		*/
		public static final String ARG_TEXT = "android.arg.text";

		/**
		* Argument used to specify a whole number. The value can be a string of
		* digits of any size optionally prefixed with a - or +.
		* Can be used with {@link #TYPE_CARDINAL} and {@link #TYPE_ORDINAL}.
		*/
		public static final String ARG_NUMBER = "android.arg.number";

		/**
		* Argument used to specify the integer part of a decimal or fraction. The
		* value can be a string of digits of any size optionally prefixed with a - or +.
		* Can be used with {@link #TYPE_DECIMAL} and {@link #TYPE_FRACTION}.
		*/
		public static final String ARG_INTEGER_PART = "android.arg.integer_part";

		/**
		* Argument used to specify the fractional part of a decimal. The value can
		* be a string of digits of any size.
		* Can be used with {@link #TYPE_DECIMAL}.
		*/
		public static final String ARG_FRACTIONAL_PART =
		"android.arg.fractional_part";

		/**
		* Argument used to specify the numerator of a fraction. The value can be a
		* string of digits of any size optionally prefixed with a - or +.
		* Can be used with {@link #TYPE_FRACTION}.
		*/
		public static final String ARG_NUMERATOR = "android.arg.numerator";

		/**
		* Argument used to specify the denominator of a fraction. The value can be
		* a string of digits of any size optionally prefixed with a + or -.
		* Can be used with {@link #TYPE_FRACTION}.
		*/
		public static final String ARG_DENOMINATOR = "android.arg.denominator";

		/**
		* Argument used to specify the unit of a measure. The unit should always be
		* specified in English singular form. Prefixes may be used. Engines will do
		* their best to pronounce them correctly in the language used. Engines are
		* expected to at least support the most common ones like 'meter', 'second',
		* 'degree celcius' and 'degree fahrenheit' with some common prefixes like
		* 'milli' and 'kilo'.
		* Can be used with {@link #TYPE_MEASURE}.
		*/
		public static final String ARG_UNIT = "android.arg.unit";

		/**
		* Argument used to specify the hours of a time. The hours should be
		* provided as an integer in the range from 0 up to and including 24.
		* Can be used with {@link #TYPE_TIME}.
		*/
		public static final String ARG_HOURS = "android.arg.hours";

		/**
		* Argument used to specify the minutes of a time. The hours should be
		* provided as an integer in the range from 0 up to and including 59.
		* Can be used with {@link #TYPE_TIME}.
		*/
		public static final String ARG_MINUTES = "android.arg.minutes";

		/**
		* Argument used to specify the weekday of a date. The value should be
		* provided as an integer and can be any of {@link #WEEKDAY_SUNDAY},
		* {@link #WEEKDAY_MONDAY}, {@link #WEEKDAY_TUESDAY},
		* {@link #WEEKDAY_WEDNESDAY}, {@link #WEEKDAY_THURSDAY},
		* {@link #WEEKDAY_FRIDAY} and {@link #WEEKDAY_SATURDAY}.
		* Can be used with {@link #TYPE_DATE}.
		*/
		public static final String ARG_WEEKDAY = "android.arg.weekday";

		public static final int WEEKDAY_SUNDAY = 1;
		public static final int WEEKDAY_MONDAY = 2;
		public static final int WEEKDAY_TUESDAY = 3;
		public static final int WEEKDAY_WEDNESDAY = 4;
		public static final int WEEKDAY_THURSDAY = 5;
		public static final int WEEKDAY_FRIDAY = 6;
		public static final int WEEKDAY_SATURDAY = 7;

		/**
		* Argument used to specify the day of the month of a date. The value should
		* be provided as an integer in the range from 1 up to and including 31.
		* Can be used with {@link #TYPE_DATE}.
		*/
		public static final String ARG_DAY = "android.arg.day";

		/**
		* Argument used to specify the month of a date. The value should be
		* provided as an integer and can be any of {@link #MONTH_JANUARY},
		* {@link #MONTH_FEBRUARY}, {@link #MONTH_MARCH}, {@link #MONTH_APRIL}, {@link #MONTH_MAY},
		* {@link #MONTH_JUNE}, {@link #MONTH_JULY}, {@link #MONTH_AUGUST}, {@link #MONTH_SEPTEMBER},
		* {@link #MONTH_OCTOBER}, {@link #MONTH_NOVEMBER} and {@link #MONTH_DECEMBER}.
		* Can be used with {@link #TYPE_DATE}.
		*/
		public static final String ARG_MONTH = "android.arg.month";

		public static final int MONTH_JANUARY = 0;
		public static final int MONTH_FEBRUARY = 1;
		public static final int MONTH_MARCH = 2;
		public static final int MONTH_APRIL = 3;
		public static final int MONTH_MAY = 4;
		public static final int MONTH_JUNE = 5;
		public static final int MONTH_JULY = 6;
		public static final int MONTH_AUGUST = 7;
		public static final int MONTH_SEPTEMBER = 8;
		public static final int MONTH_OCTOBER = 9;
		public static final int MONTH_NOVEMBER = 10;
		public static final int MONTH_DECEMBER = 11;

		/**
		* Argument used to specify the year of a date. The value should be provided
		* as a positive integer.
		* Can be used with {@link #TYPE_DATE}.
		*/
		public static final String ARG_YEAR = "android.arg.year";

		/**
		* Argument used to specify the country code of a telephone number. Can be
		* a string of digits.
		* Can be used with {@link #TYPE_TELEPHONE}.
		*/
		public static final String ARG_COUNTRY_CODE = "android.arg.country_code";

		/**
		* Argument used to specify the main number part of a telephone number. Can
		* be a string of digits.
		* Can be used with {@link #TYPE_TELEPHONE}.
		*/
		public static final String ARG_NUMBER_PART = "android.arg.number_part";

		/**
		* Argument used to specify the extension part of a telephone number. Can be
		* a string of digits.
		* Can be used with {@link #TYPE_TELEPHONE}.
		*/
		public static final String ARG_EXTENSION = "android.arg.extension";

		/**
		* Argument used to specify the protocol of a URI. Examples are 'http' and
		* 'ftp'.
		* Can be used with {@link #TYPE_ELECTRONIC}.
		*/
		public static final String ARG_PROTOCOL = "android.arg.protocol";

		/**
		* Argument used to specify the username part of a URI. Should be set as a
		* string.
		* Can be used with {@link #TYPE_ELECTRONIC}.
		*/
		public static final String ARG_USERNAME = "android.arg.username";

		/**
		* Argument used to specify the password part of a URI. Should be set as a
		* string.
		* Can be used with {@link #TYPE_ELECTRONIC}.
		*/
		public static final String ARG_PASSWORD = "android.arg.password";

		/**
		* Argument used to specify the domain part of a URI. For example are
		* 'source.android.com'.
		* Can be used with {@link #TYPE_ELECTRONIC}.
		*/
		public static final String ARG_DOMAIN = "android.arg.domain";

		/**
		* Argument used to specify the port number of a URI. Should be specified as
		* an integer.
		* Can be used with {@link #TYPE_ELECTRONIC}.
		*/
		public static final String ARG_PORT = "android.arg.port";

		/**
		* Argument used to specify the path part of a URI. For example
		* 'source/index.html'.
		* Can be used with {@link #TYPE_ELECTRONIC}.
		*/
		public static final String ARG_PATH = "android.arg.path";

		/**
		* Argument used to specify the query string of a URI. For example
		* 'arg=value&argtwo=value'.
		* Can be used with {@link #TYPE_ELECTRONIC}.
		*/
		public static final String ARG_QUERY_STRING = "android.arg.query_string";

		/**
		* Argument used to specify the fragment id of a URI. Should be specified as
		* a string.
		* Can be used with {@link #TYPE_ELECTRONIC}.
		*/
		public static final String ARG_FRAGMENT_ID = "android.arg.fragment_id";

		/**
		* Argument used to specify a string of digits.
		* Can be used with {@link #TYPE_DIGITS}.
		*/
		public static final String ARG_DIGITS = "android.arg.digits";

		/**
		* Argument used to specify a string where the characters are read verbatim,
		* except whitespace.
		* Can be used with {@link #TYPE_VERBATIM}.
		*/
		public static final String ARG_VERBATIM = "android.arg.verbatim";

		public TtsSpan(String type, PersistableBundle args) {
		mType = type;
		mArgs = args;