BaseListView
класс в UnityEngine.UIElements
Наследуется от:UIElements.BaseVerticalCollectionView
Выполнено в:UnityEngine.UIElementsModule
Описание
Базовый класс представления списка — вертикально прокручиваемой области, связанной со списком элементов и отображающей его.
Для разницы между IDs и индексами, см. BaseVerticalCollectionView.
Статические свойства
| Свойство | Описание |
|---|---|
| arraySizeFieldUssClassName | Имя USS-класса для поля размера ListView, когда включён показ размера привязанной коллекции |
| arraySizeFieldWithFooterUssClassName | Имя USS-класса для поля размера ListView, когда включён нижний колонтитул. |
| arraySizeFieldWithHeaderUssClassName | Имя USS-класса для поля размера ListView, когда включён сворачиваемый заголовок. |
| emptyLabelUssClassName | Имя USS-класса для метки, отображаемой, когда ListView пуст. |
| foldoutHeaderUssClassName | Имя USS-класса для сворачиваемого заголовка ListView. |
| footerAddButtonName | Имя элемента добавления кнопки в нижнем колонтитуле. |
| footerRemoveButtonName | Имя элемента кнопки удаления в нижнем колонтитуле. |
| footerUssClassName | Имя USS-класса для нижнего колонтитула ListView. |
| itemUssClassName | Имя USS-класса для элементов списка в элементах ListView. |
| listViewWithFooterUssClassName | Имя USS-класса для ListView, когда включён нижний колонтитул добавления/удаления. |
| listViewWithHeaderUssClassName | Имя USS-класса для ListView, когда включён сворачиваемый заголовок. |
| overMaxMultiEditLimitClassName | Имя USS-класса для метки, которая отображается, когда ListView пытается редактировать слишком много элементов. |
| reorderableItemContainerUssClassName | Имя USS-класса для контейнера элементов в ListView с анимированным переупорядочиванием. |
| reorderableItemHandleBarUssClassName | Имя USS-класса для полосы маркера перетаскивания в ListView с анимированным переупорядочиванием. |
| reorderableItemHandleUssClassName | Имя USS-класса для маркера перетаскивания в ListView с анимированным переупорядочиванием. |
| reorderableItemUssClassName | Имя USS-класса для элементов списка в ListView с анимированным переупорядочиванием. |
| reorderableUssClassName | Имя USS-класса для элементов ListView с анимированным переупорядочиванием. |
| scrollViewWithFooterUssClassName | Имя USS-класса для области прокрутки, когда включён нижний колонтитул добавления/удаления. |
| ussClassName | Имя USS-класса для элементов ListView. |
Свойства
| Свойство | Описание |
|---|---|
| allowAdd | Это свойство позволяет пользователю разрешить или запретить добавление элемента при нажатии кнопки Добавить. Оно должно возвращать true или false. |
| allowRemove | Это свойство позволяет пользователю разрешить или запретить удаление элемента при нажатии кнопки Удалить. Оно должно возвращать true или false. |
| bindingSourceSelectionMode | Это свойство управляет тем, будет ли каждый элемент в списке автоматически получать настройку источника данных к правильному элементу в источнике коллекции. |
| headerTitle | Это свойство управляет текстом развернутого заголовка при использовании showFoldoutHeader. |
| makeFooter | Этот обратный вызов позволяет пользователю создать свой собственный нижний колонтитул для этого элемента управления. |
| makeHeader | Этот обратный вызов позволяет пользователю создать свой собственный заголовок для этого контроля. |
| makeNoneElement | Этот обратный вызов позволяет пользователю установить визуальный элемент для замены метки "Список пуст", которая показывается, когда ListView пуст. |
| onAdd | Этот обратный вызов позволяет пользователю реализовать свой собственный код, который будет выполняться при нажатии кнопки Добавить. |
| onRemove | Этот обратный вызов позволяет пользователю реализовать свой собственный код, который будет выполняться при нажатии кнопки Удалить. |
| overridingAddButtonBehavior | Этот обратный вызов позволяет пользователю реализовать DropdownMenu при нажатии кнопки Добавить. |
| reorderMode | Это свойство управляет режимом перетаскивания для представления списка. |
| showAddRemoveFooter | Это свойство определяет, будет ли в представление списка добавлен нижний колонтитул. |
| showBoundCollectionSize | Это свойство определяет, отображается ли в представлении списка размер коллекции (количество элементов). |
| showFoldoutHeader | Это свойство определяет, отображается ли в представлении списка заголовок в виде развернутого окна, которое может быть развернуто или свёрнуто. |
| viewController | Контроллер представления для этого представления, представленный как BaseListViewController. |
Конструкторы
| Конструктор | Описание |
|---|---|
| BaseListView | Создает BaseListView со всеми свойствами по умолчанию. BaseVerticalCollectionView.itemsSource должен быть установлен для того, чтобы BaseListView работал правильно. |
Открытые методы
| Метод | Описание |
|---|---|
| SetViewController | Назначает контроллер представления для данного представления и регистрирует все события, необходимые для его правильной работы. |
Мероприятия
| Мероприятие | Описание |
|---|---|
| itemsAdded | Это событие вызывается для каждого элемента, добавленного в itemsSource. Включает индекс элемента. |
| itemsRemoved | Это событие вызывается для каждого элемента, удаленного из itemsSource. Включает индекс элемента. |
Унаследованные члены 5
Статические свойства
| Свойство | Описание |
|---|---|
| borderUssClassName | Имя USS-класса для элементов BaseVerticalCollectionView с рамкой. |
| dragHoverBarUssClassName | Имя USS-класса для полосы наведения при перетаскивании. |
| dragHoverMarkerUssClassName | Имя USS-класса для круглого маркера наведения при перетаскивании, обозначающего глубину. |
| itemAlternativeBackgroundUssClassName | Имя USS-класса для нечётных строк в BaseVerticalCollectionView. |
| itemDragHoverUssClassName | Имя USS-класса, применяемое к элементу списка при наведении перетаскиваемого объекта. |
| itemSelectedVariantUssClassName | Имя USS-класса для выбранных элементов списка в BaseVerticalCollectionView. |
| itemUssClassName | Имя USS-класса для элементов списка в элементах BaseVerticalCollectionView. |
| listScrollViewUssClassName | Имя USS-класса для области прокрутки в BaseVerticalCollectionView. |
| ussClassName | Имя USS-класса для элементов BaseVerticalCollectionView. |
| disabledUssClassName | Имя USS-класса для локально отключённых элементов. |
Свойства
| Свойство | Описание |
|---|---|
| contentContainer | Возвращает контейнер содержимого для BaseVerticalCollectionView. Поскольку BaseVerticalCollectionView автоматически управляет своим содержимым, это всегда возвращает null. |
| fixedItemHeight | Высота одного элемента в списке в пикселях. |
| horizontalScrollingEnabled | Это свойство определяет, показывает ли представление коллекции горизонтальную панель прокрутки, когда ее содержимое не вписывается в видимую область. |
| itemsSource | Источник данных для элементов коллекции. |
| reorderable | Получает или устанавливает значение, указывающее, может ли пользователь перетаскивать элементы списка для изменения их порядка. |
| selectedIds | Возвращает постоянный IDs выбранных элементов в источнике данных, независимо от того, свернуты они или нет. Всегда возвращает перечисляемое, даже если не выбран ни один элемент или выбран один элемент. |
| selectedIndex | Возвращает или устанавливает индекс выбранного элемента в источнике данных. Если выделено несколько элементов, возвращается индекс первого выбранного элемента. Если выделено несколько элементов, все они устанавливаются как выбранные. Если не выделено ни одного элемента, возвращается -1. |
| selectedIndices | Возвращает индексы выбранных элементов в источнике данных. Всегда возвращает перечисляемое значение, даже если не выбран ни один элемент или выбран один элемент. |
| selectedItem | Возвращает выбранный элемент из источника данных. Если выбрано несколько элементов, возвращается первый выбранный элемент. |
| selectedItems | Возвращает выбранные элементы из источника данных. Всегда возвращает перечисляемое значение, даже если не выбран ни один элемент или выбран один элемент. |
| selectionType | Управляет типом выбора. |
| showAlternatingRowBackgrounds | Это свойство определяет, чередуются ли цвета фона строк представления коллекции. Принимает значение из перечисления AlternatingRowBackground. |
| showBorder | Включите это свойство для отображения границы вокруг представления коллекции. |
| viewController | Контроллер представления для этого представления. |
| virtualizationMethod | Метод виртуализации, используемый для этой коллекции, когда видна полоса прокрутки. Принимает значение из перечисления CollectionVirtualizationMethod. |
| binding | Объект привязки, который будет обновлен. |
| bindingPath | Путь к целевому свойству для привязки. |
| canGrabFocus | Можно ли фокусировать элемент. |
| delegatesFocus | Делегирует ли элемент фокус своим дочерним элементам. |
| focusable | Может ли элемент потенциально получать фокус. |
| focusController | Возвращает контроллер фокуса для этого элемента. |
| tabIndex | Целое число, используемое для сортировки фокусируемых элементов в кольце фокуса. Должно быть больше или равно нулю. |
| childCount | Количество дочерних элементов в contentContainer этого объекта. |
| contentRect | Прямоугольник области содержимого элемента в локальном пространстве элемента. (Только для чтения) |
| customStyle | Настраиваемый аксессор свойств стиля VisualElement (только для чтения). |
| dataSource | Назначает источник данных этому VisualElement, который переопределяет любой унаследованный источник данных. Этот источник данных наследуется всеми дочерними объектами. |
| dataSourcePath | Путь от источника данных к значению. |
| dataSourceType | Возможный тип источника данных, присваиваемый этому VisualElement. Эта информация используется UI Builder только как подсказка, чтобы дать некоторое заполнение в поле пути источника данных, когда эффективный источник данных не может быть указан во время проектирования. |
| disablePlayModeTint | Оттенки режима воспроизведения применяются по умолчанию, если это не установлено в true. Они применяются иерархически к этому VisualElement и ко всем его дочерним объектам, которые существуют на панели редактора. |
| enabledInHierarchy | Возвращает true, если VisualElement включен в собственной иерархии. |
| enabledSelf | Возвращает true, если VisualElement включен локально. |
| experimental | Возвращает экспериментальные интерфейсы UIElements. |
| generateVisualContent | Функция делегирования для генерации визуального содержания визуального элемента. |
| hasActivePseudoState | Возвращает true, если этот элемент соответствует псевдоклассу :active. |
| hasCheckedPseudoState | Возвращает true, если этот элемент соответствует псевдоклассу :checked. |
| hasDisabledPseudoState | Возвращает true, если этот элемент соответствует псевдоклассу :disabled. |
| hasEnabledPseudoState | Возвращает true, если этот элемент соответствует псевдоклассу :enabled. |
| hasFocusPseudoState | Возвращает true, если этот элемент соответствует псевдоклассу :focus. |
| hasHoverPseudoState | Возвращает true, если этот элемент соответствует псевдоклассу :hover. |
| hasInactivePseudoState | Возвращает true, если этот элемент соответствует псевдоклассу :inactive. |
| hasRootPseudoState | Возвращает true, если этот элемент соответствует псевдоклассу :root. |
| hierarchy | Доступ к физической иерархии этого элемента |
| languageDirection | Указывает направленность текста элемента. Значение будет распространяться на дочерей элемента. |
| layout | Положение и размер VisualElement относительно его родительского объекта, как вычислено системой макета. (Только для чтения) |
| localBound | Возвращает Rect, представляющий выравниваемый по оси Bounding Box (AABB) после применения преобразования, но до применения преобразования макета. |
| name | Имя этого VisualElement. |
| paddingRect | Прямоугольник зоны заполнения элемента, в локальном пространстве элемента. |
| panel | Панель, к которой прикреплен этот VisualElement. |
| parent | Родители этого VisualElement. |
| pickingMode | Определяет, может ли этот элемент быть целью событий указателя или выбран запросами IPanel.Pick. |
| resolvedStyle | Окончательные отображенные значения стиля визуального элемента, как он отображается в текущем кадре.(Только для чтения) |
| scaledPixelsPerPoint | Возвращает результат масштабирования панели, который учитывает экран DPI и настраиваемый фактор масштабирования, но не масштаб трансформации элемента и его предшественников. См. Panel.scaledPixelsPerPoint. Этот метод должен вызываться только для элементов, которые являются частью панели. |
| schedule | Получает IVisualElementScheduler, связанный с этим VisualElement. Используйте его для очереди действий. |
| style | Устанавливает значения стиля на VisualElement. |
| styleSheets | Возвращает VisualElementStyleSheetSet, который манипулирует таблицами стилей, прикрепленными к этому элементу. |
| это[int] | Получает дочерний элемент в определенном индексе. |
| tooltip | Текст, который будет отображаться внутри информационного поля после того, как пользователь задержится над элементом небольшое время. Это поддерживается только в Редакторе UI. |
| usageHints | Сочетание значений подсказки, которые указывают схемы предполагаемого использования высокого уровня для VisualElement. Это свойство может быть установлено только тогда, когда VisualElement если это свойство еще не является частью панели. Как только это свойство становится частью панели, оно становится доступным только для чтения, и попытки изменить его вызывают исключение. UsageHints Подсказки позволяют системе принимать лучшие решения о том, как обрабатывать или ускорять определенные операции на основе предполагаемой схемы использования. Обратите внимание, что эти подсказки не влияют на поведение или визуальные результаты, а только влияют на общую производительность панели и элементов внутри нее. Рекомендуется всегда учитывать указание надлежащего UsageHints, но помните, что некоторые UsageHints могут быть внутренне проигнорированы при определенных условиях (e.g. из-за аппаратных ограничений на целевой платформе). |
| userData | Это свойство может использоваться для связывания данных пользователя, специфичных для приложения, с этим VisualElement. |
| viewDataKey | Используется для сохранения данных представления, таких как развернутые состояния дерева, положение прокрутки или уровень масштаба. |
| visible | Указывает, должен ли этот элемент отображаться или нет. |
| visualTreeAssetSource | Хранит ссылку на ассет, если генерируемый элемент клонирован из VisualTreeAsset. |
| worldBound | Возвращает выравниваемую по оси границу элемента в координатах панели после кумулятивного преобразования из корня IPanel. |
| worldTransform | Возвращает матрицу, которая накапливает следующие преобразования (в порядке): Local scalingLocal rotationLocal translationLayout translationParent worldTransform (рекурсивное определение — рассматривается матрица идентичности, когда нет родителя) |
Открытые методы
| Метод | Описание |
|---|---|
| AddToSelection | Добавление элемента в коллекцию выбранных элементов. |
| ClearSelection | Снятие выбора всех выбранных элементов. |
| GetRootElementForId | Получает корневой элемент указанного элемента представления коллекции. |
| GetRootElementForIndex | Получает корневой элемент указанного элемента представления коллекции. |
| Rebuild | Очистка представления коллекции, восстановление всех видимых визуальных элементов и повторное привязывание всех элементов. |
| RefreshItem | Перепривязывает один элемент, если он в настоящее время видим в представлении коллекции. |
| RefreshItems | Повторная связь всех видимых элементов. |
| RemoveFromSelection | Удаление элемента из коллекции выбранных элементов. |
| ScrollTo | Прокрутка до конкретного VisualElement. |
| ScrollToItem | Прокрутка до определенного индекса элемента и его отображение. |
| ScrollToItemById | Прокрутка до определенного идентификатора элемента и его отображение. |
| SetSelection | Устанавливает текущий выбранный элемент. |
| SetSelectionWithoutNotify | Задает коллекцию выбранных элементов без запуска обратного вызова изменения выбора. |
| HasBubbleUpHandlers | Возвращает true, если к этому объекту были прикреплены обработчики событий для фазы распространения событий BubbleUp. |
| HasTrickleDownHandlers | Возвращает true, если к этому объекту прикреплены обработчики событий для фазы распространения событий TrickleDown. |
| RegisterCallback | Добавление обработчика событий к экземпляру. |
| RegisterCallbackOnce | Добавление обработчика событий к экземпляру. Обработчик событий автоматически отменяет регистрацию после того, как он был вызван ровно один раз. |
| UnregisterAllRemovableCallbacks | Удаляет из экземпляра все обратные вызова, зарегистрированные с CallbackOptions.Removable. |
| UnregisterCallback | Удалить обратный вызов из экземпляра. |
| Blur | Сообщает элементу, чтобы он освободил фокус. |
| Focus | Попытки сосредоточить внимание на этом элементе. |
| Add | Добавление элемента в contentContainer этого элемента. |
| AddToClassList | Добавляет класс в список классов элемента, чтобы назначить стили из USS. Учтите, что имя класса чувствительно к регистру. |
| BringToFront | Переносит этот элемент в конец родительского дочернего списка. Элемент будет визуально находиться перед любыми перекрывающимися элементами-родственниками. |
| Children | Возвращает элементы из contentContainer. |
| ClassListContains | Ищет класс в списке классов этого элемента. |
| Clear | Удалить все дочерние элементы из contentContainer этого элемента |
| ClearBinding | Удаляет привязку из элемента. |
| ClearBindings | Удаляет все привязки из элемента. |
| ClearClassList | Удаляет все классы из списка классов этого элемента. AddToClassList |
| Contains | Проверяет, является ли данный элемент предком указанного дочернего элемента. |
| ContainsPoint | Проверяет, пересекается ли указанная точка с этим расположением VisualElement. |
| ElementAt | Получает дочерний элемент в определенном индексе. |
| EnableInClassList | Включает или отключает класс с заданным именем. |
| FindAncestorUserData | Поиск в иерархии этого VisualElement и получение хранящегося userData, если таковой найден. |
| FindCommonAncestor | Находит наименьшего общего предка между двумя VisualElements внутри иерархии VisualTree. |
| GetBinding | Получает экземпляр привязки для указанного целевого свойства. |
| GetBindingInfos | Получает информацию обо всех привязках текущего элемента. |
| GetClasses | Получить классы для этого элемента. |
| GetDataSourceContext | Запросы dataSource и dataSourcePath объекта привязки. |
| GetFirstAncestorOfType | Проходит вверх по иерархии, начиная с родителя этого элемента, и возвращает первый VisualElement этого типа |
| GetFirstOfType | Проходит вверх по иерархии, начиная с этого элемента, и возвращает первый VisualElement этого типа |
| GetHierarchicalDataSourceContext | Запросы dataSource и dataSourcePath унаследованы от иерархии. |
| HasBinding | Позволяет узнать, связана ли с целевым свойством привязка. |
| IndexOf | Получает дочерний индекс указанного VisualElement. |
| Insert | Вставить элемент в contentContainer этого элемента |
| IsMarkedForRepaint | Проверяет, не загрязнен ли VisualElement для перекраски. |
| MarkDirtyRepaint | Помечает, что VisualElement требует перекраски. |
| PlaceBehind | Помещает этот элемент прямо перед элементом-родственником в их родительском дочернем списке. Если позиция элемента и элемента-родственника перекрываются, элемент будет визуально находиться позади своего родственника. |
| PlaceInFront | Помещает этот элемент сразу после элемента-сестры в их родительском дочернем списке. Если элемент и позиция элемента-сестры перекрываются, элемент будет визуально находиться перед элементом-сестры. |
| Remove | Удаляет этот дочерний объект из иерархии его contentContainer. |
| RemoveAt | Удаляет дочерний элемент с указанным индексом из списка дочерних элементов текущего элемента. |
| RemoveFromClassList | Удаляет класс из списка классов элемента. |
| RemoveFromHierarchy | Удаляет этот элемент из родительской иерархии. |
| SendEvent | Отправляет событие в обработчик событий. |
| SendToBack | Отправляет этот элемент в начало родительского дочернего списка. Элемент будет визуально находиться за любыми перекрывающимися родственными элементами. |
| SetActivePseudoState | Задает, будет ли этот элемент отображаться как активный. |
| SetBinding | Назначает привязку между конечным объектом и источником. |
| SetCheckedPseudoState | Задает, будет ли этот элемент отображаться как отмеченный. |
| SetEnabled | Меняет состояние VisualElement. Отключённый визуальный элемент не получает большинство событий. |
| Sort | Переупорядочивает дочерние элементы из VisualElement в contentContainer. |
| ToggleInClassList | Переключает между добавлением и удалением заданного имени класса в списке классов. |
| TryGetBinding | Получает экземпляр привязки для указанного целевого свойства. |
| TryGetDataSourceContext | Запросы dataSource и dataSourcePath объекта привязки. |
| TryGetLastBindingToSourceResult | Возвращает последний BindingResult объекта привязки из UI в источник данных. |
| TryGetLastBindingToUIResult | Возвращает последний BindingResult объекта привязки из источника данных к UI. |
Защищенные методы
| Метод | Описание |
|---|---|
| CreateViewController | Создает контроллер представления для данного представления. Переопределите этот метод в наследниках, чтобы изменить тип контроллера. |
| HandleEventBubbleUp | Выполняет логику на этом элементе во время фазы BubbleUp, непосредственно перед обратными вызовами BubbleUp этого элемента. Вызов StopPropagation предотвратит дальнейшие вызовы этого метода вдоль пути распространения. |
| HandleEventTrickleDown | Выполняет логику на этом элементе во время фазы TrickleDown, сразу после обратных вызовов TrickleDown этого элемента. Вызов StopPropagation предотвратит дальнейшие вызовы этого метода вдоль пути распространения. |
| NotifyPropertyChanged | Сообщает системе привязки данных о том, что изменилось свойство контроля. |
Мероприятия
| Мероприятие | Описание |
|---|---|
| canStartDrag | Вызывается, когда операция перетаскивания хочет начать работу в этом представлении коллекции. |
| dragAndDropUpdate | Вызывается при обновлении операции перетаскивания в этом представлении коллекции. |
| handleDrop | Вызывается при освобождении операции перетаскивания в этом представлении коллекции. |
| itemIndexChanged | Вызывается при перемещении элемента в itemsSource. |
| itemsChosen | Обратный вызов запускается, когда пользователь выполняет действие на выборе одного или нескольких элементов, например, двойным щелчком или нажатием клавиши Enter. |
| itemsSourceChanged | Возникает, когда источнику данных представления вертикальной коллекции назначается новая ссылка или новый тип. |
| onItemsChosen | Устаревший. Используйте BaseVerticalCollectionView.itemsChosen вместо него. |
| onSelectedIndicesChange | Устаревший. Используйте BaseVerticalCollectionView.selectedIndicesChanged вместо него. |
| onSelectionChange | Устаревший. Используйте BaseVerticalCollectionView.selectionChanged вместо него. |
| selectedIndicesChanged | Обратный вызов запускается при изменении выбора. |
| selectionChanged | Обратный вызов запускается при изменении выбора. |
| setupDragAndDrop | Вызывается при начале операции перетаскивания в этом представлении коллекции. |