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

Материал из FGX Native Докуметации
Перейти к навигации Перейти к поиску
(summary)
(summary)
 
(не показана 31 промежуточная версия этого же участника)
Строка 1: Строка 1:
 
* [[ FGX.CollectionView.TfgCustomCollectionView | Вверх к родителю: TfgCustomCollectionView ]]
 
* [[ FGX.CollectionView.TfgCustomCollectionView | Вверх к родителю: TfgCustomCollectionView ]]
 +
* [[ FGX.CollectionView | К модулю: FGX.CollectionView ]]
  
 
Delphi
 
Delphi
  
<syntaxhighlight lang="Delphi">TfgCollectionView = class (TfgCustomCollectionView, IFGXContainer)</syntaxhighlight>
+
<syntaxhighlight lang="Delphi">TfgCollectionView = class (TfgCustomCollectionView)</syntaxhighlight>
  
[[System.Classes.TComponent|TComponent]] -> [[FGX.Control.TfgControl|TfgControl]] -> [[FGX.CollectionView.TfgCustomCollectionView|TfgCustomCollectionView]] -> [[FGX.CollectionView.TfgCollectionView|TfgCollectionView]]
+
<p class="class-inheritance"><span class="type-border">[[System.Classes.TComponent|TComponent]]</span> -> <span class="type-border">[[FGX.Controls.TfgControl|TfgControl]]</span> -> <span class="type-border">[[FGX.CollectionView.TfgCustomCollectionView|TfgCustomCollectionView]]</span> -> <span class="type-border">[[FGX.CollectionView.TfgCollectionView|TfgCollectionView]]</span></p>
  
 
== Описание ==
 
== Описание ==
  
 
<span style="color:gray">Описание отсутствует.</span>
 
<span style="color:gray">Описание отсутствует.</span>
 
 
== Свойства ==
 
