แหล่งข้อมูลของเมนู

ทรัพยากรเมนูจะกำหนดเมนูแอปพลิเคชัน ซึ่งได้แก่ เมนูตัวเลือก เมนูตามบริบท หรือเมนูย่อยที่สามารถขยายได้ด้วย MenuInflater

ดูคำแนะนำในการใช้เมนูได้ที่หัวข้อเพิ่มเมนู

ตำแหน่งไฟล์:
res/menu/filename.xml
ระบบจะใช้ชื่อไฟล์เป็นรหัสทรัพยากร
ประเภทข้อมูลทรัพยากรที่คอมไพล์:
ตัวชี้ทรัพยากรไปยังทรัพยากร Menu (หรือคลาสย่อย)
ข้อมูลอ้างอิงทรัพยากร:
ใน Java: R.menu.filename
ใน XML: @[package:]menu.filename
ไวยากรณ์:
<?xml version="1.0" encoding="utf-8"?>
<menu xmlns:android="http://schemas.android.com/apk/res/android">
    <item android:id="@[+][package:]id/resource_name"
          android:title="string"
          android:titleCondensed="string"
          android:icon="@[package:]drawable/drawable_resource_name"
          android:onClick="method name"
          android:showAsAction=["ifRoom" | "never" | "withText" | "always" | "collapseActionView"]
          android:actionLayout="@[package:]layout/layout_resource_name"
          android:actionViewClass="class name"
          android:actionProviderClass="class name"
          android:alphabeticShortcut="string"
          android:alphabeticModifiers=["META" | "CTRL" | "ALT" | "SHIFT" | "SYM" | "FUNCTION"]
          android:numericShortcut="string"
          android:numericModifiers=["META" | "CTRL" | "ALT" | "SHIFT" | "SYM" | "FUNCTION"]
          android:checkable=["true" | "false"]
          android:visible=["true" | "false"]
          android:enabled=["true" | "false"]
          android:menuCategory=["container" | "system" | "secondary" | "alternative"]
          android:orderInCategory="integer" />
    <group android:id="@[+][package:]id/resource name"
           android:checkableBehavior=["none" | "all" | "single"]
           android:visible=["true" | "false"]
           android:enabled=["true" | "false"]
           android:menuCategory=["container" | "system" | "secondary" | "alternative"]
           android:orderInCategory="integer" >
        <item />
    </group>
    <item >
        <menu>
          <item />
        </menu>
    </item>
</menu>
องค์ประกอบ
ต้องระบุ ซึ่งต้องเป็นโหนดรูท มีองค์ประกอบ <item> และ/หรือ <group>

แอตทริบิวต์:

xmlns:android
เนมสเปซ XML ต้องระบุ กำหนดเนมสเปซ XML ซึ่งต้องเป็น "http://schemas.android.com/apk/res/android"
<item>
รายการในเมนู อาจมีองค์ประกอบ <menu> (สำหรับเมนูย่อย) ต้องเป็นองค์ประกอบย่อยขององค์ประกอบ <menu> หรือ <group>

แอตทริบิวต์:

android:id
รหัสทรัพยากร รหัสทรัพยากรที่ไม่ซ้ำกัน หากต้องการสร้างรหัสทรัพยากรใหม่สำหรับรายการนี้ ให้ใช้แบบฟอร์มต่อไปนี้ "@+id/name" สัญลักษณ์บวกบ่งบอกว่านี่คือรหัสที่สร้างขึ้นใหม่
android:title
ทรัพยากรสตริง ชื่อเมนูเป็นทรัพยากรสตริงหรือสตริงดิบ
android:titleCondensed
ทรัพยากรสตริง ชื่อแบบย่อเป็นทรัพยากรสตริงหรือสตริงดิบ ชื่อนี้ใช้ในกรณีที่ชื่อปกติยาวเกินไป
android:icon
ทรัพยากรที่ถอนออกได้ รูปภาพที่จะใช้เป็นไอคอนรายการในเมนู
android:onClick
ชื่อเมธอด เมธอดที่จะเรียกใช้เมื่อคลิกรายการเมนูนี้ ต้องประกาศเมธอดในกิจกรรมเป็นแบบสาธารณะ โดยจะยอมรับ MenuItem เป็นพารามิเตอร์เดียว ซึ่งระบุรายการที่คลิก วิธีนี้มีความสำคัญเหนือกว่า Callback มาตรฐานไปยัง onOptionsItemSelected() ดูตัวอย่างที่ท้ายหน้านี้

คำเตือน: หากคุณสร้างความสับสนให้โค้ดโดยใช้ ProGuard หรือเครื่องมือที่คล้ายกัน โปรดตรวจสอบว่าได้ยกเว้นเมธอดที่คุณระบุในแอตทริบิวต์นี้จากการเปลี่ยนชื่อ เนื่องจากอาจทำให้ฟังก์ชันการทำงานเสียหายได้

เปิดตัวในระดับ API 11

android:showAsAction
คีย์เวิร์ด เวลาและวิธีที่รายการนี้จะปรากฏเป็นรายการการดำเนินการในแถบแอป รายการเมนูจะปรากฏเป็นรายการการทำงานได้ก็ต่อเมื่อกิจกรรมมีแถบแอปเท่านั้น ค่าที่ถูกต้อง:
ค่าคำอธิบาย
ifRoomวางรายการนี้ในแถบแอปเฉพาะในกรณีที่มีพื้นที่ว่างเท่านั้น หากมีพื้นที่ไม่เพียงพอสำหรับรายการทั้งหมดที่ทำเครื่องหมายเป็น "ifRoom" รายการที่มีค่า orderInCategory ต่ำสุดจะแสดงเป็นการดำเนินการ และรายการที่เหลือจะแสดงในเมนูรายการเพิ่มเติม
withTextรวมถึงใส่ข้อความชื่อ (กำหนดโดย android:title) ไว้กับรายการการทำงานด้วย คุณสามารถรวมค่านี้กับค่าอื่นๆ เป็นชุดแฟล็กได้โดยคั่นด้วยไปป์ |
neverอย่าวางรายการนี้ในแถบแอป แต่ให้แสดงรายการในเมนูรายการเพิ่มเติมของแถบแอปแทน
alwaysวางรายการนี้ในแถบแอปเสมอ หลีกเลี่ยงการใช้ค่านี้ เว้นแต่ว่ารายการนั้นจำเป็นต้องปรากฏในแถบการดำเนินการเสมอ การตั้งค่าหลายรายการให้ปรากฏเป็นรายการการทำงานเสมออาจทำให้รายการเหล่านั้นซ้อนทับกับ UI อื่นๆ ในแถบแอป
collapseActionViewมุมมองการดำเนินการที่เชื่อมโยงกับรายการการดำเนินการนี้ (ตามที่ประกาศโดย android:actionLayout หรือ android:actionViewClass) สามารถยุบได้
เปิดตัวในระดับ API 14

ดูข้อมูลเพิ่มเติมได้ที่เพิ่มแถบแอป

เปิดตัวในระดับ API 11

android:actionLayout
ทรัพยากรเลย์เอาต์ เลย์เอาต์ที่จะใช้เป็นมุมมองการดำเนินการ

ดูข้อมูลเพิ่มเติมได้ที่ใช้มุมมองการดำเนินการและผู้ให้บริการการดำเนินการ

เปิดตัวในระดับ API 11

android:actionViewClass
ชื่อชั้นเรียน ชื่อคลาสที่สมบูรณ์ในตัวเองสำหรับ View เพื่อใช้เป็นมุมมองการดำเนินการ เช่น "android.widget.SearchView" เพื่อใช้ SearchView เป็นมุมมองการดำเนินการ

ดูข้อมูลเพิ่มเติมได้ที่ใช้มุมมองการดำเนินการและผู้ให้บริการการดำเนินการ

คำเตือน: หากคุณสร้างความสับสนให้โค้ดโดยใช้ ProGuard หรือเครื่องมือที่คล้ายกัน โปรดตรวจสอบว่าได้ยกเว้นคลาสที่คุณระบุในแอตทริบิวต์นี้จากการเปลี่ยนชื่อ เนื่องจากอาจทำให้ฟังก์ชันการทำงานเสียหายได้

เปิดตัวในระดับ API 11

android:actionProviderClass
ชื่อชั้นเรียน ชื่อคลาสที่สมบูรณ์ในตัวเองสำหรับ ActionProvider เพื่อใช้แทนรายการการดำเนินการ เช่น "android.widget.ShareActionProvider" เพื่อใช้ ShareActionProvider

ดูข้อมูลเพิ่มเติมได้ที่ใช้มุมมองการดำเนินการและผู้ให้บริการการดำเนินการ

