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

Материал из FGX Native Докуметации
Перейти к навигации Перейти к поиску
(summary)
(summary)
Строка 80: Строка 80:
 
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>Visible: [[Boolean]]</code>
 
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>Visible: [[Boolean]]</code>
 
<p>Видимость контрола.</p><small style="color: red"><small>Описание взято от [[FGX.Control.TfgControl.Visible|Visible]].</small>
 
<p>Видимость контрола.</p><small style="color: red"><small>Описание взято от [[FGX.Control.TfgControl.Visible|Visible]].</small>
 +
|}
 +
 +
== События ==
 +
 +
{| class="wikitable sortable"
 +
|-
 +
| <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnGetItemCount: [[Integer]]</code>
 +
 +
<p>Через это событие компонент запрашивает общее количество элементов, которые необходимо отобразить.</p><div class="info">Компонент постоянно использует это событие для получения количества элементов. Поэтому избегайте практики долгого вычисления количества. Это может сказать на скорости прокрутки списка.</div><small style="color: red"><small>Описание взято от [[FGX.CollectionView.TfgCustomCollectionView.OnGetItemCount|OnGetItemCount]].</small>
 +
|-
 +
| <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnGetItemId: [[TfgOnGetItemId]]</code>
 +
 +
<p>Через это событие компонент запрашивает уникальный идентификатор элемента. Эта информация может использоваться контролом для визуального выделения изменения элементов на экране при обновлении списка. По мимо этот идентификтор используется для корректного выделения элементов в случае, когда пользователь меняет данные элементов, добавляет или удаляет их.</p><div class="info">Обязательно должен быть уникальным среди идентификаторов всех элементов!</div><small style="color: red"><small>Описание взято от [[FGX.CollectionView.TfgCustomCollectionView.OnGetItemId|OnGetItemId]].</small>
 +
|-
 +
| <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnGetItemStyle: [[string]]</code>
 +
 +
<p>Через это событие компонент запрашивает название стиля, которое необходимо применить к элементу по указанному индексу.</p><div class="info">Компонент использует это событие в момент, когда указанный элемент готовится появится на экране. Обратите внимание, что если у вас в коллекции используется только один стиль, то это событие можно не использовать. Компонент автоматически выберет первый стиль, если вы не используете это событие.</div><small style="color: red"><small>Описание взято от [[FGX.CollectionView.TfgCustomCollectionView.OnGetItemStyle|OnGetItemStyle]].</small>
 +
|-
 +
| <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnBindItem: [[TfgOnBindItem]]</code>
 +
 +
<p>Через это событие происходит связь пользовательских данных с конкретным элементом списка по указанному индексу.</p><div class="info">Все необходимые данные для отображения должны быть уже предварительно загружены и приготовлены к отображению. В этом событие необходимо связать готовые данные с конкретными контролами.</div><small style="color: red"><small>Описание взято от [[FGX.CollectionView.TfgCustomCollectionView.OnBindItem|OnBindItem]].</small>
 +
|-
 +
| <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnTapItem: [[TfgOnItemTap]]</code>
 +
<p>Пользователь нажал на элемент списка.</p><small style="color: red"><small>Описание взято от [[FGX.CollectionView.TfgCustomCollectionView.OnTapItem|OnTapItem]].</small>
 +
|-
 +
| <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnSelectionChanged: [[TfgOnSelectionChangedEvent]]</code>
 +
<p>Пользователь совершил выделение одного или нескольких элементов списка. За возможность выделения элемента отвечает свойство стиля <i>TfgCollectionViewStyle.Selectable</i> .</p><small style="color: red"><small>Описание взято от [[FGX.CollectionView.TfgCustomCollectionView.OnSelectionChanged|OnSelectionChanged]].</small>
 +
|-
 +
| <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnItemSelectionChanged: [[TfgOnItemSelectionChanged]]</code>
 +
<p>Изменилось выделение у элемента с индексом <i>AItemIndex</i> .</p><small style="color: red"><small>Описание взято от [[FGX.CollectionView.TfgCustomCollectionView.OnItemSelectionChanged|OnItemSelectionChanged]].</small>
 +
|-
 +
| <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnScroll: [[TfgOnScrollEvent]]</code>
 +
<p>Срабатывает, когда содержимое списка прокручивается.</p><small style="color: red"><small>Описание взято от [[FGX.CollectionView.TfgCustomCollectionView.OnScroll|OnScroll]].</small>
 +
|-
 +
| <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnPullToRefresh: [[TNotifyEvent]]</code>
 +
<p>Срабатывает, когда пользователь запускает процесс обновления списка. Чтобы это событие работало, нужно обязательно включить поддержку режима обновления данных <i>EnabledPullToRefresh = True</i> .</p><small style="color: red"><small>Описание взято от [[FGX.CollectionView.TfgCustomCollectionView.OnPullToRefresh|OnPullToRefresh]].</small>
 +
|-
 +
| <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnDestroy: [[TNotifyEvent]]</code>
 +
<p>Вызывается перед удалением контрола. А именно перед вызовом деструктора.</p><small style="color: red"><small>Описание взято от [[FGX.Control.TfgControl.OnDestroy|OnDestroy]].</small>
 +
|-
 +
| <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnResized: [[TfgResizedEvent]]</code>
 +
<p>Вызывается когда контрол изменил свой размерм.</p><small style="color: red"><small>Описание взято от [[FGX.Control.TfgControl.OnResized|OnResized]].</small>
 +
|-
 +
| <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnPaint: [[TfgPaintEvent]]</code>
 +
<p>Вызывается после отрисовки нативного контрола. Служит для выполнения пользовательской отрисовки поверх контрола.</p><small style="color: red"><small>Описание взято от [[FGX.Control.TfgControl.OnPaint|OnPaint]].</small>
 +
|-
 +
| <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnLongTap: [[TfgLongTapEvent]]</code>
 +
<p>Срабатывает, когда пользователь долго нажимает на экран без перемещения пальца по экрану.</p><small style="color: red"><small>Описание взято от [[FGX.Control.TfgControl.OnLongTap|OnLongTap]].</small>
 +
|-
 +
| <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnPositionChanged: [[TfgPositionChangedEvent]]</code>
 +
<p>Вызывается когда контрол поменял свою позицию.</p><small style="color: red"><small>Описание взято от [[FGX.Control.TfgControl.OnPositionChanged|OnPositionChanged]].</small>
 +
|-
 +
| <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnTouch: [[Boolean]]</code>
 +
<p>Вызывается в момент касания пользователем экрана устройства.</p><small style="color: red"><small>Описание взято от [[FGX.Control.TfgControl.OnTouch|OnTouch]].</small>
 +
|-
 +
| <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnTap: [[TNotifyEvent]]</code>
 +
<p>Срабатывает, когда пользователь коротко нажимает на экран без перемещения пальца по экрану.</p><small style="color: red"><small>Описание взято от [[FGX.Control.TfgControl.OnTap|OnTap]].</small>
 
|}
 
