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

Материал из FGX Native Докуметации
Перейти к навигации Перейти к поиску
(summary)
(summary)
 
(не показано 14 промежуточных версий этого же участника)
Строка 1: Строка 1:
 
* [[ FGX.ScrollBox.TfgCustomScrollBox | Вверх к родителю: TfgCustomScrollBox ]]
 
* [[ FGX.ScrollBox.TfgCustomScrollBox | Вверх к родителю: TfgCustomScrollBox ]]
 +
* [[ FGX.ScrollBox | К модулю: FGX.ScrollBox ]]
  
 
Delphi
 
Delphi
  
−
<syntaxhighlight lang="Delphi">TfgScrollBox = class (TfgCustomScrollBox, IFGXYogaVirtualContent)</syntaxhighlight>
+
<syntaxhighlight lang="Delphi">TfgScrollBox = class (TfgCustomScrollBox)</syntaxhighlight>
 +
 
 +
<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.Layout.TfgCustomLayout|TfgCustomLayout]]</span> -> <span class="type-border">[[FGX.ScrollBox.TfgCustomScrollBox|TfgCustomScrollBox]]</span> -> <span class="type-border">[[FGX.ScrollBox.TfgScrollBox|TfgScrollBox]]</span></p>
 +
 
 +
== Описание ==
 +
 
 +
<span style="color:gray">Описание отсутствует.</span>
 +
== Свойства ==
 +
 
 +
{| class="wikitable sortable"
 +
|-
 +
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>AutoCalculateContentSize: [[Boolean]]</code>
 +
<p>Нужно ли автоматически вычислять размер содержимого или нет. Если указано <i>True</i> , то компонент автоматически рассчитывает размер содержимого, в противном случае - берет его из свойство <i>ContentSize</i> .</p><small style="color: red"><small>Описание взято от [[FGX.ScrollBox.TfgCustomScrollBox.AutoCalculateContentSize|AutoCalculateContentSize]].</small></small>
 +
|-
 +
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>ContentSize: [[FGX.ScrollBox.TfgScrollBoxContentSize|TfgScrollBoxContentSize]]</code>
 +
<p>Требуемый размер контента, работает только когда <i>AutoCalculateContentSize = False</i> .</p><small style="color: red"><small>Описание взято от [[FGX.ScrollBox.TfgCustomScrollBox.ContentSize|ContentSize]].</small></small>
 +
|-
 +
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>ScrollGlowColor: [[TAlphaColor]]</code>
 +
 
 +
<p>Цвет эффекта прокручивания контента, который появляется при попытке прокрутить контент за его границы.</p><div class="info">Актуально только для Андроид платформы.</div><small style="color: red"><small>Описание взято от [[FGX.ScrollBox.TfgCustomScrollBox.ScrollGlowColor|ScrollGlowColor]].</small></small>
 +
|-
 +
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>ScrollGlowColorName: [[TfgAssetName|TfgAssetName]]</code>
 +
<span style="color:gray">Описание отсутствует.</span>
 +
|-
 +
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>HorzScrollBar: [[FGX.Types.Scroll.TfgScrollBarSettings|TfgScrollBarSettings]]</code>
 +
<p>Настройки отображения горизонтальной полосы прокрутки.</p><small style="color: red"><small>Описание взято от [[FGX.ScrollBox.TfgCustomScrollBox.HorzScrollBar|HorzScrollBar]].</small></small>
 +
|-
 +
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>VertScrollBar: [[FGX.Types.Scroll.TfgScrollBarSettings|TfgScrollBarSettings]]</code>
 +
<p>Настройки отображения вертикальной полосы прокрутки.</p><small style="color: red"><small>Описание взято от [[FGX.ScrollBox.TfgCustomScrollBox.VertScrollBar|VertScrollBar]].</small></small>
 +
|-
 +
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>AlignmentChildren: [[FGX.Layout.Types.TfgChildrenAlignment|TfgChildrenAlignment]]</code>
 +
 
 +
<p>Задает правила выравнивания дочерних контролов.</p><div class="info">Влияет только на дочерние контролы, которые используют режим относительного позиционирования <i>PositionMode = TfgPositionMode.Relative</i> .</div><small style="color: red"><small>Описание взято от [[FGX.Layout.TfgCustomLayout.AlignmentChildren|AlignmentChildren]].</small></small>
 +
|-
 +
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>Padding: [[FGX.Layout.Types.TfgPadding|TfgPadding]]</code>
 +
 
 +
<p>Внутренние отступы, учитывающиеся при выравнивании дочерних контролов.</p><div class="info">Влияет только на дочерние контролы, которые используют режим относительного позиционирования <i>PositionMode = TfgPositionMode.Relative</i> .</div><small style="color: red"><small>Описание взято от [[FGX.Layout.TfgCustomLayout.Padding|Padding]].</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>
 +
<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>
 +
<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>
 +
<p>Позволяет заблокировать выделение компонента мышкой в дизайн тайме.</p><small style="color: red"><small>Описание взято от [[FGX.Controls.TfgControl.Locked|Locked]].</small></small>
 +
|-
 +
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>LookupName: [[string]]</code>
 +
<p>Идентификатор, используемый для поиска данного контрола среди других. Актуально для ситуаций, когда несколько контролов могут иметь одно и тоже имя для поиска и нам нужно найти данный контрол в определенной части поддерева.</p><small style="color: red"><small>Описание взято от [[FGX.Controls.TfgControl.LookupName|LookupName]].</small></small>
 +
|-
 +
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>PositionMode: [[FGX.Controls.Types.TfgPositionMode|TfgPositionMode]]</code>
 +
<p>Режим позиционирования контрола в рамках родителя (в абсолютных координатах / относительно).</p><small style="color: red"><small>Описание взято от [[FGX.Controls.TfgControl.PositionMode|PositionMode]].</small></small>
 +
|-
 +
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>Position: [[FGX.Controls.Types.TfgPosition|TfgPosition]]</code>
 +
<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.Controls.Types.TfgRelativePosition|TfgRelativePosition]]</code>
 +
