FGX.CollectionView.TfgCustomCollectionView: различия между версиями
Admin (обсуждение | вклад) (summary) |
Admin (обсуждение | вклад) (summary) |
||
Строка 164: | Строка 164: | ||
| <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnPullToRefresh: [[TNotifyEvent]]</code> | | <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnPullToRefresh: [[TNotifyEvent]]</code> | ||
Срабатывает, когда пользователь запускает процесс обновления списка. Чтобы это событие работало, нужно обязательно включить поддержку режима обновления данных '' EnabledPullToRefresh = True '' . | Срабатывает, когда пользователь запускает процесс обновления списка. Чтобы это событие работало, нужно обязательно включить поддержку режима обновления данных '' EnabledPullToRefresh = True '' . | ||
+ | |} | ||
+ | |||
+ | == Константы == | ||
+ | |||
+ | {| class="wikitable sortable" | ||
+ | |- | ||
+ | | <syntaxhighlight lang="Delphi">const</syntaxhighlight> || <code>DefaultScrollGlowColor: [[TAlphaColor]]</code> | ||
+ | |||
+ | |- | ||
+ | | <syntaxhighlight lang="Delphi">const</syntaxhighlight> || <code>DefaultSelectionMode: [[.TfgCollectionViewSelectionMode|TfgCollectionViewSelectionMode]]</code> | ||
+ | |||
+ | |- | ||
+ | | <syntaxhighlight lang="Delphi">const</syntaxhighlight> || <code>DefaultSelectionColor: [[TAlphaColor]]</code> | ||
+ | |||
|} | |} |
Версия 04:47, 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): Int64
Возвращает идентификатор элемента по его порядковому индексу. Для этого использует данные, полученные в результате работы обработчика события OnGetItemId . По умолчанию использует порядковый иднекс элемента. |
function
|
FindItemIndexById(const AItemId: Int64; out AItemIndex: Integer): Boolean
Поиск порядкового индекса элемента по его уникальному идентификатору. Задание уникальных идентификаторо элементов осуществляется через событие OnGetItemId . |
function
|
FindItemIndexByPoint(const APoint: TPointF; out AItemIndex: Integer): Boolean
Поиск порядкового индекса элемента по координатам точки в CollectionView, попадающая в один из видимых элементов. Работает только для видимых элементов с индексами в диапазоне GetFirstVisibleItemIndex и GetLastVisibleItemIndex . APoint указывается в системе координат контрола с учетом смещения прокрутки. |
function
|
FindItemIndexByObject(const AObject: TObject; out AItemIndex: Integer): Boolean
Поиск порядкового индекса элемента по объекту, который принадлежит стилю элемента (по цепочке родителей можно выйти к стилю элемента). |
function
|
FindItemWrapperByIndex(const AItemIndex: Integer; out AItemWrapper: TfgItemWrapper): Boolean
Ищет TfgItemWrapper для работы с контролом элемента по индексу. Если элемента по указанному индексу нет, то в AItemWrapper будет nil. |
function
|
FindItemControlByIndex(const AItemIndex: Integer; out AControl: TfgControl): Boolean
Ищет контрол TfgControl элемента по индексу. Если элемента по указанному индексу нет, то в AControl будет nil. |
function
|
GetFirstVisibleItemIndex(): Integer
Возвращает индекс первого видимого элемента на экране. |
function
|
GetLastVisibleItemIndex(): Integer
Возвращает индекс последнего видимого элемента на экране. |
function
|
CreateStyle(): TfgCollectionViewStyle
Создает новый пустой стиль с уникальным именем TfgCollectionViewStyle.TfgStyleName . |
procedure
|
AddStyle(const AStyle: TfgCollectionViewStyle)
Добавляет стиль в список стилей контрола. |
function
|
GetStyle(const AStyleName: string): TfgCollectionViewStyle
Возвращает стиль по его имени. |
function
|
GetStyleIndex(const AStyleName: string): Integer
Возвращает индекс стиля по его имени. Первый стиль имеет индекс 0. |
function
|
GetStyleForItemIndex(const AItemIndex: Integer): TfgCollectionViewStyle
Возвращает стиль элемента по указанному индексу элемента. |
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
Режим выделения элементов. Всего существует три способа выделения: Режим выделения элементов. Всего существует три способа выделения: |
События
event
|
OnGetItemCount: Integer
Через это событие компонент запрашивает общее количество элементов, которые необходимо отобразить. |
event
|
OnGetItemId: TfgOnGetItemId
Через это событие компонент запрашивает уникальный идентификатор элемента. Эта информация может использоваться контролом для визуального выделения изменения элементов на экране при обновлении списка. По мимо этот идентификтор используется для корректного выделения элементов в случае, когда пользователь меняет данные элементов, добавляет или удаляет их. |
event
|
OnGetItemStyle: string
Через это событие компонент запрашивает название стиля, которое необходимо применить к элементу по указанному индексу. |
event
|
OnBindItem: TfgOnBindItem
Через это событие происходит связь пользовательских данных с конкретным элементом списка по указанному индексу. |
event
|
OnTapItem: TfgOnItemTap
Пользователь нажал на элемент списка. |
event
|
OnSelectionChanged: TfgOnSelectionChangedEvent
Пользователь совершил выделение одного или нескольких элементов списка. За возможность выделения элемента отвечает свойство стиля TfgCollectionViewStyle.Selectable . |
event
|
OnItemSelectionChanged: TfgOnItemSelectionChanged
Изменилось выделение у элемента с индексом AItemIndex . |
event
|
OnScroll: TfgOnScrollEvent
Срабатывает, когда содержимое списка прокручивается. |
event
|
OnPullToRefresh: TNotifyEvent
Срабатывает, когда пользователь запускает процесс обновления списка. Чтобы это событие работало, нужно обязательно включить поддержку режима обновления данных EnabledPullToRefresh = True . |
Константы
const
|
DefaultScrollGlowColor: TAlphaColor
|
const
|
DefaultSelectionMode: TfgCollectionViewSelectionMode
|
const
|
DefaultSelectionColor: TAlphaColor
|