FGX.PageControl.TfgCustomPageControl

Материал из FGX Native Докуметации
Перейти к навигации Перейти к поиску

Delphi

TfgCustomPageControl = class (TfgControl, IFGXContainer)

TComponent -> TfgControl -> TfgCustomPageControl

Прямые наследники: TfgPageControl

Описание

Контейнер вкладок TfgPage .

Конструкторы

constructor
Create(AOwner: TComponent)

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

Методы

function
GoToNextPage(const AOnlyVisible: Boolean): TfgCustomPage

Выполняет анимированное переключение страницы с текущей на следующую, возвращая выбранную страницу. При этом выбор следующей страницы может осуществляется, как видимой, так и не видимой страницы.

Если следующей страницы нет, то вернет nil.
function
GoToPreviousPage(const AOnlyVisible: Boolean): TfgCustomPage

Выполняет анимированное переключение страницы с текущей на предыдущую, возвращая выбранную страницу. При этом выбор предыдущей страницы может осуществляется, как видимой, так и не видимой страницы.

Если следующей страницы нет, то вернет nil.
function
GoToPage(const APageIndex: Integer): TfgCustomPage

Выполняет анимированное переключение страницы с текущей на видимыею страницу с указанным индексом, возвращая выбранную страницу.

function
HasNextPage(const AOnlyVisible: Boolean): Boolean

Определяет, если ли следующая страница, относительно текущей, которую можно выбрать.

Если ни одно вкладка не выбрана, то выполняет определение с первой вкладки.
function
HasPreviousPage(const AOnlyVisible: Boolean): Boolean

Определяет, если ли предыдущая страница, относительно текущей, которую можно выбрать.

Если ни одно вкладка не выбрана, то выполняет определение с последней вкладки.
function
GetNextPageIndex(const APageIndex: Integer; const AOnlyVisible: Boolean): Integer

Определяет индекс следующей вкладки после APageIndex с учетом видимости вкладок AOnlyVisible .

Если таких вкладок нет, вернет -1.
function
GetPreviousPageIndex(const APageIndex: Integer; const AOnlyVisible: Boolean): Integer

Определяет индекс предыдущей вкладки перед APageIndex с учетом видимости вкладок AOnlyVisible .

Если таких вкладок нет, вернет -1.
function
AddPage(const ATitle: string; const AIconName: TfgAssetName): TfgCustomPage

Добавляет новую вкладку с заголовком ATitle и иконкой по имени AIconName .

Меняет активную вкладку в контроле на добавляемую.
function
IsPageExisted(const APageIndex: Integer): Boolean

Проверяет, существует ли вкладка по указанному индексу APageIndex .

function
DeleteCurrentPage(): Boolean

Удаляет текущую страницу, если она есть.

Возвращает True - если текущая страница была и она удалена. False - если текущей страницы не было.
function
DeletePage(const APage: TfgCustomPage): Boolean

Удаляет страницу контрола по ее инстансу APage .

Не допускается указывать nil. Если страница существует среди страниц контрола и она была удалена, то вернет True.
function
DeletePage(const APageIndex: Integer): Boolean

Удаляет страницу контрола с её содержимым по указанному индексу APageIndex .

Не допускается указывать индекс не существующей страницы.
procedure
Clear()

Удаляет все страницы контрола с их содержимым.

procedure
Changed()

Форсирует вызов событий OnPageSelected и OnChanged .

Используете этот метод, если после программного изменения текущей вкладки, вам необходимо, чтобы данные события были вызваны.

Свойства

property
ActivePage: TfgCustomPage

Активная/выбранная страница ( PageIndex ).

Если ни одна страница не выбрана, вернет nil.
property
PagesCount: Integer

Количество страниц.

property
Pages[const AIndex]: TfgCustomPage

Возвращает страницу по указанному индексу.

Не допускается указывать индекс не существующей страницы.
property
TintColorLink: TfgAssetColorLink

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

property
PageIndex: Integer

Индекс активной/текущей выбранной страницы.

Смена вкладок идет без анимации.
property
SwipeEnabled: Boolean

Можно ли перелистывать страницы пальцем или нет.

property
TabsHeight: Single

Высота вкладок.

Если указано 0, то вкладки будут стандартной высоты, согласно платформе. Если требуется скрыть вкладки, то нужно воспользоваться TabsPosition = Invisible
property
TabsPosition: TfgTabsPosition

Положение вкладок относительно контрола.

property
TintColor: TAlphaColor

Цветовой оттенок вкладки.

property
TintColorName: TfgAssetName

Ресурс цвета оттенка вкладки.

Если указан ресурс цвета, то он имеет более высокий приоритет над TintColor . Поэтому именно он и будет использоваться. Если же в ресурсе цвет не указан (Null) или его нет, то будет использоваться TintColor .
property
TitleTextSettings: TfgPageTitleTextSettings

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

События

event
OnPageSelecting: TfgPageSelectingEvent

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

event
OnChanged: TNotifyEvent

Срабатывает, когда выполнено переключение страницы по окончанию срабатывания всех анимаций смены страниц.

Вызывается только, когда пользователь интерактивно меняет активную вкладку.
event
OnPageSelected: TfgPageSelectedEvent

Срабатывает, когда выполнено переключение страницы по окончанию срабатывания всех анимаций смены страниц. Дополнительно передает индекс выбранной страницы и сам экземпляр страницы.

Константы

const
UndefinedPageIndex: Integer

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

const
DefaultTabsHeight: Integer

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

const
DefaultTabsPosition: TfgTabsPosition

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

const
DefaultTintColor: TAlphaColor

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

const
DefaultSwipeEnabled: Boolean

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