== Свойства ==
  
 
{| class="wikitable sortable"
 
{| class="wikitable sortable"
 +
|-
 +
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>ColumnsCount: [[Integer]]</code>
 +
<p>Количество столбцов, по которым размещаются элементы списка.</p><small style="color: red"><small>Описание взято от [[FGX.CollectionView.TfgCustomCollectionView.ColumnsCount|ColumnsCount]].</small></small>
 +
|-
 +
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>DragOptions: [[FGX.CollectionView.TfgDragAndDropOptions|TfgDragAndDropOptions]]</code>
 +
<p>Настройки фунционала перетаскивания элементов между собой.</p><small style="color: red"><small>Описание взято от [[FGX.CollectionView.TfgCustomCollectionView.DragOptions|DragOptions]].</small></small>
 
|-
 
|-
 
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>PullToRefreshOptions: [[FGX.CollectionView.TfgPullToRefreshOptions|TfgPullToRefreshOptions]]</code>
 
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>PullToRefreshOptions: [[FGX.CollectionView.TfgPullToRefreshOptions|TfgPullToRefreshOptions]]</code>
<p>Настройки режима обновления списка "Потяни и обнови".</p><br/><small style="color: red"><small>Описание взято от [[FGX.CollectionView.TfgCustomCollectionView.PullToRefreshOptions|PullToRefreshOptions]].</small>
+
<p>Настройки режима обновления списка "Потяни и обнови".</p><small style="color: red"><small>Описание взято от [[FGX.CollectionView.TfgCustomCollectionView.PullToRefreshOptions|PullToRefreshOptions]].</small></small>
 +
|-
 +
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>Padding: [[FGX.Layout.Types.TfgPadding|TfgPadding]]</code>
 +
<p>Внутренние отступы, учитывающиеся при выравнивании элементов.</p><small style="color: red"><small>Описание взято от [[FGX.CollectionView.TfgCustomCollectionView.Padding|Padding]].</small></small>
 
|-
 
|-
 
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>ScrollGlowColor: [[TAlphaColor]]</code>
 
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>ScrollGlowColor: [[TAlphaColor]]</code>
  
<p>Цвет эффекта прокручивания списка, который появляется при попытке прокрутить список за его границы.</p><div class="info">Актуально только для Андроид платформы.</div><br/><small style="color: red"><small>Описание взято от [[FGX.CollectionView.TfgCustomCollectionView.ScrollGlowColor|ScrollGlowColor]].</small>
+
<p>Цвет эффекта прокручивания списка, который появляется при попытке прокрутить список за его границы.</p><div class="info">Актуально только для Андроид платформы.</div><small style="color: red"><small>Описание взято от [[FGX.CollectionView.TfgCustomCollectionView.ScrollGlowColor|ScrollGlowColor]].</small></small>
 
|-
 
|-
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>ScrollGlowColorName: [[.TfgAssetName|TfgAssetName]]</code>
+
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>ScrollGlowColorName: [[TfgAssetName|TfgAssetName]]</code>
 
<span style="color:gray">Описание отсутствует.</span>
 
<span style="color:gray">Описание отсутствует.</span>
 
|-
 
|-
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>SelectionMode: [[.TfgCollectionViewSelectionMode|TfgCollectionViewSelectionMode]]</code>
+
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>SelectionOptions: [[FGX.CollectionView.TfgSelectionOptions|TfgSelectionOptions]]</code>
<p>Режим выделения элементов. Всего существует три способа выделения:</p> <ul><li><b>None</b> - Элементы не поддерживают выделение.</li> <li><b>SingleSelect</b> - Только один элемент может быть выделени. При этом при попытке выделить другой элемент выделение с предыдущего сбрасывается.</li> <li><b>MultiSelect</b> - Поддерживается выделение любого количества элементов.</li></ul><br/><small style="color: red"><small>Описание взято от [[FGX.CollectionView.TfgCustomCollectionView.SelectionMode|SelectionMode]].</small>
+
<p>Настройки выделения.</p><small style="color: red"><small>Описание взято от [[FGX.CollectionView.TfgCustomCollectionView.SelectionOptions|SelectionOptions]].</small></small>
 +
|-
 +
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>SelectionMode: [[FGX.CollectionView.TfgCollectionViewSelectionMode|TfgCollectionViewSelectionMode]]</code>
 +
<p>Режим выделения элементов. Всего существует три способа выделения:</p> <ul><li><b>None</b> - Элементы не поддерживают выделение.</li> <li><b>SingleSelect</b> - Только один элемент может быть выделени. При этом при попытке выделить другой элемент выделение с предыдущего сбрасывается.</li> <li><b>MultiSelect</b> - Поддерживается выделение любого количества элементов.</li></ul><small style="color: red"><small>Описание взято от [[FGX.CollectionView.TfgCustomCollectionView.SelectionMode|SelectionMode]].</small></small>
 
|-
 
|-
 
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>SelectionColor: [[TAlphaColor]]</code>
 
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>SelectionColor: [[TAlphaColor]]</code>
  
<p>Общий цвет выделение элементов по умолчанию. Каждый стиль элемента может переопределить это значение через аналогичное свойство <i>TfgCollectionViewStyle.SelectionColor </i> .</p><div class="info">Если указан цвет <i>TAlphaColorRec.Null </i> , то компонент будет использовать системный цвет для выделения, который зависит от платформы и версии ОС.</div><br/><small style="color: red"><small>Описание взято от [[FGX.CollectionView.TfgCustomCollectionView.SelectionColor|SelectionColor]].</small>
+
<p>Общий цвет выделение элементов по умолчанию. Каждый стиль элемента может переопределить это значение через аналогичное свойство <i>TfgCollectionViewStyle.SelectionColor</i> .</p><div class="info">Если указан цвет <i>TAlphaColorRec.Null</i> , то компонент будет использовать системный цвет для выделения, который зависит от платформы и версии ОС.</div><small style="color: red"><small>Описание взято от [[FGX.CollectionView.TfgCustomCollectionView.SelectionColor|SelectionColor]].</small></small>
 +
|-
 +
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>SelectionColorName: [[TfgAssetName|TfgAssetName]]</code>
 +
<p>Название ресурса цвета выделения элементов в контроле.</p><small style="color: red"><small>Описание взято от [[FGX.CollectionView.TfgCustomCollectionView.SelectionColorName|SelectionColorName]].</small></small>
 
|-
 
|-
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>SelectionColorName: [[.TfgAssetName|TfgAssetName]]</code>
+
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>HorzScrollBar: [[FGX.Types.Scroll.TfgScrollBarSettings|TfgScrollBarSettings]]</code>
<p>Название ресурса цвета выделения элементов в контроле.</p><br/><small style="color: red"><small>Описание взято от [[FGX.CollectionView.TfgCustomCollectionView.SelectionColorName|SelectionColorName]].</small>
+
<p>Настройки отображения горизонтальной полосы прокрутки.</p><small style="color: red"><small>Описание взято от [[FGX.CollectionView.TfgCustomCollectionView.HorzScrollBar|HorzScrollBar]].</small></small>
 
|-
 
|-
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>Alignment: [[FGX.Control.Types.TfgControlAlignment|TfgControlAlignment]]</code>
+
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>VertScrollBar: [[FGX.Types.Scroll.TfgScrollBarSettings|TfgScrollBarSettings]]</code>
<p>Настройки выравнивания контрола в рамках родителя.</p><br/><small style="color: red"><small>Описание взято от [[FGX.Control.TfgControl.Alignment|Alignment]].</small>
+
<p>Настройки отображения вертикальной полосы прокрутки.</p><small style="color: red"><small>Описание взято от [[FGX.CollectionView.TfgCustomCollectionView.VertScrollBar|VertScrollBar]].</small></small>
 +
|-
 +
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>Alignment: [[FGX.Controls.Types.TfgControlAlignment|TfgControlAlignment]]</code>
 +
<p>Настройки выравнивания контрола в рамках родителя.</p><small style="color: red"><small>Описание взято от [[FGX.Controls.TfgControl.Alignment|Alignment]].</small></small>
 
|-
 
|-
 
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>AlignWithMargins: [[Boolean]]</code>
 
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>AlignWithMargins: [[Boolean]]</code>
<p>Нужно ли использовать заданные внешние отступы <i>Margins </i> .</p><br/><small style="color: red"><small>Описание взято от [[FGX.Control.TfgControl.AlignWithMargins|AlignWithMargins]].</small>
+
<p>Нужно ли использовать заданные внешние отступы <i>Margins</i> .</p><small style="color: red"><small>Описание взято от [[FGX.Controls.TfgControl.AlignWithMargins|AlignWithMargins]].</small></small>
 
|-
 
|-
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>BackgroundName: [[.TfgAssetName|TfgAssetName]]</code>
+
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>BackgroundName: [[TfgAssetName|TfgAssetName]]</code>
<p>Настройки отображения заднего фона контрола.</p><br/><small style="color: red"><small>Описание взято от [[FGX.Control.TfgControl.BackgroundName|BackgroundName]].</small>
+
<p>Настройки отображения заднего фона контрола.</p><small style="color: red"><small>Описание взято от [[FGX.Controls.TfgControl.BackgroundName|BackgroundName]].</small></small>
 +
|-
 +
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>Enabled: [[Boolean]]</code>
 +
<p>Настройка отключения реакции на воздействия пользователя на компонент.</p><small style="color: red"><small>Описание взято от [[FGX.Controls.TfgControl.Enabled|Enabled]].</small></small>
 
|-
 
|-
 
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>Locked: [[Boolean]]</code>
 
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>Locked: [[Boolean]]</code>
<p>Позволяет заблокировать выделение компонента мышкой в дизайн тайме.</p><br/><small style="color: red"><small>Описание взято от [[FGX.Control.TfgControl.Locked|Locked]].</small>
+
<p>Позволяет заблокировать выделение компонента мышкой в дизайн тайме.</p><small style="color: red"><small>Описание взято от [[FGX.Controls.TfgControl.Locked|Locked]].</small></small>
 
|-
 
|-
 
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>LookupName: [[string]]</code>
 
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>LookupName: [[string]]</code>
<p>Идентификатор, используемый для поиска данного контрола среди других. Актуально для ситуаций, когда несколько контролов могут иметь одно и тоже имя для поиска и нам нужно найти данный контрол в определенной части поддерева.</p><br/><small style="color: red"><small>Описание взято от [[FGX.Control.TfgControl.LookupName|LookupName]].</small>
+
<p>Идентификатор, используемый для поиска данного контрола среди других. Актуально для ситуаций, когда несколько контролов могут иметь одно и тоже имя для поиска и нам нужно найти данный контрол в определенной части поддерева.</p><small style="color: red"><small>Описание взято от [[FGX.Controls.TfgControl.LookupName|LookupName]].</small></small>
 
|-
 
|-
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>PositionMode: [[.TfgPositionMode|TfgPositionMode]]</code>
+
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>PositionMode: [[FGX.Controls.Types.TfgPositionMode|TfgPositionMode]]</code>
<p>Режим позиционирования контрола в рамках родителя (в абсолютных координатах / относительно).</p><br/><small style="color: red"><small>Описание взято от [[FGX.Control.TfgControl.PositionMode|PositionMode]].</small>
+
<p>Режим позиционирования контрола в рамках родителя (в абсолютных координатах / относительно).</p><small style="color: red"><small>Описание взято от [[FGX.Controls.TfgControl.PositionMode|PositionMode]].</small></small>
 
|-
 
|-
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>Position: [[FGX.Control.Types.TfgPosition|TfgPosition]]</code>
+
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>Position: [[FGX.Controls.Types.TfgPosition|TfgPosition]]</code>
<p>Позиция контрола в локальных логических координатах родителя <i>Parent </i> .</p><br/><small style="color: red"><small>Описание взято от [[FGX.Control.TfgControl.Position|Position]].</small>
+
<p>Позиция контрола в локальных логических координатах родителя <i>Parent</i> .</p><small style="color: red"><small>Описание взято от [[FGX.Controls.TfgControl.Position|Position]].</small></small>
 
|-
 
|-
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>RelativePosition: [[FGX.Control.Types.TfgRelativePosition|TfgRelativePosition]]</code>
+
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>RelativePosition: [[FGX.Controls.Types.TfgRelativePosition|TfgRelativePosition]]</code>
<p>Относительная позиция контролов относительно родителя. Актуально только для <b>PositionMode = Relative</b> .</p><br/><small style="color: red"><small>Описание взято от [[FGX.Control.TfgControl.RelativePosition|RelativePosition]].</small>
+
<p>Относительная позиция контролов относительно родителя. Актуально только для <b>PositionMode = Relative</b> .</p><small style="color: red"><small>Описание взято от [[FGX.Controls.TfgControl.RelativePosition|RelativePosition]].</small></small>
 
|-
 
|-
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>Size: [[FGX.Control.Types.TfgSize|TfgSize]]</code>
+
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>Size: [[FGX.Controls.Types.TfgSize|TfgSize]]</code>
<p>Размер контрола в логических координатах.</p><br/><small style="color: red"><small>Описание взято от [[FGX.Control.TfgControl.Size|Size]].</small>
+
<p>Размер контрола в логических координатах.</p><small style="color: red"><small>Описание взято от [[FGX.Controls.TfgControl.Size|Size]].</small></small>
 
|-
 
|-
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>Constraints: [[FGX.Control.Types.TfgConstraints|TfgConstraints]]</code>
+
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>Constraints: [[FGX.Controls.Types.TfgConstraints|TfgConstraints]]</code>
<p>Ограничение на размеры контрола.</p><br/><small style="color: red"><small>Описание взято от [[FGX.Control.TfgControl.Constraints|Constraints]].</small>
+
<p>Ограничение на размеры контрола.</p><small style="color: red"><small>Описание взято от [[FGX.Controls.TfgControl.Constraints|Constraints]].</small></small>
 
|-
 
|-
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>Margins: [[FGX.Control.Types.TfgMargins|TfgMargins]]</code>
+
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>Margins: [[FGX.Controls.Types.TfgMargins|TfgMargins]]</code>
<p>Внешние отступы контрола. Используются при выравнивании текущего контрола в рамках контейнера.</p><br/><small style="color: red"><small>Описание взято от [[FGX.Control.TfgControl.Margins|Margins]].</small>
+
<p>Внешние отступы контрола. Используются при выравнивании текущего контрола в рамках контейнера.</p><small style="color: red"><small>Описание взято от [[FGX.Controls.TfgControl.Margins|Margins]].</small></small>
 
|-
 
|-
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>GestureKinds: [[.TfgGestureKinds|TfgGestureKinds]]</code>
+
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>GestureKinds: [[FGX.Controls.TfgGestureKinds|TfgGestureKinds]]</code>
<p>Виды поддерживаемых жестов.</p><br/><small style="color: red"><small>Описание взято от [[FGX.Control.TfgControl.GestureKinds|GestureKinds]].</small>
+
<p>Виды поддерживаемых жестов.</p><small style="color: red"><small>Описание взято от [[FGX.Controls.TfgControl.GestureKinds|GestureKinds]].</small></small>
 
|-
 
|-
 
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>HitTest: [[Boolean]]</code>
 
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>HitTest: [[Boolean]]</code>
Строка 75: Строка 96:
 
|-
 
|-
 
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>Opacity: [[Single]]</code>
 
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>Opacity: [[Single]]</code>
<p>Прозрачность контрола.</p><br/><small style="color: red"><small>Описание взято от [[FGX.Control.TfgControl.Opacity|Opacity]].</small>
+
<p>Прозрачность контрола.</p><small style="color: red"><small>Описание взято от [[FGX.Controls.TfgControl.Opacity|Opacity]].</small></small>
 
|-
 
|-
 
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>Visible: [[Boolean]]</code>
 
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>Visible: [[Boolean]]</code>
<p>Видимость контрола.</p><br/><small style="color: red"><small>Описание взято от [[FGX.Control.TfgControl.Visible|Visible]].</small>
+
<p>Видимость контрола.</p><small style="color: red"><small>Описание взято от [[FGX.Controls.TfgControl.Visible|Visible]].</small></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></small>
 +
|-
 +
| <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnGetItemId: [[TfgGetItemIdEvent|TfgGetItemIdEvent]]</code>
 +
 
 +
<p>Через это событие компонент запрашивает уникальный идентификатор элемента. Эта информация может использоваться контролом для визуального выделения изменения элементов на экране при обновлении списка. По мимо этот идентификтор используется для корректного выделения элементов в случае, когда пользователь меняет данные элементов, добавляет или удаляет их.</p><div class="info">Обязательно должен быть уникальным среди идентификаторов всех элементов!</div><small style="color: red"><small>Описание взято от [[FGX.CollectionView.TfgCustomCollectionView.OnGetItemId|OnGetItemId]].</small></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></small>
 +
|-
 +
| <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnBindItem: [[TfgBindItemEvent|TfgBindItemEvent]]</code>
 +
 
 +
<p>Через это событие происходит связь пользовательских данных с конкретным элементом списка по указанному индексу.</p><div class="info">Все необходимые данные для отображения должны быть уже предварительно загружены и приготовлены к отображению. В этом событие необходимо связать готовые данные с конкретными контролами.</div><small style="color: red"><small>Описание взято от [[FGX.CollectionView.TfgCustomCollectionView.OnBindItem|OnBindItem]].</small></small>
 +
|-
 +
| <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnTapItem: [[TfgItemTapEvent|TfgItemTapEvent]]</code>
 +
<p>Пользователь нажал на элемент списка.</p><small style="color: red"><small>Описание взято от [[FGX.CollectionView.TfgCustomCollectionView.OnTapItem|OnTapItem]].</small></small>
 +
|-
 +
| <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnLongTapItem: [[TfgItemLongTapEvent|TfgItemLongTapEvent]]</code>
 +
 
 +
<p>Пользователь выполнил долгое нажатие на элемент списка.</p><div class="info">Данное событие работает автоматически. Не нужно отдельно включать значение <i>LongTap</i> в <i>GestureKinds</i> . Особенностью работы данного события - является события даже если долгое нажатие произведено на вложенный в элемент контрол, перехватывающий LongTap.</div><small style="color: red"><small>Описание взято от [[FGX.CollectionView.TfgCustomCollectionView.OnLongTapItem|OnLongTapItem]].</small></small>
 +
|-
 +
| <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnUpdateItemSelectionAppearance: [[TfgUpdateItemSelectionAppearanceEvent|TfgUpdateItemSelectionAppearanceEvent]]</code>
 +
<p>Необходимо вручную выполнить визуальное отображение/сброс выделение указаного элемента списка. Данное событие вызывается только при режиме <i>SelectionOptions.PaintingMode = Manual</i> .</p><small style="color: red"><small>Описание взято от [[FGX.CollectionView.TfgCustomCollectionView.OnUpdateItemSelectionAppearance|OnUpdateItemSelectionAppearance]].</small></small>
 +
|-
 +
| <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnSelectionChanged: [[TfgSelectionChangedEvent|TfgSelectionChangedEvent]]</code>
 +
<p>Пользователь совершил выделение одного или нескольких элементов списка. За возможность выделения элемента отвечает свойство стиля <i>TfgCollectionViewStyle.Selectable</i> .</p><small style="color: red"><small>Описание взято от [[FGX.CollectionView.TfgCustomCollectionView.OnSelectionChanged|OnSelectionChanged]].</small></small>
 +
|-
 +
| <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnCanItemSelect: [[TfgCanItemSelectEvent|TfgCanItemSelectEvent]]</code>
 +
<p>Запрос разрешения на установку выделения элемента с индексом <i>AItemIndex</i> .</p><small style="color: red"><small>Описание взято от [[FGX.CollectionView.TfgCustomCollectionView.OnCanItemSelect|OnCanItemSelect]].</small></small>
 +
|-
 +
| <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnCanItemDeselect: [[TfgCanItemDeselectEvent|TfgCanItemDeselectEvent]]</code>
 +
<p>Запрос разрешения на снятие выделения элемента с индексом <i>AItemIndex</i> .</p><small style="color: red"><small>Описание взято от [[FGX.CollectionView.TfgCustomCollectionView.OnCanItemDeselect|OnCanItemDeselect]].</small></small>
 +
|-
 +
| <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnItemSelectionChanged: [[TfgItemSelectionChangedEvent|TfgItemSelectionChangedEvent]]</code>
 +
<p>Изменилось выделение у элемента с индексом <i>AItemIndex</i> .</p><small style="color: red"><small>Описание взято от [[FGX.CollectionView.TfgCustomCollectionView.OnItemSelectionChanged|OnItemSelectionChanged]].</small></small>
 +
|-
 +
| <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnScroll: [[TfgScrollEvent|TfgScrollEvent]]</code>
 +
<p>Срабатывает, когда содержимое списка прокручивается.</p><small style="color: red"><small>Описание взято от [[FGX.CollectionView.TfgCustomCollectionView.OnScroll|OnScroll]].</small></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></small>
 +
|-
 +
| <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnMovingItem: [[TfgItemMovingEvent|TfgItemMovingEvent]]</code>
 +
<p>Вызывается по ходу перемещения элемента списка. Позволяет запретить перемещение на позицию другого элемента. Чтобы запретить перемещение элемента на новую позицию, нужнео вернуть в параметре <i>AAllowed = False</i> .</p><small style="color: red"><small>Описание взято от [[FGX.CollectionView.TfgCustomCollectionView.OnMovingItem|OnMovingItem]].</small></small>
 +
|-
 +
| <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnMovedItem: [[TfgItemMovedEvent|TfgItemMovedEvent]]</code>
 +
<p>Вызывается после того, как элемент перемещен на новую позицию списка.</p><small style="color: red"><small>Описание взято от [[FGX.CollectionView.TfgCustomCollectionView.OnMovedItem|OnMovedItem]].</small></small>
 +
|-
 +
| <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnDestroy: [[TNotifyEvent]]</code>
 +
<p>Вызывается перед удалением контрола. А именно перед вызовом деструктора.</p><small style="color: red"><small>Описание взято от [[FGX.Controls.TfgControl.OnDestroy|OnDestroy]].</small></small>
 +
|-
 +
| <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnResized: [[TfgResizedEvent|TfgResizedEvent]]</code>
 +
<p>Вызывается когда контрол изменил свой размерм.</p><small style="color: red"><small>Описание взято от [[FGX.Controls.TfgControl.OnResized|OnResized]].</small></small>
 +
|-
 +
| <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnLongTap: [[TfgLongTapEvent|TfgLongTapEvent]]</code>
 +
<p>Срабатывает, когда пользователь долго нажимает на экран без перемещения пальца по экрану.</p><small style="color: red"><small>Описание взято от [[FGX.Controls.TfgControl.OnLongTap|OnLongTap]].</small></small>
 +
|-
 +
| <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnPositionChanged: [[TfgPositionChangedEvent|TfgPositionChangedEvent]]</code>
 +
<p>Вызывается когда контрол поменял свою позицию.</p><small style="color: red"><small>Описание взято от [[FGX.Controls.TfgControl.OnPositionChanged|OnPositionChanged]].</small></small>
 +
|-
 +
| <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnTouch: [[TfgTouchEvent|TfgTouchEvent]]</code>
 +
<p>Вызывается в момент касания пользователем экрана устройства.</p><small style="color: red"><small>Описание взято от [[FGX.Controls.TfgControl.OnTouch|OnTouch]].</small></small>
 +
|-
 +
| <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnTap: [[TNotifyEvent]]</code>
 +
<p>Срабатывает, когда пользователь коротко нажимает на экран без перемещения пальца по экрану.</p><small style="color: red"><small>Описание взято от [[FGX.Controls.TfgControl.OnTap|OnTap]].</small></small>
 
|}
 
|}

