|
|
| Строка 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> |
| | | | |
| | <span class="type-border">[[System.Classes.TComponent|TComponent]]</span> -> <span class="type-border">[[FGX.Control.TfgControl|TfgControl]]</span> -> <span class="type-border">[[FGX.CollectionView.TfgCustomCollectionView|TfgCustomCollectionView]]</span> -> <span class="type-border">[[FGX.CollectionView.TfgCollectionView|TfgCollectionView]]</span> | | <span class="type-border">[[System.Classes.TComponent|TComponent]]</span> -> <span class="type-border">[[FGX.Control.TfgControl|TfgControl]]</span> -> <span class="type-border">[[FGX.CollectionView.TfgCustomCollectionView|TfgCustomCollectionView]]</span> -> <span class="type-border">[[FGX.CollectionView.TfgCollectionView|TfgCollectionView]]</span> |
| − |
| |
| − | == Описание ==
| |
| − |
| |
| − | <span style="color:gray">Описание отсутствует.</span>
| |
| − |
| |
| − | == Свойства ==
| |
| − |
| |
| − | {| class="wikitable sortable"
| |
| − | |-
| |
| − | | <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>PullToRefreshOptions: [[FGX.CollectionView.TfgPullToRefreshOptions|TfgPullToRefreshOptions]]</code>
| |
| − | <p>Настройки режима обновления списка "Потяни и обнови".</p><small style="color: red"><small>Описание взято от [[FGX.CollectionView.TfgCustomCollectionView.PullToRefreshOptions|PullToRefreshOptions]].</small>
| |
| − | |-
| |
| − | | <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>ScrollGlowColor: [[TAlphaColor]]</code>
| |
| − |
| |
| − | <p>Цвет эффекта прокручивания списка, который появляется при попытке прокрутить список за его границы.</p><div class="info">Актуально только для Андроид платформы.</div><small style="color: red"><small>Описание взято от [[FGX.CollectionView.TfgCustomCollectionView.ScrollGlowColor|ScrollGlowColor]].</small>
| |
| − | |-
| |
| − | | <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>ScrollGlowColorName: [[.TfgAssetName|TfgAssetName]]</code>
| |
| − | <span style="color:gray">Описание отсутствует.</span>
| |
| − | |-
| |
| − | | <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>SelectionMode: [[.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>
| |
| − | |-
| |
| − | | <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>SelectionColor: [[TAlphaColor]]</code>
| |
| − |
| |
| − | <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>
| |
| − | |-
| |
| − | | <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>SelectionColorName: [[.TfgAssetName|TfgAssetName]]</code>
| |
| − | <p>Название ресурса цвета выделения элементов в контроле.</p><small style="color: red"><small>Описание взято от [[FGX.CollectionView.TfgCustomCollectionView.SelectionColorName|SelectionColorName]].</small>
| |
| − | |-
| |
| − | | <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>Alignment: [[FGX.Control.Types.TfgControlAlignment|TfgControlAlignment]]</code>
| |
| − | <p>Настройки выравнивания контрола в рамках родителя.</p><small style="color: red"><small>Описание взято от [[FGX.Control.TfgControl.Alignment|Alignment]].</small>
| |
| − | |-
| |
| − | | <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>AlignWithMargins: [[Boolean]]</code>
| |
| − | <p>Нужно ли использовать заданные внешние отступы <i>Margins</i> .</p><small style="color: red"><small>Описание взято от [[FGX.Control.TfgControl.AlignWithMargins|AlignWithMargins]].</small>
| |
| − | |-
| |
| − | | <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>BackgroundName: [[.TfgAssetName|TfgAssetName]]</code>
| |
| − | <p>Настройки отображения заднего фона контрола.</p><small style="color: red"><small>Описание взято от [[FGX.Control.TfgControl.BackgroundName|BackgroundName]].</small>
| |
| − | |-
| |
| − | | <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>Locked: [[Boolean]]</code>
| |
| − | <p>Позволяет заблокировать выделение компонента мышкой в дизайн тайме.</p><small style="color: red"><small>Описание взято от [[FGX.Control.TfgControl.Locked|Locked]].</small>
| |
| − | |-
| |
| − | | <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>LookupName: [[string]]</code>
| |
| − | <p>Идентификатор, используемый для поиска данного контрола среди других. Актуально для ситуаций, когда несколько контролов могут иметь одно и тоже имя для поиска и нам нужно найти данный контрол в определенной части поддерева.</p><small style="color: red"><small>Описание взято от [[FGX.Control.TfgControl.LookupName|LookupName]].</small>
| |
| − | |-
| |
| − | | <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>PositionMode: [[.TfgPositionMode|TfgPositionMode]]</code>
| |
| − | <p>Режим позиционирования контрола в рамках родителя (в абсолютных координатах / относительно).</p><small style="color: red"><small>Описание взято от [[FGX.Control.TfgControl.PositionMode|PositionMode]].</small>
| |
| − | |-
| |
| − | | <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>Position: [[FGX.Control.Types.TfgPosition|TfgPosition]]</code>
| |
| − | <p>Позиция контрола в локальных логических координатах родителя <i>Parent</i> .</p><small style="color: red"><small>Описание взято от [[FGX.Control.TfgControl.Position|Position]].</small>
| |
| − | |-
| |
| − | | <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>RelativePosition: [[FGX.Control.Types.TfgRelativePosition|TfgRelativePosition]]</code>
| |
| − | <p>Относительная позиция контролов относительно родителя. Актуально только для <b>PositionMode = Relative</b> .</p><small style="color: red"><small>Описание взято от [[FGX.Control.TfgControl.RelativePosition|RelativePosition]].</small>
| |
| − | |-
| |
| − | | <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>Size: [[FGX.Control.Types.TfgSize|TfgSize]]</code>
| |
| − | <p>Размер контрола в логических координатах.</p><small style="color: red"><small>Описание взято от [[FGX.Control.TfgControl.Size|Size]].</small>
| |
| − | |-
| |
| − | | <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>Constraints: [[FGX.Control.Types.TfgConstraints|TfgConstraints]]</code>
| |
| − | <p>Ограничение на размеры контрола.</p><small style="color: red"><small>Описание взято от [[FGX.Control.TfgControl.Constraints|Constraints]].</small>
| |
| − | |-
| |
| − | | <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>Margins: [[FGX.Control.Types.TfgMargins|TfgMargins]]</code>
| |
| − | <p>Внешние отступы контрола. Используются при выравнивании текущего контрола в рамках контейнера.</p><small style="color: red"><small>Описание взято от [[FGX.Control.TfgControl.Margins|Margins]].</small>
| |
| − | |-
| |
| − | | <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>GestureKinds: [[.TfgGestureKinds|TfgGestureKinds]]</code>
| |
| − | <p>Виды поддерживаемых жестов.</p><small style="color: red"><small>Описание взято от [[FGX.Control.TfgControl.GestureKinds|GestureKinds]].</small>
| |
| − | |-
| |
| − | | <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>HitTest: [[Boolean]]</code>
| |
| − | <span style="color:gray">Описание отсутствует.</span>
| |
| − | |-
| |
| − | | <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>Opacity: [[Single]]</code>
| |
| − | <p>Прозрачность контрола.</p><small style="color: red"><small>Описание взято от [[FGX.Control.TfgControl.Opacity|Opacity]].</small>
| |
| − | |-
| |
| − | | <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>Visible: [[Boolean]]</code>
| |
| − | <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>
| |
| − | |}
| |
