FGX.CollectionView.TfgCustomCollectionView: различия между версиями

Материал из FGX Native Докуметации
Перейти к навигации Перейти к поиску
(summary)
(summary)
Строка 82: Строка 82:
 
| <code lang="Delphi">procedure</code> || <code lang="Delphi">EndPullToRefresh()</code>
 
| <code lang="Delphi">procedure</code> || <code lang="Delphi">EndPullToRefresh()</code>
 
Заканчивает процесс обновления данных, начатый пользователем. Это приводит к скрытию индикатора загрузки и загрузки данных в список. Обратите внимание, что для визуального обновления данных, разработчику так же нужно воспользовать одним из методов обновления данных '' ReloadItems '' или '' ReloadItem '' .
 
Заканчивает процесс обновления данных, начатый пользователем. Это приводит к скрытию индикатора загрузки и загрузки данных в список. Обратите внимание, что для визуального обновления данных, разработчику так же нужно воспользовать одним из методов обновления данных '' ReloadItems '' или '' ReloadItem '' .
 +
|}
 +
 +
== Свойства ==
 +
 +
{| class="wikitable sortable"
 +
|-
 +
| <code>property</code> || <code>Count: [[Integer]]</code>
 +
Возвращает общее количество элементов списка. Использует обработчик '' OnGetItemCount '' .
 +
|-
 +
| <code>property</code> || <code>StylesContainer: [[FGX.CollectionView.TfgCollectionViewStyles|TfgCollectionViewStyles]]</code>
 +
Контейнер стилей, содержит все стили коллекции.
 +
|-
 +
| <code>property</code> || <code>ContentOffset: [[TPointF]]</code>
 +
Возвращает смещение контента.
 +
|-
 +
| <code>property</code> || <code>Selection: [[.TfgCollectionViewItemsArray|TfgCollectionViewItemsArray]]</code>
 +
Массив индексов выделенных элементов.
 +
|-
 +
| <code>property</code> || <code>IsPullToRefreshActive: [[Boolean]]</code>
 +
 +
|-
 +
| <code>property</code> || <code>ScrollGlowColorLink: [[FGX.Assets.Color.TfgAssetColorLink|TfgAssetColorLink]]</code>
 +
 +
|-
 +
| <code>property</code> || <code>SelectionColorLink: [[FGX.Assets.Color.TfgAssetColorLink|TfgAssetColorLink]]</code>
 +
 +
|-
 +
| <code>property</code> || <code>PullToRefreshOptions: [[FGX.CollectionView.TfgPullToRefreshOptions|TfgPullToRefreshOptions]]</code>
 +
Настройки режима обновления списка "Потяни и обнови".
 +
|-
 +
| <code>property</code> || <code>ScrollGlowColor: [[TAlphaColor]]</code>
 +
Цвет эффекта прокручивания списка, который появляется при попытке прокрутить список за его границы.
 +
|-
 +
| <code>property</code> || <code>ScrollGlowColorName: [[.TfgAssetName|TfgAssetName]]</code>
 +
 +
|-
 +
| <code>property</code> || <code>SelectionColor: [[TAlphaColor]]</code>
 +
Общий цвет выделение элементов по умолчанию. Каждый стиль элемента может переопределить это значение через аналогичное свойство '' TfgCollectionViewStyle.SelectionColor '' .
 +
|-
 +
| <code>property</code> || <code>SelectionColorName: [[.TfgAssetName|TfgAssetName]]</code>
 +
Название ресурса цвета выделения элементов в контроле.
 +
|-
 +
| <code>property</code> || <code>SelectionMode: [[.TfgCollectionViewSelectionMode|TfgCollectionViewSelectionMode]]</code>
 +
Режим выделения элементов. Всего существует три способа выделения:
 +
 +
Режим выделения элементов. Всего существует три способа выделения:
 
|}
 
|}

Версия 03:51, 10 июня 2019

Delphi

TfgCustomCollectionView = class (TfgControl, IFGXTapSupported, IFGXNotificationObserver, IFGXNotificationObservable)

Конструкторы

constructor Create(AOwner: TComponent)

Методы

procedure ReloadItems()

Перезагружает элементы коллекции. Форсирует перезагрузку всех элементов списка.

procedure ReloadItem(const AItemIndex: Integer)

Перезагружает элемент коллекции по указанному индексу.

function GetItemId(const AItemIndex: Integer)

Возвращает идентификатор элемента по его порядковому индексу. Для этого использует данные, полученные в результате работы обработчика события OnGetItemId . По умолчанию использует порядковый иднекс элемента.