คำเตือน: หากคุณสร้างความสับสนให้โค้ดโดยใช้ ProGuard หรือเครื่องมือที่คล้ายกัน โปรดตรวจสอบว่าได้ยกเว้นคลาสที่คุณระบุในแอตทริบิวต์นี้จากการเปลี่ยนชื่อ เนื่องจากอาจทำให้ฟังก์ชันการทำงานเสียหายได้

เปิดตัวในระดับ API 14

android:alphabeticShortcut
Char อักขระสำหรับแป้นพิมพ์ลัดตัวอักษร
android:numericShortcut
จำนวนเต็ม ตัวเลขสำหรับแป้นพิมพ์ลัดตัวเลข
android:alphabeticModifiers
คีย์เวิร์ด ตัวแก้ไขสำหรับแป้นพิมพ์ลัดตามตัวอักษรของรายการในเมนู ค่าเริ่มต้นจะสอดคล้องกับแป้น Control ค่าที่ถูกต้อง:
ค่าคำอธิบาย
META ตรงกับแป้น Meta Meta
CTRL สอดคล้องกับคีย์เมตา Control
ALT สอดคล้องกับแป้นเมตา Alt
SHIFT สอดคล้องกับแป้น Meta Shift
SYM สอดคล้องกับคีย์เมตา Sym
FUNCTION สอดคล้องกับแป้นเมตา Function

หมายเหตุ: คุณระบุคีย์เวิร์ดหลายรายการในแอตทริบิวต์ได้ เช่น android:alphabeticModifiers="CTRL|SHIFT" บ่งบอกว่าหากต้องการเรียกใช้รายการเมนูที่เกี่ยวข้อง ผู้ใช้ต้องกดทั้งแป้นเมตา Control และ Shift พร้อมกับแป้นพิมพ์ลัด

คุณสามารถใช้เมธอด setAlphabeticShortcut() เพื่อตั้งค่าแอตทริบิวต์แบบเป็นโปรแกรมได้ ดูข้อมูลเพิ่มเติมเกี่ยวกับแอตทริบิวต์ alphabeticModifier ได้ที่ alphabeticModifiers

android:numericModifiers
คีย์เวิร์ด แป้นกดร่วมสำหรับแป้นพิมพ์ลัดที่เป็นตัวเลขของรายการในเมนู ค่าเริ่มต้นจะสอดคล้องกับแป้น Control ค่าที่ถูกต้อง:
ค่าคำอธิบาย
META ตรงกับแป้น Meta Meta
CTRL สอดคล้องกับคีย์เมตา Control
ALT สอดคล้องกับแป้นเมตา Alt
SHIFT สอดคล้องกับแป้น Meta Shift
SYM สอดคล้องกับคีย์เมตา Sym
FUNCTION สอดคล้องกับแป้นเมตา Function

หมายเหตุ: คุณระบุคีย์เวิร์ดหลายรายการในแอตทริบิวต์ได้ เช่น android:numericModifiers="CTRL|SHIFT" บ่งบอกว่าหากต้องการเรียกใช้รายการเมนูที่เกี่ยวข้อง ผู้ใช้ต้องกดทั้งแป้นเมตา Control และ Shift พร้อมกับแป้นพิมพ์ลัด

คุณสามารถใช้เมธอด setNumericShortcut() เพื่อตั้งค่าแอตทริบิวต์แบบเป็นโปรแกรมได้ ดูข้อมูลเพิ่มเติมเกี่ยวกับแอตทริบิวต์ numericModifier ได้ที่ numericModifiers

android:checkable
บูลีน เป็นจริงหากเลือกรายการได้
android:checked
บูลีน เป็นจริงหากมีการเลือกรายการโดยค่าเริ่มต้น
android:visible
บูลีน เป็นจริงหากรายการปรากฏโดยค่าเริ่มต้น
android:enabled
บูลีน เป็นจริงหากรายการเปิดใช้อยู่โดยค่าเริ่มต้น
android:menuCategory
คีย์เวิร์ด ค่าที่สอดคล้องกับค่าคงที่ Menu CATEGORY_* ซึ่งกำหนดลำดับความสำคัญของรายการ ค่าที่ถูกต้อง:
ค่าคำอธิบาย
containerสำหรับรายการที่เป็นส่วนหนึ่งของคอนเทนเนอร์
systemสำหรับรายการที่ระบบจัดเตรียมไว้ให้
secondaryสำหรับรายการที่เป็นตัวเลือกรอง (ใช้ไม่บ่อย) ที่ผู้ใช้ระบุ
alternativeสำหรับรายการที่เป็นการดำเนินการทางเลือก ในข้อมูลที่แสดงอยู่ในปัจจุบัน
android:orderInCategory
จำนวนเต็ม ลำดับความสำคัญของรายการภายในกลุ่ม
<group>
กลุ่มเมนู เพื่อสร้างคอลเล็กชันของรายการที่มีลักษณะร่วมกัน เช่น รายการนั้นๆ จะมองเห็นได้ เปิดใช้ได้ หรือเลือกได้หรือไม่ มีองค์ประกอบ <item> อย่างน้อย 1 รายการ ต้องเป็นองค์ประกอบย่อยขององค์ประกอบ <menu>

แอตทริบิวต์:

android:id
รหัสทรัพยากร รหัสทรัพยากรที่ไม่ซ้ำกัน หากต้องการสร้างรหัสทรัพยากรใหม่สำหรับรายการนี้ ให้ใช้แบบฟอร์ม "@+id/name" สัญลักษณ์บวกบ่งบอกว่านี่คือรหัสที่สร้างขึ้นใหม่
android:checkableBehavior
คีย์เวิร์ด ประเภทของลักษณะการทำงานที่เลือกได้สำหรับกลุ่ม ค่าที่ถูกต้อง:
ค่าคำอธิบาย
noneเลือกไม่ได้
allเลือกรายการทั้งหมดได้ (ใช้ช่องทำเครื่องหมาย)
singleเลือกได้เพียง 1 รายการ (ใช้ปุ่มตัวเลือก)
android:visible
บูลีน เป็นจริงหากมองเห็นกลุ่มได้
android:enabled
บูลีน True หากเปิดใช้กลุ่ม
android:menuCategory
คีย์เวิร์ด ค่าที่สอดคล้องกับค่าคงที่ Menu CATEGORY_* ซึ่งกำหนดลำดับความสำคัญของกลุ่ม ค่าที่ถูกต้อง:
ค่าคำอธิบาย
containerสำหรับกลุ่มที่เป็นส่วนหนึ่งของคอนเทนเนอร์
systemสำหรับกลุ่มที่ระบบจัดเตรียมไว้ให้
secondaryสำหรับกลุ่มที่เป็นตัวเลือกสำรองที่ผู้ใช้ระบุ (ใช้ไม่บ่อย)
alternativeสำหรับกลุ่มที่เป็นการดำเนินการทางเลือกในข้อมูลที่แสดงอยู่ในปัจจุบัน
android:orderInCategory
จำนวนเต็ม ลำดับเริ่มต้นของรายการภายในหมวดหมู่
ตัวอย่าง:
ไฟล์ XML ที่บันทึกไว้ที่ res/menu/example_menu.xml:
<menu xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto">
    <item android:id="@+id/item1"
          android:title="@string/item1"
          android:icon="@drawable/group_item1_icon"
          app:showAsAction="ifRoom|withText"/>
    <group android:id="@+id/group">
        <item android:id="@+id/group_item1"
              android:onClick="onGroupItemClick"
              android:title="@string/group_item1"
              android:icon="@drawable/group_item1_icon" />
        <item android:id="@+id/group_item2"
              android:onClick="onGroupItemClick"
              android:title="@string/group_item2"
              android:icon="@drawable/group_item2_icon" />
    </group>
    <item android:id="@+id/submenu"
          android:title="@string/submenu_title"
          app:showAsAction="ifRoom|withText" >
        <menu>
            <item android:id="@+id/submenu_item1"
                  android:title="@string/submenu_item1" />
        </menu>
    </item>
</menu>

โค้ดของแอปพลิเคชันต่อไปนี้จะขยายเมนูจาก Callback onCreateOptionsMenu(Menu) และประกาศ Callback สำหรับการคลิกของ 2 รายการด้วย

Kotlin

override fun onCreateOptionsMenu(menu: Menu): Boolean {
    menuInflater.inflate(R.menu.example_menu, menu)
    return true
}

fun onGroupItemClick(item: MenuItem) {
    // One of the group items (using the onClick attribute) was clicked.
    // The item parameter passed here indicates which item it is.
    // All other menu item clicks are handled by Activity.onOptionsItemSelected.
}

Java

public boolean onCreateOptionsMenu(Menu menu) {
    MenuInflater inflater = getMenuInflater();
    inflater.inflate(R.menu.example_menu, menu);
    return true;
}

public void onGroupItemClick(MenuItem item) {
    // One of the group items (using the onClick attribute) was clicked.
    // The item parameter passed here indicates which item it is.
    // All other menu item clicks are handled by Activity.onOptionsItemSelected.
}