Текущая версия на 17:16, 23 декабря 2022

Delphi

TfgCollectionView = class (TfgCustomCollectionView)

TComponent -> TfgControl -> TfgCustomCollectionView -> TfgCollectionView

Описание

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

Свойства

property
ColumnsCount: Integer

Количество столбцов, по которым размещаются элементы списка.

Описание взято от ColumnsCount.
property
DragOptions: TfgDragAndDropOptions

Настройки фунционала перетаскивания элементов между собой.

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

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

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

Внутренние отступы, учитывающиеся при выравнивании элементов.

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

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

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

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

property
SelectionOptions: TfgSelectionOptions

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

Описание взято от SelectionOptions.
property
SelectionMode: TfgCollectionViewSelectionMode

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

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

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

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

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

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

Настройки отображения горизонтальной полосы прокрутки.

Описание взято от HorzScrollBar.
property
VertScrollBar: TfgScrollBarSettings

Настройки отображения вертикальной полосы прокрутки.

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

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

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

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

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

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

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

Настройка отключения реакции на воздействия пользователя на компонент.

Описание взято от Enabled.
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: TfgGetItemIdEvent

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

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

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

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

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

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

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

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

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

Данное событие работает автоматически. Не нужно отдельно включать значение LongTap в GestureKinds . Особенностью работы данного события - является события даже если долгое нажатие произведено на вложенный в элемент контрол, перехватывающий LongTap.
Описание взято от OnLongTapItem.
event
OnUpdateItemSelectionAppearance: TfgUpdateItemSelectionAppearanceEvent

Необходимо вручную выполнить визуальное отображение/сброс выделение указаного элемента списка. Данное событие вызывается только при режиме SelectionOptions.PaintingMode = Manual .

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

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

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

Запрос разрешения на установку выделения элемента с индексом AItemIndex .

Описание взято от OnCanItemSelect.
event
OnCanItemDeselect: TfgCanItemDeselectEvent

Запрос разрешения на снятие выделения элемента с индексом AItemIndex .

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

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

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

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

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

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

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

Вызывается по ходу перемещения элемента списка. Позволяет запретить перемещение на позицию другого элемента. Чтобы запретить перемещение элемента на новую позицию, нужнео вернуть в параметре AAllowed = False .

Описание взято от OnMovingItem.
event
OnMovedItem: TfgItemMovedEvent

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

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

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

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

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

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

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

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

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

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

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

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

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

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