function FindItemIndexById(const AItemId: Int64; out AItemIndex: Integer)

Поиск порядкового индекса элемента по его уникальному идентификатору. Задание уникальных идентификаторо элементов осуществляется через событие OnGetItemId .

function FindItemIndexByPoint(const APoint: TPointF; out AItemIndex: Integer)

Поиск порядкового индекса элемента по координатам точки в CollectionView, попадающая в один из видимых элементов. Работает только для видимых элементов с индексами в диапазоне GetFirstVisibleItemIndex и GetLastVisibleItemIndex . APoint указывается в системе координат контрола с учетом смещения прокрутки.

function FindItemIndexByObject(const AObject: TObject; out AItemIndex: Integer)

Поиск порядкового индекса элемента по объекту, который принадлежит стилю элемента (по цепочке родителей можно выйти к стилю элемента).

function FindItemWrapperByIndex(const AItemIndex: Integer; out AItemWrapper: TfgItemWrapper)

Ищет TfgItemWrapper для работы с контролом элемента по индексу. Если элемента по указанному индексу нет, то в AItemWrapper будет nil.

function FindItemControlByIndex(const AItemIndex: Integer; out AControl: TfgControl)

Ищет контрол TfgControl элемента по индексу. Если элемента по указанному индексу нет, то в AControl будет nil.

function GetFirstVisibleItemIndex()

Возвращает индекс первого видимого элемента на экране.

function GetLastVisibleItemIndex()

Возвращает индекс последнего видимого элемента на экране.

function CreateStyle()

Создает новый пустой стиль с уникальным именем TfgCollectionViewStyle.TfgStyleName .

procedure AddStyle(const AStyle: TfgCollectionViewStyle)

Добавляет стиль в список стилей контрола.

function GetStyle(const AStyleName: string)

Возвращает стиль по его имени.

function GetStyleIndex(const AStyleName: string)

Возвращает индекс стиля по его имени. Первый стиль имеет индекс 0.

function GetStyleForItemIndex(const AItemIndex: Integer)

Возвращает стиль элемента по указанному индексу элемента.

procedure ScrollToItem(const AItemIndex: Integer; const AWithAnimation: Boolean)
procedure ResetSelection()

Сбрасывает текущее выделение всех выделенных элементов.

procedure ResetSelection(const AItemIndex: Integer)

Сбрасывает текущее выделение элемента с указанным индексом.

procedure SelectItem(const AItemIndex: Integer)

Выделяет элемент с указанным индексом.

procedure SelectAllItems()

Выделяет все элементы списка.

procedure BeginPullToRefresh()

Запускает программным способом процесс обновления данных с одновременным отображением индикатора загрузки. Разработчик должен выполнить/запустить процесс обновления данных и по окончании загрузки данных сообщить об этом контролу, вызвав EndPullToRefresh . Обратите внимание, что для визуального обновления данных, разработчику так же нужно воспользовать одним из методов обновления данных ReloadItems или ReloadItem .

procedure EndPullToRefresh()

Заканчивает процесс обновления данных, начатый пользователем. Это приводит к скрытию индикатора загрузки и загрузки данных в список. Обратите внимание, что для визуального обновления данных, разработчику так же нужно воспользовать одним из методов обновления данных ReloadItems или ReloadItem .

Свойства

property Count: Integer

Возвращает общее количество элементов списка. Использует обработчик OnGetItemCount .

property StylesContainer: TfgCollectionViewStyles

Контейнер стилей, содержит все стили коллекции.

property ContentOffset: TPointF

Возвращает смещение контента.

property Selection: TfgCollectionViewItemsArray

Массив индексов выделенных элементов.

property IsPullToRefreshActive: Boolean
property ScrollGlowColorLink: TfgAssetColorLink
property SelectionColorLink: TfgAssetColorLink
property PullToRefreshOptions: TfgPullToRefreshOptions

Настройки режима обновления списка "Потяни и обнови".

property ScrollGlowColor: TAlphaColor

Цвет эффекта прокручивания списка, который появляется при попытке прокрутить список за его границы.

property ScrollGlowColorName: TfgAssetName
property SelectionColor: TAlphaColor

Общий цвет выделение элементов по умолчанию. Каждый стиль элемента может переопределить это значение через аналогичное свойство TfgCollectionViewStyle.SelectionColor .

property SelectionColorName: TfgAssetName

Название ресурса цвета выделения элементов в контроле.

property SelectionMode: TfgCollectionViewSelectionMode

Режим выделения элементов. Всего существует три способа выделения:

Режим выделения элементов. Всего существует три способа выделения: