|
|
| Строка 4: |
Строка 4: |
| | | | |
| | <syntaxhighlight lang="Delphi">TfgCustomCollectionView = class (TfgControl, IFGXTapSupported, IFGXNotificationObserver, IFGXNotificationObservable)</syntaxhighlight> | | <syntaxhighlight lang="Delphi">TfgCustomCollectionView = class (TfgControl, IFGXTapSupported, IFGXNotificationObserver, IFGXNotificationObservable)</syntaxhighlight> |
| − |
| |
| − | == Описание ==
| |
| − |
| |
| − | Описание отсутствует.
| |
| − |
| |
| − | == Конструкторы ==
| |
| − |
| |
| − | {| class="wikitable sortable"
| |
| − | |-
| |
| − | | <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 '' .
| |
| − | |}
| |
| − |
| |
| − | == Свойства ==
| |
| − |
| |
| − | {| class="wikitable sortable"
| |
| − | |-
| |
| − | | <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>Count: [[Integer]]</code>
| |
| − | Возвращает общее количество элементов списка. Использует обработчик '' OnGetItemCount '' .
| |
| − | |-
| |
| − | | <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>StylesContainer: [[FGX.CollectionView.TfgCollectionViewStyles|TfgCollectionViewStyles]]</code>
| |
| − | Контейнер стилей, содержит все стили коллекции.
| |
| − | |-
| |
| − | | <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>ContentOffset: [[TPointF]]</code>
| |
| − | Возвращает смещение контента.
| |
| − | |-
| |
| − | | <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>Selection: [[.TfgCollectionViewItemsArray|TfgCollectionViewItemsArray]]</code>
| |
| − | Массив индексов выделенных элементов.
| |
| − | |-
| |
| − | | <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>IsPullToRefreshActive: [[Boolean]]</code>
| |
| − |
| |
| − | |-
| |
| − | | <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>ScrollGlowColorLink: [[FGX.Assets.Color.TfgAssetColorLink|TfgAssetColorLink]]</code>
| |
| − |
| |
| − | |-
| |
| − | | <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>SelectionColorLink: [[FGX.Assets.Color.TfgAssetColorLink|TfgAssetColorLink]]</code>
| |
| − |
| |
| − | |-
| |
| − | | <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>PullToRefreshOptions: [[FGX.CollectionView.TfgPullToRefreshOptions|TfgPullToRefreshOptions]]</code>
| |
| − | Настройки режима обновления списка "Потяни и обнови".
| |
| − | |-
| |
| − | | <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>ScrollGlowColor: [[TAlphaColor]]</code>
| |
| − | Цвет эффекта прокручивания списка, который появляется при попытке прокрутить список за его границы.
| |
| − | |-
| |
| − | | <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>ScrollGlowColorName: [[.TfgAssetName|TfgAssetName]]</code>
| |
| − |
| |
| − | |-
| |
| − | | <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>SelectionColor: [[TAlphaColor]]</code>
| |
| − | Общий цвет выделение элементов по умолчанию. Каждый стиль элемента может переопределить это значение через аналогичное свойство '' TfgCollectionViewStyle.SelectionColor '' .
| |
| − | |-
| |
| − | | <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>SelectionColorName: [[.TfgAssetName|TfgAssetName]]</code>
| |
| − | Название ресурса цвета выделения элементов в контроле.
| |
| − | |-
| |
| − | | <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>SelectionMode: [[.TfgCollectionViewSelectionMode|TfgCollectionViewSelectionMode]]</code>
| |
| − | Режим выделения элементов. Всего существует три способа выделения:
| |
| − |
| |
| − | Режим выделения элементов. Всего существует три способа выделения:
| |
| − | |}
| |
| − |
| |
| − | == События ==
| |
| − |
| |
| − | {| class="wikitable sortable"
| |
| − | |-
| |
| − | | <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnGetItemCount: [[Integer]]</code>
| |
| − | Через это событие компонент запрашивает общее количество элементов, которые необходимо отобразить.
| |
| − | |-
| |
| − | | <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnGetItemId: [[TfgOnGetItemId]]</code>
| |
| − | Через это событие компонент запрашивает уникальный идентификатор элемента. Эта информация может использоваться контролом для визуального выделения изменения элементов на экране при обновлении списка. По мимо этот идентификтор используется для корректного выделения элементов в случае, когда пользователь меняет данные элементов, добавляет или удаляет их.
| |
| − | |-
| |
| − | | <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnGetItemStyle: [[string]]</code>
| |
| − | Через это событие компонент запрашивает название стиля, которое необходимо применить к элементу по указанному индексу.
| |
| − | |-
| |
| − | | <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnBindItem: [[TfgOnBindItem]]</code>
| |
| − | Через это событие происходит связь пользовательских данных с конкретным элементом списка по указанному индексу.
| |
| − | |-
| |
| − | | <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnTapItem: [[TfgOnItemTap]]</code>
| |
| − | Пользователь нажал на элемент списка.
| |
| − | |-
| |
| − | | <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnSelectionChanged: [[TfgOnSelectionChangedEvent]]</code>
| |
| − | Пользователь совершил выделение одного или нескольких элементов списка. За возможность выделения элемента отвечает свойство стиля '' TfgCollectionViewStyle.Selectable '' .
| |
| − | |-
| |
| − | | <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnItemSelectionChanged: [[TfgOnItemSelectionChanged]]</code>
| |
| − | Изменилось выделение у элемента с индексом '' AItemIndex '' .
| |
| − | |-
| |
| − | | <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnScroll: [[TfgOnScrollEvent]]</code>
| |
| − | Срабатывает, когда содержимое списка прокручивается.
| |
| − | |-
| |
| − | | <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnPullToRefresh: [[TNotifyEvent]]</code>
| |
| − | Срабатывает, когда пользователь запускает процесс обновления списка. Чтобы это событие работало, нужно обязательно включить поддержку режима обновления данных '' 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>
| |
| − |
| |
| − | |}
| |
