Resource string menyediakan string teks bagi aplikasi Anda dengan pemformatan dan penataan gaya teks opsional. Ada tiga tipe resource yang bisa menyediakan string untuk aplikasi Anda:
- String
- Sumber daya XML yang menyediakan string tunggal.
- Larik String
- Sumber daya XML yang menyediakan larik string.
- String Kuantitas (Jamak)
- Sumber daya XML yang membawa string berbeda untuk pluralisasi
Semua string mampu menerapkan beberapa argumen markup penataan gaya dan pemformatan. Untuk informasi tentang string penataan gaya dan pemformatan, lihat bagian tentang Pemformatan dan Penataan Gaya.
String
String tunggal yang bisa direferensikan dari aplikasi atau file resource lain (misalnya layout XML).
Catatan: String adalah resource sederhana yang direferensikan menggunakan nilai yang disediakan dalam atribut name (bukan nama file XML). Jadi, Anda bisa mengombinasikan resource string dengan resource sederhana lainnya dalam satu file XML, menggunakan satu elemen <resources>.
- lokasi file:
res/values/filename.xml
Nama file bebas.nameelemen<string>digunakan sebagai ID resource.- jenis data sumber daya yang dikompilasi:
- Pointer sumber daya ke
String. - referensi sumber daya:
-
Dalam Java:
R.string.string_name
Dalam XML:@string/string_name - sintaks:
-
<?xml version="1.0" encoding="utf-8"?> <resources> <string name="string_name" >text_string</string> </resources>
- elemen:
- contoh:
- File XML yang disimpan di
res/values/strings.xml:<?xml version="1.0" encoding="utf-8"?> <resources> <string name="hello">Hello!</string> </resources>XML layout ini menerapkan string ke View:
<TextView android:layout_width="fill_parent" android:layout_height="wrap_content" android:text="@string/hello" />Kode aplikasi ini mengambil sebuah string:
Anda bisa menggunakan
getString(int)ataugetText(int)untuk mengambil string.getText(int)akan mempertahankan penataan gaya teks yang kaya ke string.
Larik string
Larik string yang bisa direferensikan dari aplikasi.
Catatan: Larik string adalah sumber daya sederhana yang direferensikan menggunakan nilai yang disediakan dalam atribut name (bukan nama file XML). Dengan demikian, Anda bisa mengombinasikan sumber daya larik string dengan sumber daya sederhana lainnya dalam satu file XML, pada satu elemen <resources>.
- lokasi file:
res/values/filename.xml
Nama file bebas.nameelemen<string-array>digunakan sebagai ID sumber daya.- jenis data sumber daya yang dikompilasi:
- Pointer sumber daya ke larik
String. - referensi sumber daya:
-
Dalam Java:
R.array.string_array_name - sintaks:
-
<?xml version="1.0" encoding="utf-8"?> <resources> <string-array name="string_array_name"> <item >text_string</item> </string-array> </resources>
- elemen:
- contoh berikut:
- File XML yang disimpan di
res/values/strings.xml:<?xml version="1.0" encoding="utf-8"?> <resources> <string-array name="planets_array"> <item>Mercury</item> <item>Venus</item> <item>Earth</item> <item>Mars</item> </string-array> </resources>Kode aplikasi ini mengambil sebuah larik string:
Kotlin
val array: Array
= resources.getStringArray(R.array.planets_array)Java
Resources res =
getResources(); String[] planets = res.getStringArray(R.array.planets_array);
String kuantitas (jamak)
Bahasa yang berbeda memiliki aturan yang berbeda pula untuk kesepakatan gramatikal pada kuantitas. Dalam bahasa Inggris, misalnya, kuantitas 1 adalah kasus khusus. Kita menulis "1 buku", namun untuk kuantitas lain kita akan menulis "n buku". Perbedaan antara tunggal dan jamak sudah sangat umum, namun bahasa lain membuat perbedaan yang lebih tipis. Set lengkap yang didukung Android adalah zero, one, two, few, many, dan other.
Aturan untuk memutuskan kasus mana yang akan digunakan untuk bahasa dan kuantitas yang diberikan boleh jadi akan sangat kompleks, jadi Android menyediakan beberapa metode seperti getQuantityString() untuk memilih sumber daya yang sesuai untuk Anda.
Walaupun secara historis disebut "string kuantitas" (dan tetap disebut demikian di API), string kuantitas hanya boleh digunakan untuk jamak. Akan salah jika menggunakan string kuantitas untuk mengimplementasikan sesuatu seperti "Inbox" versus "Inbox (12)" Gmail jika ada pesan belum dibaca, misalnya. Sepertinya mungkin praktis menggunakan string kuantitas sebagai ganti pernyataan if, namun perlu diperhatikan bahwa beberapa bahasa (seperti bahasa Cina) tidak membuat perbedaan gramatikal ini sama sekali, jadi Anda akan selalu mendapatkan string other.
Pemilihan string yang akan digunakan dilakukan semata-mata berdasarkan keperluan gramatikal. Dalam bahasa Inggris, string untuk zero akan diabaikan sekalipun kuantitasnya 0, karena 0 secara gramatikal tidak berbeda dengan 2, atau angka lain selain 1 ("zero books", "one book","two books", dan seterusnya). Sebaliknya, dalam bahasa Korea hanya string other yang pernah digunakan.
Jangan salah paham oleh fakta bahwa, misalnya, two seolah hanya bisa diterapkan pada kuantitas 2: suatu bahasa mungkin mengharuskan 2, 12, 102 (dan seterusnya) semua diperlakukan seperti satu sama lainnya namun secara berbeda untuk kuantitas lainnya. Percayakan pada penerjemah Anda untuk mengetahui perbedaan sesungguhnya dalam bahasa masing-masing.
Sering kali dimungkinkan untuk menghindari string kuantitas dengan menggunakan formulasi yang netral-kuantitas, misalnya "Books: 1". Ini membuat urusan Anda dan penerjemah Anda jadi lebih mudah, bila ini adalah gaya yang bisa diterima untuk aplikasi Anda.
Catatan: Kumpulan jamak adalah sumber daya sederhana yang direferensikan menggunakan nilai yang disediakan dalam atribut name (bukan nama file XML). Dengan demikian, Anda bisa mengombinasikan sumber daya jamak dengan sumber daya sederhana lainnya dalam satu file XML, pada satu elemen <resources>.
- lokasi file:
res/values/filename.xml
Nama file bebas.nameelemen<plurals>digunakan sebagai ID resource.- referensi sumber daya:
-
Dalam Java:
R.plurals.plural_name - sintaks:
-
<?xml version="1.0" encoding="utf-8"?> <resources> <plurals name="plural_name"> <item quantity=["zero" | "one" | "two" | "few" | "many" | "other"] >text_string</item> </plurals> </resources>
- elemen:
- contoh:
- File XML yang disimpan di
res/values/strings.xml:<?xml version="1.0" encoding="utf-8"?> <resources> <plurals name="numberOfSongsAvailable"> <!-- As a developer, you should always supply "one" and "other" strings. Your translators will know which strings are actually needed for their language. Always include %d in "one" because translators will need to use %d for languages where "one" doesn't mean 1 (as explained above). --> <item quantity="one">%d song found.</item> <item quantity="other">%d songs found.</item> </plurals> </resources>File XML disimpan di
res/values-pl/strings.xml:<?xml version="1.0" encoding="utf-8"?> <resources> <plurals name="numberOfSongsAvailable"> <item quantity="one">Znaleziono %d piosenkę.</item> <item quantity="few">Znaleziono %d piosenki.</item> <item quantity="other">Znaleziono %d piosenek.</item> </plurals> </resources>Penggunaan:
Kotlin
val count = getNumberOfSongsAvailable() val songsFound = resources.
getQuantityString(R.plurals.numberOfSongsAvailable, count, count)Java
int count = getNumberOfSongsAvailable(); Resources res =
getResources(); String songsFound = res.getQuantityString(R.plurals.numberOfSongsAvailable, count, count);Saat menggunakan metode
getQuantityString(), Anda perlu meneruskancountdua kali jika string berisi pemformatan string dengan angka. Misalnya, untuk string%d songs found, parametercountpertama akan memilih string jamak yang sesuai dan parametercountkedua akan dimasukkan ke dalam placeholder%d. Jika string jamak Anda tidak berisi pemformatan string, Anda tidak perlu meneruskan parameter ketiga kegetQuantityString.
Format dan gaya
Inilah beberapa hal penting yang harus Anda ketahui tentang cara yang benar untuk memformat dan menata gaya resource string.
Menangani karakter khusus
Bila string berisi karakter yang memiliki penggunaan khusus dalam XML atau Android, Anda harus mengurung karakter. Beberapa karakter bisa dikurung dengan menggunakan garis miring terbalik sebelumnya, sementara yang lain mengharuskan XML mengurung. Apostrof dan tanda petik tunggal juga bisa ditangani dengan mengurung seluruh string dalam tanda kutip ganda. Beberapa contoh ditampilkan di bawah ini:
| Karakter | Bentuk yang dikurung |
|---|---|
| @ | \@ |
| ? | \? |
| < | < |
| & | & |
Tanda kutip tunggal (') |
Salah satu dari berikut:
|
Tanda kutip ganda (") |
Salah satu dari berikut:
Perhatikan bahwa Anda harus melepaskan tanda kutip ganda. Mengurung string dengan tanda kutip tunggal tidak akan berhasil. |
Memformat string
Jika Anda perlu memformat string, Anda bisa melakukannya dengan menempatkan argumen format dalam resource string, seperti yang didemonstrasikan oleh resource contoh berikut.
<string name="welcome_messages">Hello, %1$s! You have %2$d new messages.</string>
Dalam contoh ini, string format memiliki dua argumen: %1$s adalah string dan %2$d adalah bilangan desimal. Selanjutnya, format string dengan memanggil getString(int, Object...). Sebagai contoh:
Kotlin
var text = getString(R.string.welcome_messages, username, mailCount)
Java
String text = getString(R.string.welcome_messages, username, mailCount);
Menata gaya dengan markup HTML
Anda bisa menambahkan penataan gaya ke string dengan markup HTML. Sebagai contoh:
<?xml version="1.0" encoding="utf-8"?>
<resources>
<string name="welcome">Welcome to <b>Android</b>!</string>
</resources>
Elemen HTML berikut didukung:
- Bold: <b>, <em>
- Italic: <i>, <cite>, <dfn>
- 25% teks lebih besar: <big>
- 20% teks lebih kecil: <small>
- Setting font properties: <font face=”font_family“ color=”hex_color”>. Contoh kelompok font yang memungkinkan menyertakan
monospace,serif, dansans_serif. - Menyetel kelompok font spasi tunggal: <tt>
- Dicoret: <s>, <strike>, <del>
- Garis bawah: <u>
- Superskrip: <sup>
- Subskrip: <sub>
- Poin utama: <ul>, <li>
- Jeda baris: <br>
- Divisi: <div>
- Gaya CSS: <span style=”color|background_color|text-decoration”>
- Paragraf: <p dir=”rtl | ltr” style=”…”>
Bila tidak menerapkan pemformatan, Anda bisa menyetel teks TextView secara langsung dengan memanggil setText(java.lang.CharSequence). Akan tetapi, kadang-kadang Anda mungkin ingin membuat resource teks bergaya yang juga digunakan sebagai string format. Biasanya, ini tidak akan verhasil karena metode format(String, Object...) dan getString(int, Object...) akan melucuti semua informasi gaya dari string. Solusinya adalah menuliskan tag HTML dengan entitas yang dikurung, yang nanti dipulihkan dengan fromHtml(String), setelah pemformatan dilakukan. Sebagai contoh:
- Simpan sumber daya teks bergaya sebagai string yang dikurung dengan HTML:
<resources> <string name="welcome_messages">Hello, %1$s! You have <b>%2$d new messages</b>.</string> </resources>
Dalam string yang diformat ini, elemen
<b>telah ditambahkan. Perhatikan bahwa kurung buka adalah HTML yang dikurung, dengan menggunakan notasi<. - Kemudian format string tersebut seperti biasa, namun panggil juga
fromHtml(String)untuk mengonversi teks HTML menjadi teks yang diberi gaya:Kotlin
val text: String = getString(R.string.welcome_messages, username, mailCount) val styledText: Spanned = Html.fromHtml(text, FROM_HTML_MODE_LEGACY)
Java
String text = getString(R.string.welcome_messages, username, mailCount); Spanned styledText = Html.fromHtml(text, FROM_HTML_MODE_LEGACY);
Karena metode fromHtml(String) akan memformat semua entitas HTML, pastikan mengurung semua karakter HTML yang memungkinkan dalam string yang Anda gunakan bersama teks berformat, menggunakan htmlEncode(String). Misalnya, jika Anda akan memformat string yang berisi karakter seperti "<" atau "&", maka harus dikurung sebelum memformat, sehingga bila string berformat diteruskan melalui fromHtml(String), karakter akan luput dari maksud penulisannya semula. Sebagai contoh:
Kotlin
val escapedUsername: String = TextUtils.htmlEncode(username)
val text: String = getString(R.string.welcome_messages, escapedUsername, mailCount)
val styledText: Spanned = Html.fromHtml(text, FROM_HTML_MODE_LEGACY)
Java
String escapedUsername = TextUtils.htmlEncode(username);
String text = getString(R.string.welcome_messages, escapedUsername, mailCount);
Spanned styledText = Html.fromHtml(text);
Menata gaya dengan spannable
Spannable adalah objek teks yang bisa Anda beri gaya dengan properti typeface seperti warna dan bobot font. Anda menggunakan SpannableStringBuilder untuk membuat teks kemudian menerapkan gaya yang ditetapkan dalam paket android.text.style ke teks.
Anda bisa menggunakan metode helper berikut untuk menyiapkan sebagian besar pekerjaan membuat teks spannable:
Kotlin
/**
* Returns a CharSequence that concatenates the specified array of CharSequence
* objects and then applies a list of zero or more tags to the entire range.
*
* @param content an array of character sequences to apply a style to
* @param tags the styled span objects to apply to the content
* such as android.text.style.StyleSpan
*/
private fun apply(content: Array<out CharSequence>, vararg tags: Any): CharSequence {
return SpannableStringBuilder().apply {
openTags(tags)
content.forEach { charSequence ->
append(charSequence)
}
closeTags(tags)
}
}
/**
* Iterates over an array of tags and applies them to the beginning of the specified
* Spannable object so that future text appended to the text will have the styling
* applied to it. Do not call this method directly.
*/
private fun Spannable.openTags(tags: Array<out Any>) {
tags.forEach { tag ->
setSpan(tag, 0, 0, Spannable.SPAN_MARK_MARK)
}
}
/**
* "Closes" the specified tags on a Spannable by updating the spans to be
* endpoint-exclusive so that future text appended to the end will not take
* on the same styling. Do not call this method directly.
*/
private fun Spannable.closeTags(tags: Array<out Any>) {
tags.forEach { tag ->
if (length > 0) {
setSpan(tag, 0, length, Spanned.SPAN_EXCLUSIVE_EXCLUSIVE)
} else {
removeSpan(tag)
}
}
}
Java
/**
* Returns a CharSequence that concatenates the specified array of CharSequence
* objects and then applies a list of zero or more tags to the entire range.
*
* @param content an array of character sequences to apply a style to
* @param tags the styled span objects to apply to the content
* such as android.text.style.StyleSpan
*
*/
private static CharSequence applyStyles(CharSequence[] content, Object[] tags) {
SpannableStringBuilder text = new SpannableStringBuilder();
openTags(text, tags);
for (CharSequence item : content) {
text.append(item);
}
closeTags(text, tags);
return text;
}
/**
* Iterates over an array of tags and applies them to the beginning of the specified
* Spannable object so that future text appended to the text will have the styling
* applied to it. Do not call this method directly.
*/
private static void openTags(Spannable text, Object[] tags) {
for (Object tag : tags) {
text.setSpan(tag, 0, 0, Spannable.SPAN_MARK_MARK);
}
}
/**
* "Closes" the specified tags on a Spannable by updating the spans to be
* endpoint-exclusive so that future text appended to the end will not take
* on the same styling. Do not call this method directly.
*/
private static void closeTags(Spannable text, Object[] tags) {
int len = text.length();
for (Object tag : tags) {
if (len > 0) {
text.setSpan(tag, 0, len, Spanned.SPAN_EXCLUSIVE_EXCLUSIVE);
} else {
text.removeSpan(tag);
}
}
}
Metode bold, italic, dan color berikut membungkus metode helper di atas dan memperagakan contoh tertentu mengenai menerapkan gaya yang ditetapkan dalam paket android.text.style. Anda bisa membuat metode serupa untuk melakukan penataan gaya tipe teks lainnya.
Kotlin
/**
* Returns a CharSequence that applies boldface to the concatenation
* of the specified CharSequence objects.
*/
fun bold(vararg content: CharSequence): CharSequence = apply(content, StyleSpan(Typeface.BOLD))
/**
* Returns a CharSequence that applies italics to the concatenation
* of the specified CharSequence objects.
*/
fun italic(vararg content: CharSequence): CharSequence = apply(content, StyleSpan(Typeface.ITALIC))
/**
* Returns a CharSequence that applies a foreground color to the
* concatenation of the specified CharSequence objects.
*/
fun color(color: Int, vararg content: CharSequence): CharSequence =
apply(content, ForegroundColorSpan(color))
Java
/**
* Returns a CharSequence that applies boldface to the concatenation
* of the specified CharSequence objects.
*/
public static CharSequence bold(CharSequence... content) {
return apply(content, new StyleSpan(Typeface.BOLD));
}
/**
* Returns a CharSequence that applies italics to the concatenation
* of the specified CharSequence objects.
*/
public static CharSequence italic(CharSequence... content) {
return apply(content, new StyleSpan(Typeface.ITALIC));
}
/**
* Returns a CharSequence that applies a foreground color to the
* concatenation of the specified CharSequence objects.
*/
public static CharSequence color(int color, CharSequence... content) {
return apply(content, new ForegroundColorSpan(color));
}
Berikut ini contoh cara menghubungkan metode ini bersama-sama untuk menerapkan berbagai gaya ke masing-masing kata dalam frasa:
Kotlin
// Create an italic "hello, " a red "world",
// and bold the entire sequence.
val text: CharSequence = bold(italic(getString(R.string.hello)),
color(Color.RED, getString(R.string.world)))
Java
// Create an italic "hello, " a red "world",
// and bold the entire sequence.
var text = bold(italic(getString(R.string.hello)),
color(Color.RED, getString(R.string.world)))
</pre>
</section><section><h3 id="java">Java</h3>
<pre class="prettyprint lang-java">
// Create an italic "hello, " a red "world",
// and bold the entire sequence.
CharSequence text = bold(italic(getString(R.string.hello)),
color(Color.RED, getString(R.string.world)));
Modul Kotlin core-ktx juga berisi fungsi ekstensi yang membuat bekerja dengan durasi jadi lebih mudah. Anda bisa melihat dokumentasi paket android.text di GitHub untuk mengetahui selengkapnya.
Untuk informasi selengkapnya tentang bekerja dengan durasi, lihat link berikut:
Menata gaya dengan anotasi
Anda bisa menerapkan penataan gaya kompleks atau khusus dengan menggunakan kelas Annotation bersama dengan tag <annotation> dalam file resource strings.xml Anda. Tag anotasi memungkinkan Anda untuk menandai bagian string untuk penataan gaya khusus dengan menetapkan pasangan kunci-nilai khusus dalam XML yang kemudian dikonversi framework ke durasi Annotation. Anda bisa mengambil anotasi ini dan menggunakan kunci dan nilai untuk menerapkan penataan gaya.
Saat membuat anotasi, pastikan Anda menambahkan tag <annotation> ke semua penerjemahan string dalam setiap file strings.xml.
Menerapkan typeface khusus ke kata “text” dalam semua bahasa
Contoh - menambahkan typeface khusus
-
Tambahkan tag
<annotation>, dan key-value pair. Dalam hal ini, kunci adalah font, dan nilai adalah jenis font yang ingin kita gunakan: title_emphasis// values/strings.xml <string name="title">Best practices for <annotation font="title_emphasis">text</annotation> on Android</string> // values-es/strings.xml <string name="title"><annotation font="title_emphasis">Texto</annotation> en Android: mejores prácticas</string>
-
Muat resource string dan temukan anotasi dengan kunci font. Kemudian buat durasi khusus dan ganti durasi yang ada.
Kotlin
// get the text as SpannedString so we can get the spans attached to the text val titleText = getText(R.string.title) as SpannedString // get all the annotation spans from the text val annotations = titleText.getSpans(0, titleText.length, Annotation::class.java) // create a copy of the title text as a SpannableString. // the constructor copies both the text and the spans. so we can add and remove spans val spannableString = SpannableString(titleText) // iterate through all the annotation spans for (annotation in annotations) { // look for the span with the key font if (annotation.key == "font") { val fontName = annotation.value // check the value associated to the annotation key if (fontName == "title_emphasis") { // create the typeface val typeface = getFontCompat(R.font.permanent_marker) // set the span at the same indices as the annotation spannableString.setSpan(CustomTypefaceSpan(typeface), titleText.getSpanStart(annotation), titleText.getSpanEnd(annotation), Spannable.SPAN_EXCLUSIVE_EXCLUSIVE) } } } // now, the spannableString contains both the annotation spans and the CustomTypefaceSpan styledText.text = spannableStringJava
// get the text as SpannedString so we can get the spans attached to the text SpannedString titleText = (SpannedString) getText(R.string.title_about); // get all the annotation spans from the text Annotation[] annotations = titleText.getSpans(0, titleText.length(), Annotation.class); // create a copy of the title text as a SpannableString. // the constructor copies both the text and the spans. so we can add and remove spans SpannableString spannableString = new SpannableString(titleText); // iterate through all the annotation spans for (Annotation annotation: annotations) { // look for the span with the key font if (annotation.getKey().equals("font")) { String fontName = annotation.getValue(); // check the value associated to the annotation key if (fontName.equals("title_emphasis")) { // create the typeface Typeface typeface = ResourcesCompat.getFont(this, R.font.roboto_mono); // set the span at the same indices as the annotation spannableString.setSpan(new CustomTypefaceSpan(typeface), titleText.getSpanStart(annotation), titleText.getSpanEnd(annotation), Spannable.SPAN_EXCLUSIVE_EXCLUSIVE); } } } // now, the spannableString contains both the annotation spans and the CustomTypefaceSpan styledText.text = spannableString;
Jika Anda menggunakan teks yang sama beberapa kali, Anda harus membuat objek SpannableString sekali dan menggunakannya lagi saat diperlukan untuk menghindari potensi masalah kinerja dan memori.
Untuk contoh selengkapnya tentang penggunaan anotasi, lihat Menata gaya teks yang diinternasionalisasikan di Android
Durasi anotasi dan pembagian teks
Karena durasi Annotation juga ParcelableSpans, pasangan kunci-nilai dibagi dan tidak dibagi. Selama penerima parcel tahu cara menafsirkan anotasi, Anda bisa menggunakan durasi Annotation untuk menerapkan penataan gaya khusus ke teks yang dibagi.
Untuk menyimpan penataan gaya khusus saat Anda meneruskan teks ke Paket Intent, Anda terlebih dahulu perlu menambahkan durasi Annotation ke teks Anda. Jika Anda melakukan ini dalam resource XML melalui tag <annotation>, seperti yang ditampilkan di contoh sebelumnya, atau di kode dengan membuat Annotation baru dan menyetelnya sebagai durasi, seperti yang ditampilkan di bawah ini:
Kotlin
val spannableString = SpannableString("My spantastic text")
val annotation = Annotation("font", "title_emphasis")
spannableString.setSpan(annotation, 3, 7, Spannable.SPAN_EXCLUSIVE_EXCLUSIVE)
// start Activity with text with spans
val intent = Intent(this, MainActivity::class.java)
intent.putExtra(TEXT_EXTRA, spannableString)
startActivity(intent)
Java
SpannableString spannableString = new SpannableString("My spantastic text");
Annotation annotation = new Annotation("font", "title_emphasis");
spannableString.setSpan(annotation, 3, 7, 33);
// start Activity with text with spans
Intent intent = new Intent(this, MainActivity.class);
intent.putExtra(TEXT_EXTRA, spannableString);
this.startActivity(intent);
Ambil teks dari Bundle sebagai SpannableString kemudian uraikan anotasi yang dilampirkan, seperti yang ditampilkan di contoh sebelumnya.
Kotlin
// read text with Spans val intentCharSequence = intent.getCharSequenceExtra(TEXT_EXTRA) as SpannableString
Java
// read text with Spans SpannableString intentCharSequence = (SpannableString)intent.getCharSequenceExtra(TEXT_EXTRA);
Untuk informasi selengkapnya tentang penataan gaya teks, lihat link berikut: