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

Материал из FGX Native Докуметации
Перейти к навигации Перейти к поиску
(summary)
(summary)
Строка 15: Строка 15:
 
| <syntaxhighlight lang="Delphi">constructor</syntaxhighlight> || <code>Create(AOwner: [[TComponent]])</code>
 
| <syntaxhighlight lang="Delphi">constructor</syntaxhighlight> || <code>Create(AOwner: [[TComponent]])</code>
  
 +
|}
 +
 +
== Методы ==
 +
 +
{| class="wikitable sortable"
 +
|-
 +
| <syntaxhighlight lang="Delphi">procedure</syntaxhighlight> || <code lang="Delphi">ReloadItems()</code>
 +
Перезагружает элементы коллекции. Форсирует перезагрузку всех элементов списка.
 +
|-
 +
| <syntaxhighlight lang="Delphi">procedure</syntaxhighlight> || <code lang="Delphi">ReloadItem(const AItemIndex: [[Integer]])</code>
 +
Перезагружает элемент коллекции по указанному индексу.
 +
|-
 +
| <syntaxhighlight lang="Delphi">function</syntaxhighlight> || <code lang="Delphi">GetItemId(const AItemIndex: [[Integer]]): [[Int64]]</code>
 +
Возвращает идентификатор элемента по его порядковому индексу. Для этого использует данные, полученные в результате работы обработчика события '' OnGetItemId '' . По умолчанию использует порядковый иднекс элемента.
 +
|-
 +
| <syntaxhighlight lang="Delphi">function</syntaxhighlight> || <code lang="Delphi">FindItemIndexById(const AItemId: [[Int64]]; out AItemIndex: [[Integer]]): [[Boolean]]</code>
 +
Поиск порядкового индекса элемента по его уникальному идентификатору. Задание уникальных идентификаторо элементов осуществляется через событие '' OnGetItemId '' .
 +
|-
 +
| <syntaxhighlight lang="Delphi">function</syntaxhighlight> || <code lang="Delphi">FindItemIndexByPoint(const APoint: [[TPointF]]; out AItemIndex: [[Integer]]): [[Boolean]]</code>
 +
Поиск порядкового индекса элемента по координатам точки в CollectionView, попадающая в один из видимых элементов. Работает только для видимых элементов с индексами в диапазоне '' GetFirstVisibleItemIndex '' и '' GetLastVisibleItemIndex '' . '' APoint '' указывается в системе координат контрола с учетом смещения прокрутки.
 +
|-
 +
| <syntaxhighlight lang="Delphi">function</syntaxhighlight> || <code lang="Delphi">FindItemIndexByObject(const AObject: [[TObject]]; out AItemIndex: [[Integer]]): [[Boolean]]</code>
 +
Поиск порядкового индекса элемента по объекту, который принадлежит стилю элемента (по цепочке родителей можно выйти к стилю элемента).
 +
|-
 +
| <syntaxhighlight lang="Delphi">function</syntaxhighlight> || <code lang="Delphi">FindItemWrapperByIndex(const AItemIndex: [[Integer]]; out AItemWrapper: [[FGX.CollectionView.TfgItemWrapper|TfgItemWrapper]]): [[Boolean]]</code>
 +
Ищет '' TfgItemWrapper '' для работы с контролом элемента по индексу. Если элемента по указанному индексу нет, то в '' AItemWrapper '' будет nil.
 +
|-
 +
| <syntaxhighlight lang="Delphi">function</syntaxhighlight> || <code lang="Delphi">FindItemControlByIndex(const AItemIndex: [[Integer]]; out AControl: [[FGX.Control.TfgControl|TfgControl]]): [[Boolean]]</code>
 +
Ищет контрол '' TfgControl '' элемента по индексу. Если элемента по указанному индексу нет, то в '' AControl '' будет nil.
 +
|-
 +
| <syntaxhighlight lang="Delphi">function</syntaxhighlight> || <code lang="Delphi">GetFirstVisibleItemIndex(): [[Integer]]</code>
 +
Возвращает индекс первого видимого элемента на экране.
 +
|-
 +
| <syntaxhighlight lang="Delphi">function</syntaxhighlight> || <code lang="Delphi">GetLastVisibleItemIndex(): [[Integer]]</code>
 +
Возвращает индекс последнего видимого элемента на экране.
 +
|-
 +
| <syntaxhighlight lang="Delphi">function</syntaxhighlight> || <code lang="Delphi">CreateStyle(): [[FGX.CollectionView.TfgCollectionViewStyle|TfgCollectionViewStyle]]</code>
 +
Создает новый пустой стиль с уникальным именем '' TfgCollectionViewStyle.TfgStyleName '' .
 +
|-
 +
| <syntaxhighlight lang="Delphi">procedure</syntaxhighlight> || <code lang="Delphi">AddStyle(const AStyle: [[FGX.CollectionView.TfgCollectionViewStyle|TfgCollectionViewStyle]])</code>
 +
Добавляет стиль в список стилей контрола.
 +
|-
 +
| <syntaxhighlight lang="Delphi">function</syntaxhighlight> || <code lang="Delphi">GetStyle(const AStyleName: [[string]]): [[FGX.CollectionView.TfgCollectionViewStyle|TfgCollectionViewStyle]]</code>
 +
Возвращает стиль по его имени.
 +
|-
 +
| <syntaxhighlight lang="Delphi">function</syntaxhighlight> || <code lang="Delphi">GetStyleIndex(const AStyleName: [[string]]): [[Integer]]</code>
 +
Возвращает индекс стиля по его имени. Первый стиль имеет индекс 0.
 +
|-
 +
| <syntaxhighlight lang="Delphi">function</syntaxhighlight> || <code lang="Delphi">GetStyleForItemIndex(const AItemIndex: [[Integer]]): [[FGX.CollectionView.TfgCollectionViewStyle|TfgCollectionViewStyle]]</code>
 +
Возвращает стиль элемента по указанному индексу элемента.
 +
|-
 +
| <syntaxhighlight lang="Delphi">procedure</syntaxhighlight> || <code lang="Delphi">ScrollToItem(const AItemIndex: [[Integer]]; const AWithAnimation: [[Boolean]])</code>
 +
 +
|-
 +
| <syntaxhighlight lang="Delphi">procedure</syntaxhighlight> || <code lang="Delphi">ResetSelection()</code>
 +
Сбрасывает текущее выделение всех выделенных элементов.
 +
|-
 +
| <syntaxhighlight lang="Delphi">procedure</syntaxhighlight> || <code lang="Delphi">ResetSelection(const AItemIndex: [[Integer]])</code>
 +
Сбрасывает текущее выделение элемента с указанным индексом.
 +
|-
 +
| <syntaxhighlight lang="Delphi">procedure</syntaxhighlight> || <code lang="Delphi">SelectItem(const AItemIndex: [[Integer]])</code>
 +
Выделяет элемент с указанным индексом.
 +
|-
 +
| <syntaxhighlight lang="Delphi">procedure</syntaxhighlight> || <code lang="Delphi">SelectAllItems()</code>
 +
Выделяет все элементы списка.
 +
|-
 +
| <syntaxhighlight lang="Delphi">procedure</syntaxhighlight> || <code lang="Delphi">BeginPullToRefresh()</code>
 +
Запускает программным способом процесс обновления данных с одновременным отображением индикатора загрузки. Разработчик должен выполнить/запустить процесс обновления данных и по окончании загрузки данных сообщить об этом контролу, вызвав '' EndPullToRefresh '' . Обратите внимание, что для визуального обновления данных, разработчику так же нужно воспользовать одним из методов обновления данных '' ReloadItems '' или '' ReloadItem '' .
 +
|-
 +
| <syntaxhighlight lang="Delphi">procedure</syntaxhighlight> || <code lang="Delphi">EndPullToRefresh()</code>
 +
Заканчивает процесс обновления данных, начатый пользователем. Это приводит к скрытию индикатора загрузки и загрузки данных в список. Обратите внимание, что для визуального обновления данных, разработчику так же нужно воспользовать одним из методов обновления данных '' ReloadItems '' или '' ReloadItem '' .
 
|}
 
|}

Версия 04:30, 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 .

Источник — http://docs.fgx-native.com/index.php?title=FGX.CollectionView.TfgCustomCollectionView&oldid=17021