ListView

描述

ListView 是一个垂直可滚动的区域，它链接到并显示项目列表。

ListView 是一个 ScrollView，它具有额外的逻辑来显示垂直排列的 VisualElement 列表。列表中的每个 VisualElement 都绑定到数据源列表中的相应元素。数据源列表可以包含任何类型的元素。

创建 VisualElement 以及将它们绑定或解除绑定到数据源所需的逻辑，将根据预期结果而有所不同。为了使 ListView 正确运行，您必须至少提供 itemsSource 的值。

对于更复杂的项目，还建议提供以下属性
- makeItem
- bindItem
- unbindItem
- destroyItem
- 使用 CollectionVirtualizationMethod.FixedHeight 时，使用 fixedItemHeight


ListView 为可见项目创建多个 VisualElement 对象。当用户滚动时，ListView 会回收这些对象，并将它们重新绑定到新的数据项。

若要以像素为单位设置单个项目的高度，请在 UXML 中设置 item-height 属性，或在 C# 中设置 ListView.itemHeight 属性，以将其设置为所需的值。

若要在可滚动区域周围显示边框，请在 UXML 中设置 show-border 属性，或在 C# 中设置 ListView.showBorder 属性，以将其设置为 true。

默认情况下，用户一次只能选择列表中的一个元素。若要更改默认选择，请在 UXML 中使用 selection-type 属性，或使用 ListView.selectionType 属性在 C# 中进行更改。若要允许用户同时选择多个元素，请将属性设置为 Selection.Multiple。若要防止用户选择项目，请将属性设置为 Selection.None。

默认情况下，ListView 中的所有行都具有相同的背景色。若要使行背景色交替，请在 UXML 中设置 show-alternating-row-backgrounds 属性，或在 C# 中设置 ListView.showAlternatingRowBackgrounds 属性，以将其设置为 AlternatingRowBackground.ContentOnly 或 AlternatingRowBackground.All。有关详细信息，请参阅 AlternatingRowBackground。

默认情况下，用户无法重新排序列表的元素。若要允许用户拖动元素以重新排序，请在 UXML 中设置 reorderable 属性，或在 C# 中设置 ListView.reorderable 属性，以将其设置为 true。

若要使 ListView 中的第一个项目显示列表中的项目数，请在 UXML 中设置 show-bound-collection-size 属性，或将 ListView.showBoundCollectionSize 设置为 true。这在调试时很有用。默认情况下，ListView 的滚动元素只垂直滚动。

若要使水平滚动在显示的元素比可见区域宽时启用，请在 UXML 中设置 horizontal-scrolling-enabled 属性，或将 ListView.horizontalScrollingEnabled 设置为 true。有关详细信息，请参阅 ListView。

以下示例创建一个包含一千个项目的列表视图的编辑器窗口。

using System;
using System.Collections.Generic;
using UnityEditor;
using UnityEngine;
using UnityEngine.UIElements;

public class ListViewExampleWindow : EditorWindow
{
    [MenuItem("Window/ListViewExampleWindow")]
    public static void OpenDemoManual()
    {
        GetWindow<ListViewExampleWindow>().Show();
    }

    public void OnEnable()
    {
        // Create a list of data. In this case, numbers from 1 to 1000.
        const int itemCount = 1000;
        var items = new List<string>(itemCount);
        for (int i = 0; i <= itemCount - 1; i++)
            items.Add(i.ToString());

        // The "makeItem" function is called when the
        // ListView needs more items to render.
        Func<VisualElement> makeItem = () => new Label();

        // As the user scrolls through the list, the ListView object
        // recycles elements created by the "makeItem" function,
        // and invoke the "bindItem" callback to associate
        // the element with the matching data item (specified as an index in the list).
        Action<VisualElement, int> bindItem = (e, i) => (e as Label).text = items[i];

        // Provide the list view with an explicit height for every row
        // so it can calculate how many items to actually display
        const int itemHeight = 16;

        var listView = new ListView(items, itemHeight, makeItem, bindItem)
        {
            // Enables multiple selection using shift or ctrl/cmd keys.
            selectionType = SelectionType.Multiple
        };

        // Set up list view so that you can add or remove items dynamically.
        listView.showAddRemoveFooter = true;

        // Implement functionality on the list view to add or remove items.
        // Note: The "onAdd" and "onRemove" callbacks are optional and you should only use them to override the default logic.
        listView.onAdd = view =>
        {
            var itemsSourceCount = view.itemsSource.Count;
            view.itemsSource.Add(itemsSourceCount.ToString());
            view.RefreshItems();
            view.ScrollToItem(itemsSourceCount);
        };
        listView.onRemove = view =>
        {
            var itemsSourceCount = view.itemsSource.Count;
            view.itemsSource.RemoveAt(itemsSourceCount - 1);
            view.RefreshItems();
            view.ScrollToItem(itemsSourceCount - 2);
        };

        // Single click triggers "selectionChanged" with the selected items. (f.k.a. "onSelectionChange")
        // Use "selectedIndicesChanged" to get the indices of the selected items instead. (f.k.a. "onSelectedIndicesChange")
        listView.selectionChanged += objects => Debug.Log($"Selected: {string.Join(", ", objects)}");

        // Double-click triggers "itemsChosen" with the selected items. (f.k.a. "onItemsChosen")
        listView.itemsChosen += objects => Debug.Log($"Double-clicked: {string.Join(", ", objects)}");

        listView.style.flexGrow = 1.0f;

        rootVisualElement.Add(listView);

        // Allow to add items, but only when there is no override, by using a Toggle.
        listView.allowAdd = true;
        var toggle = new Toggle("Override Add functionality")
        {
            value = listView.overridingAddButtonBehavior != null,
            style = {alignSelf = Align.Auto},
        };
        toggle.RegisterValueChangedCallback(evt => listView.overridingAddButtonBehavior = evt.newValue
            ? (view, button) =>
            {
                Debug.Log("You cannot add new items at this time");
            }
            : null
        );
        rootVisualElement.Add(toggle);
    }
}

属性

构造函数

继承的成员