程序包 ohos.agp.components

类 PageSliderProvider

java.lang.Object

ohos.agp.components.PageSliderProvider

public abstract class PageSliderProvider
extends Object

Provides the page adapter to manage page components.

This class provides the page item management functions, such as calculating the number of available components and creating a component at a specified position. You need to inherit and implement PageSliderProvider to display multiple components on different pages.

从以下版本开始:

3

字段概要

字段

限定符和类型	字段	说明
static int	POSITION_INVALID	Indicates that a page is invalid from a container.
static int	POSITION_REMAIN	Indicates that the position of a page remains unchanged in a container.

构造器概要

构造器

构造器	说明
PageSliderProvider()

方法概要

限定符和类型	方法	说明
void	addDataSubscriber(DataSetSubscriber subscriber)	Adds an subscriber for the current PageSliderProvider.
abstract Object	createPageInContainer(ComponentContainer container, int position)	Creates a page at a specified position.
abstract void	destroyPageFromContainer(ComponentContainer container, int position, Object object)	Destroys a specified page in a container.
abstract int	getCount()	Obtains the number of available components in the current adapter.
int	getPageIndex(Object object)	Obtains the index of an object in a container.
String	getPageTitle(int position)	Obtains the title of a page at a specified position.
abstract boolean	isPageMatchToObject(Component page, Object object)	Checks whether a component is associated with a specific object returned from createPageInContainer(ohos.agp.components.ComponentContainer,int).
void	notifyDataChanged()	Notifies the page slider provider of a data set change.
void	onUpdateFinished(ComponentContainer componentContainer)	Notifies a container that a page update is finished.
void	removeDataSubscriber(DataSetSubscriber subscriber)	Unregisters an subscriber from the current PageSliderProvider.
void	startUpdate(ComponentContainer container)	Receives a notification indicating that an update on the displayed page is about to occur.

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

POSITION_INVALID

public static final int POSITION_INVALID

Indicates that a page is invalid from a container.

另请参阅:

常量字段值

POSITION_REMAIN

public static final int POSITION_REMAIN

Indicates that the position of a page remains unchanged in a container.

另请参阅:

常量字段值

构造器详细资料

PageSliderProvider

public PageSliderProvider()

方法详细资料

getCount

public abstract int getCount()

Obtains the number of available components in the current adapter.

返回:

Returns the number of available components.

createPageInContainer

public abstract Object createPageInContainer(ComponentContainer container,
                                             int position)

Creates a page at a specified position.

The page is added to the specified position in a container.

参数:

container - Indicates the container to display PageSliderProvider.

position - Indicates the specified position in the container.

返回:

Returns the displayed page.

destroyPageFromContainer

public abstract void destroyPageFromContainer(ComponentContainer container,
                                              int position,
                                              Object object)

Destroys a specified page in a container.

参数:

container - Indicates the container to which the page adapter belongs.

position - Indicates the specified position in the container.

object - Indicates the page to be destroyed.

isPageMatchToObject

public abstract boolean isPageMatchToObject(Component page,
                                            Object object)

Checks whether a component is associated with a specific object returned from createPageInContainer(ohos.agp.components.ComponentContainer,int).

参数:

page - Indicates Component to be checked.

object - Indicates the object associated with component to be checked.

返回:

Whether the component is associated with the object.

startUpdate

public void startUpdate(ComponentContainer container)

Receives a notification indicating that an update on the displayed page is about to occur.

参数:

container - Indicates ComponentContainer to which the page adapter belongs.

onUpdateFinished

public void onUpdateFinished(ComponentContainer componentContainer)

Notifies a container that a page update is finished.

When calling this method, you must ensure that all pages have been added to or removed from the container as required.

参数:

componentContainer - Indicates the container to which the page adapter belongs.

从以下版本开始:

4

getPageIndex

public int getPageIndex(Object object)

Obtains the index of an object in a container.

参数:

object - Indicates the object used to generate a component.

返回:

Returns the index of the object in the container; returns POSITION_REMAIN if the object index has not changed; returns POSITION_INVALID if the object is absent from the container.

从以下版本开始:

4

notifyDataChanged

public void notifyDataChanged()

Notifies the page slider provider of a data set change.

This method is called when the data to be displayed has changed.

从以下版本开始:

4

addDataSubscriber

public final void addDataSubscriber(DataSetSubscriber subscriber)

Adds an subscriber for the current PageSliderProvider.

The subscriber receives callbacks related to data changes.

参数:

subscriber - Indicates the subscriber.

抛出:

IllegalArgumentException - Throws this exception if the parameter value is null.

IllegalStateException - Throws this exception if the object is already added

从以下版本开始:

4

removeDataSubscriber

public final void removeDataSubscriber(DataSetSubscriber subscriber)

Unregisters an subscriber from the current PageSliderProvider.

参数:

subscriber - Indicates the subscriber to be removed.

抛出:

IllegalArgumentException - Throws this exception if the parameter value is null.

IllegalStateException - Throws this exception if the object is already removed

从以下版本开始:

4

getPageTitle

public String getPageTitle(int position)

Obtains the title of a page at a specified position.

This method can be used for a PageSliderProvider object to obtain the title of a specified page.

参数:

position - Indicates the position of the page in PageSliderProvider.

返回:

Returns the page title.