<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.Controls.Types.TfgSize|TfgSize]]</code>
 +
<p>Размер контрола в логических координатах.</p><small style="color: red"><small>Описание взято от [[FGX.Controls.TfgControl.Size|Size]].</small></small>
 +
|-
 +
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>Constraints: [[FGX.Controls.Types.TfgConstraints|TfgConstraints]]</code>
 +
<p>Ограничение на размеры контрола.</p><small style="color: red"><small>Описание взято от [[FGX.Controls.TfgControl.Constraints|Constraints]].</small></small>
 +
|-
 +
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>Margins: [[FGX.Controls.Types.TfgMargins|TfgMargins]]</code>
 +
<p>Внешние отступы контрола. Используются при выравнивании текущего контрола в рамках контейнера.</p><small style="color: red"><small>Описание взято от [[FGX.Controls.TfgControl.Margins|Margins]].</small></small>
 +
|-
 +
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>GestureKinds: [[FGX.Controls.TfgGestureKinds|TfgGestureKinds]]</code>
 +
<p>Виды поддерживаемых жестов.</p><small style="color: red"><small>Описание взято от [[FGX.Controls.TfgControl.GestureKinds|GestureKinds]].</small></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.Controls.TfgControl.Opacity|Opacity]].</small></small>
 +
|-
 +
| <syntaxhighlight lang="Delphi">property</syntaxhighlight> || <code>Visible: [[Boolean]]</code>
 +
<p>Видимость контрола.</p><small style="color: red"><small>Описание взято от [[FGX.Controls.TfgControl.Visible|Visible]].</small></small>
 +
|}
 +
 
 +
== События ==
 +
 
 +
{| class="wikitable sortable"
 +
|-
 +
| <syntaxhighlight lang="Delphi">event</syntaxhighlight> || <code>OnScroll: [[TfgScrollEvent|TfgScrollEvent]]</code>
 +
<span style="color:gray">Описание отсутствует.</span>
 +
|-
 +
| <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:25, 23 декабря 2022

Delphi 

TfgScrollBox = class (TfgCustomScrollBox)

TComponent -> TfgControl -> TfgCustomLayout -> TfgCustomScrollBox -> TfgScrollBox

Описание

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

Свойства

property
AutoCalculateContentSize: Boolean

Нужно ли автоматически вычислять размер содержимого или нет. Если указано True , то компонент автоматически рассчитывает размер содержимого, в противном случае - берет его из свойство ContentSize .

Описание взято от AutoCalculateContentSize. 
property
ContentSize: TfgScrollBoxContentSize

Требуемый размер контента, работает только когда AutoCalculateContentSize = False .

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

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

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

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

property
HorzScrollBar: TfgScrollBarSettings

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

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

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

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

Задает правила выравнивания дочерних контролов.

Влияет только на дочерние контролы, которые используют режим относительного позиционирования PositionMode = TfgPositionMode.Relative .
Описание взято от AlignmentChildren. 
property
Padding: TfgPadding

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

Влияет только на дочерние контролы, которые используют режим относительного позиционирования PositionMode = TfgPositionMode.Relative .
Описание взято от Padding. 
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
OnScroll: TfgScrollEvent

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

event
OnDestroy: TNotifyEvent

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

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

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

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

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

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

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

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

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

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

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

Описание взято от OnTap.
Источник — http://docs.fgx-native.com/index.php?title=FGX.ScrollBox.TfgScrollBox&oldid=28036