|}

Версия 00:39, 13 июня 2019

Delphi

TfgCollectionView = class (TfgCustomCollectionView)

TComponent -> TfgControl -> TfgCustomCollectionView -> TfgCollectionView

Описание

Описание отсутствует.

Свойства

property
PullToRefreshOptions: TfgPullToRefreshOptions

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

Описание взято от PullToRefreshOptions.
property
ScrollGlowColor: TAlphaColor

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

Актуально только для Андроид платформы.
Описание взято от ScrollGlowColor.
property
ScrollGlowColorName: TfgAssetName

Описание отсутствует.

property
SelectionMode: TfgCollectionViewSelectionMode

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

  • None - Элементы не поддерживают выделение.
  • SingleSelect - Только один элемент может быть выделени. При этом при попытке выделить другой элемент выделение с предыдущего сбрасывается.
  • MultiSelect - Поддерживается выделение любого количества элементов.
Описание взято от SelectionMode.
property
SelectionColor: TAlphaColor

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

Если указан цвет TAlphaColorRec.Null , то компонент будет использовать системный цвет для выделения, который зависит от платформы и версии ОС.
Описание взято от SelectionColor.
property
SelectionColorName: TfgAssetName

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

Описание взято от SelectionColorName.
property
Alignment: TfgControlAlignment

Настройки выравнивания контрола в рамках родителя.

Описание взято от Alignment.
property
AlignWithMargins: Boolean

Нужно ли использовать заданные внешние отступы Margins .

Описание взято от AlignWithMargins.
property
BackgroundName: TfgAssetName

Настройки отображения заднего фона контрола.

Описание взято от BackgroundName.
property
Locked: Boolean

Позволяет заблокировать выделение компонента мышкой в дизайн тайме.

Описание взято от Locked.
property
LookupName: string

Идентификатор, используемый для поиска данного контрола среди других. Актуально для ситуаций, когда несколько контролов могут иметь одно и тоже имя для поиска и нам нужно найти данный контрол в определенной части поддерева.

Описание взято от LookupName.
property
PositionMode: TfgPositionMode

Режим позиционирования контрола в рамках родителя (в абсолютных координатах / относительно).

Описание взято от PositionMode.
property
Position: TfgPosition

Позиция контрола в локальных логических координатах родителя Parent .

Описание взято от Position.
property
RelativePosition: TfgRelativePosition

Относительная позиция контролов относительно родителя. Актуально только для PositionMode = Relative .

Описание взято от RelativePosition.
property
Size: TfgSize

Размер контрола в логических координатах.

Описание взято от Size.
property
Constraints: TfgConstraints

Ограничение на размеры контрола.

Описание взято от Constraints.
property
Margins: TfgMargins

Внешние отступы контрола. Используются при выравнивании текущего контрола в рамках контейнера.

Описание взято от Margins.
property
GestureKinds: TfgGestureKinds

Виды поддерживаемых жестов.

Описание взято от GestureKinds.
property
HitTest: Boolean

Описание отсутствует.

property
Opacity: Single

Прозрачность контрола.

Описание взято от Opacity.
property
Visible: Boolean

Видимость контрола.

Описание взято от Visible.

События

event
OnGetItemCount: Integer

Через это событие компонент запрашивает общее количество элементов, которые необходимо отобразить.

Компонент постоянно использует это событие для получения количества элементов. Поэтому избегайте практики долгого вычисления количества. Это может сказать на скорости прокрутки списка.
Описание взято от OnGetItemCount.
event
OnGetItemId: TfgOnGetItemId

Через это событие компонент запрашивает уникальный идентификатор элемента. Эта информация может использоваться контролом для визуального выделения изменения элементов на экране при обновлении списка. По мимо этот идентификтор используется для корректного выделения элементов в случае, когда пользователь меняет данные элементов, добавляет или удаляет их.

Обязательно должен быть уникальным среди идентификаторов всех элементов!
Описание взято от OnGetItemId.
event
OnGetItemStyle: string

Через это событие компонент запрашивает название стиля, которое необходимо применить к элементу по указанному индексу.

Компонент использует это событие в момент, когда указанный элемент готовится появится на экране. Обратите внимание, что если у вас в коллекции используется только один стиль, то это событие можно не использовать. Компонент автоматически выберет первый стиль, если вы не используете это событие.
Описание взято от OnGetItemStyle.
event
OnBindItem: TfgOnBindItem

Через это событие происходит связь пользовательских данных с конкретным элементом списка по указанному индексу.

Все необходимые данные для отображения должны быть уже предварительно загружены и приготовлены к отображению. В этом событие необходимо связать готовые данные с конкретными контролами.
Описание взято от OnBindItem.
event
OnTapItem: TfgOnItemTap

Пользователь нажал на элемент списка.

Описание взято от OnTapItem.
event
OnSelectionChanged: TfgOnSelectionChangedEvent

Пользователь совершил выделение одного или нескольких элементов списка. За возможность выделения элемента отвечает свойство стиля TfgCollectionViewStyle.Selectable .

Описание взято от OnSelectionChanged.
event
OnItemSelectionChanged: TfgOnItemSelectionChanged

Изменилось выделение у элемента с индексом AItemIndex .

Описание взято от OnItemSelectionChanged.
event
OnScroll: TfgOnScrollEvent

Срабатывает, когда содержимое списка прокручивается.

Описание взято от OnScroll.
event
OnPullToRefresh: TNotifyEvent

Срабатывает, когда пользователь запускает процесс обновления списка. Чтобы это событие работало, нужно обязательно включить поддержку режима обновления данных EnabledPullToRefresh = True .

Описание взято от OnPullToRefresh.
event
OnDestroy: TNotifyEvent

Вызывается перед удалением контрола. А именно перед вызовом деструктора.

Описание взято от OnDestroy.
event
OnResized: TfgResizedEvent

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

Описание взято от OnResized.
event
OnPaint: TfgPaintEvent

Вызывается после отрисовки нативного контрола. Служит для выполнения пользовательской отрисовки поверх контрола.

Описание взято от OnPaint.
event
OnLongTap: TfgLongTapEvent

Срабатывает, когда пользователь долго нажимает на экран без перемещения пальца по экрану.

Описание взято от OnLongTap.
event
OnPositionChanged: TfgPositionChangedEvent

Вызывается когда контрол поменял свою позицию.

Описание взято от OnPositionChanged.
event
OnTouch: Boolean

Вызывается в момент касания пользователем экрана устройства.

Описание взято от OnTouch.
event
OnTap: TNotifyEvent

Срабатывает, когда пользователь коротко нажимает на экран без перемещения пальца по экрану.

Описание взято от OnTap.