Provider

java.lang.Object
- ohos.agp.components.listcomponent.Provider<E>

```
public abstract class Provider<E extends ComponentOwner>
extends Object
```
A base class that saves ListComponent data and sets up a relationship between the ComponentOwner and the ListComponent data.

从以下版本开始:

7

字段概要

字段
限定符和类型字段说明

static long INVALID_ID
Indicates an invalid component ID in the ListComponent.

protected long mNativePtr
Obtains the native object.

字段
限定符和类型	字段	说明
`static long`	`INVALID_ID`	Indicates an invalid component ID in the `ListComponent`.
`protected long`	`mNativePtr`	Obtains the native object.

构造器概要

构造器
构造器说明

Provider()
A constructor used to create a Provider instance.

构造器
构造器	说明
`Provider()`	A constructor used to create a `Provider` instance.

方法概要

所有方法实例方法抽象方法具体方法
限定符和类型	方法	说明
`long`	`getComponentId(int position)`	Obtains the unique identifier of the component at the specified position in the provider.
`E`	`getComponentOwner(long componentOwnerPtr)`	Obtains the `ComponentOwner` corresponding to a native pointer.
`Component`	`getItemComponent(long componentPtr)`	Obtains the `Component` corresponding to a native pointer.
`int`	`getItemComponentType(int position)`	Obtains the `componentType` of the component at the specified position in the provider.
`abstract int`	`getItemNumber()`	Obtains the total number of components in the provider.
`long`	`getNativePtr()`	Obtains the native object.
`boolean`	`hasObserversRegistered()`	Checks whether an observer is registered with the provider.
`boolean`	`hasUniqueIdentifier()`	Checks whether each component in the provider has a unique identifier, `ItemId`.
`void`	`notifyDataCollectionChanged()`	Notifies any registered observer that all components in the provider have been updated.
`void`	`notifyInsertedAt(int position)`	Notifies any registered observer that a component has been inserted to the specified position in the provider.
`void`	`notifyPositionMoved(int fromPosition, int toPosition)`	Notifies any registered observer that a component has been moved from one position to another in the provider.
`void`	`notifyRangeInserted(int positionStart, int itemCount)`	Notifies any registered observer that a given number of components have been inserted to the specified position in the provider.
`void`	`notifyRangeRemoved(int positionStart, int itemCount)`	Notifies any registered observer that a given number of components have been removed from the specified position in the provider.
`void`	`notifyRangeUpdated(int positionStart, int itemCount)`	Notifies any registered observer that a given number of components have been updated from the specified position.
`void`	`notifyRangeUpdated(int positionStart, int itemCount, Object crab)`	Notifies any registered observer that a given number of components have been updated from the specified position, with a crab object.
`void`	`notifyRemovedAt(int position)`	Notifies any registered observer that a component has been removed from the specified position in the provider.
`void`	`notifyUpdatedAt(int position)`	Notifies any registered observer that the component at the specified position in the provider has been updated.
`void`	`notifyUpdatedAt(int position, Object crab)`	Notifies any registered observer that the component at the specified position in the provider has been updated with a crab object.
`abstract void`	`onBindComponentOwner(E owner, int position)`	Called when a `ComponentOwner` is bound to a component.
`void`	`onBindComponentOwner(E owner, int position, List<Object> crabs)`	Called when a `ComponentOwner` is bound to a component.
`void`	`onBoundToListComponent(ListComponent listContainer)`	Called when a `ListComponent` is bound to the provider.
`void`	`onComponentBoundToWindow(E owner)`	Called when the component corresponding to the `ComponentOwner` created by the provider is bound to the window.
`void`	`onComponentOwnerToCachePool(E owner)`	Called when the component corresponding to the `ComponentOwner` created by the provider is reclaimed to the `ListComponentPool`.
`void`	`onComponentUnboundFromWindow(E owner)`	Called when the component corresponding to the `ComponentOwner` created by the provider is unbound from the window.
`abstract E`	`onCreateComponentOwner(ListComponent parent, int componentType)`	Called when a `ComponentOwner` is created.
`void`	`onUnboundFromListComponent(ListComponent listContainer)`	Called when a `ListComponent` is unbound from the provider.
`void`	`registerDataObserver(ProviderSubscriber subscriber)`	Registers an observer to observe data changes.
`void`	`setHasUniqueIdentifier(boolean hasUniqueIdentifier)`	Sets whether each component in the data set can be represented by a unique identifier of the type `Long`.
`void`	`unregisterDataObserver(ProviderSubscriber subscriber)`	Unregisters an observer used to observe data changes.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - INVALID_ID
```
public static final long INVALID_ID
```
    Indicates an invalid component ID in the ListComponent.
    
    从以下版本开始:
    
    7
    
    另请参阅:
    
    常量字段值
  - mNativePtr
```
protected long mNativePtr
```
    Obtains the native object.
- 构造器详细资料
  - Provider
```
public Provider()
```
    A constructor used to create a Provider instance.
    
    从以下版本开始:
    
    7
- 方法详细资料
  - onCreateComponentOwner
```
public abstract E onCreateComponentOwner(ListComponent parent,
                                         int componentType)
```
    Called when a ComponentOwner is created.
    You can create a ComponentOwner for the ListComponent based on the specified componentType.
    
    参数:
    
    parent - Indicates the ListComponent to which the new component, after being bound to the provider, will be added.
    
    componentType - Indicates the type of the new component.
    
    返回:
    
    Returns the ComponentOwner.
    
    从以下版本开始:
    
    7
  - getComponentOwner
```
public final E getComponentOwner(long componentOwnerPtr)
```
    Obtains the ComponentOwner corresponding to a native pointer.
    
    参数:
    
    componentOwnerPtr - Indicates the native pointer.
    
    返回:
    
    Returns the ComponentOwner.
    
    从以下版本开始:
    
    7
  - getItemComponent
```
public final Component getItemComponent(long componentPtr)
```
    Obtains the Component corresponding to a native pointer.
    
    参数:
    
    componentPtr - Indicates the native pointer.
    
    返回:
    
    Returns the Component.
    
    从以下版本开始:
    
    7
  - getItemNumber
```
public abstract int getItemNumber()
```
    Obtains the total number of components in the provider.
    
    返回:
    
    Returns the number of components.
    
    从以下版本开始:
    
    7
  - onBindComponentOwner
```
public abstract void onBindComponentOwner(E owner,
                                          int position)
```
    Called when a ComponentOwner is bound to a component.
    You can update the component effect of the ComponentOwner based on the updates to the component at the specified position.
    
    参数:
    
    owner - Indicates the ComponentOwner of the component.
    
    position - Indicates the position of the component in the provider's data set.
    
    从以下版本开始:
    
    7
  - onBindComponentOwner
```
public void onBindComponentOwner(E owner,
                                 int position,
                                 List<Object> crabs)
```
    Called when a ComponentOwner is bound to a component.
    You can update the component effect of the ComponentOwner based on the updates to the component at the specified position. Partial update is supported.
    
    参数:
    
    owner - Indicates the ComponentOwner of the component.
    
    position - Indicates the position of the component in the provider's data set.
    
    crabs - Indicates the crabs. Data from the crabs in Provider#notifyItemChanged(int, Object) or Provider#notifyItemRangeChanged(int, int, Object) is the basis for providing the partial update feature.
    
    从以下版本开始:
    
    7
  - getNativePtr
```
public long getNativePtr()
```
    Obtains the native object.
    
    返回:
    
    Returns the native object.
  - setHasUniqueIdentifier
```
public void setHasUniqueIdentifier(boolean hasUniqueIdentifier)
```
    Sets whether each component in the data set can be represented by a unique identifier of the type Long.
    
    参数:
    
    hasUniqueIdentifier - Specifies whether each component in the data set has a unique identifier. The value true means that each component has a unique identifier, and false means the opposite.
    
    从以下版本开始:
    
    7
  - hasUniqueIdentifier
```
public final boolean hasUniqueIdentifier()
```
    Checks whether each component in the provider has a unique identifier, ItemId.
    
    返回:
    
    Returns true if each component has a unique identifier; returns false otherwise.
    
    从以下版本开始:
    
    7
  - getItemComponentType
```
public int getItemComponentType(int position)
```
    Obtains the componentType of the component at the specified position in the provider.
    
    参数:
    
    position - Indicates the position of the component in the provider.
    
    返回:
    
    Returns the componentType of the component.
    
    从以下版本开始:
    
    7
  - getComponentId
```
public long getComponentId(int position)
```
    Obtains the unique identifier of the component at the specified position in the provider.
    
    参数:
    
    position - Indicates the position of the component in the provider.
    
    返回:
    
    Returns the unique identifier of the component.
    
    从以下版本开始:
    
    7
  - notifyDataCollectionChanged
```
public final void notifyDataCollectionChanged()
```
    Notifies any registered observer that all components in the provider have been updated.
    
    从以下版本开始:
    
    7
  - notifyUpdatedAt
```
public final void notifyUpdatedAt(int position)
```
    Notifies any registered observer that the component at the specified position in the provider has been updated.
    
    参数:
    
    position - Indicates the position of the component that has been updated.
    
    从以下版本开始:
    
    7
  - notifyUpdatedAt
```
public final void notifyUpdatedAt(int position,
                                  Object crab)
```
    Notifies any registered observer that the component at the specified position in the provider has been updated with a crab object.
    
    参数:
    
    position - Indicates the position of the component that has been updated.
    
    crab - Specifies whether it is a partial update. If this parameter is set to null, all the content in ComponentOwner has been updated. If this parameter is not set to null, a partial update is performed on the ComponentOwner, which improves the performance when sliding the ListComponent.
    
    从以下版本开始:
    
    7
  - notifyRangeUpdated
```
public final void notifyRangeUpdated(int positionStart,
                                     int itemCount)
```
    Notifies any registered observer that a given number of components have been updated from the specified position.
    
    参数:
    
    positionStart - Indicates the position of the first component that has been updated.
    
    itemCount - Indicates the number of components that has been updated.
    
    从以下版本开始:
    
    7
  - notifyRangeUpdated
```
public final void notifyRangeUpdated(int positionStart,
                                     int itemCount,
                                     Object crab)
```
    Notifies any registered observer that a given number of components have been updated from the specified position, with a crab object.
    
    参数:
    
    positionStart - Indicates the position of the first component that has been updated.
    
    itemCount - Indicates the number of components that has been updated.
    
    crab - Specifies whether it is a partial update. If this parameter is set to null, all the content in ComponentOwner has been updated. If this parameter is not set to null, a partial update is performed on the ComponentOwner, which improves the performance when sliding the ListComponent.
    
    从以下版本开始:
    
    7
  - notifyInsertedAt
```
public final void notifyInsertedAt(int position)
```
    Notifies any registered observer that a component has been inserted to the specified position in the provider.
    
    参数:
    
    position - Indicates the position of the component that has been inserted.
    
    从以下版本开始:
    
    7
  - notifyRangeInserted
```
public final void notifyRangeInserted(int positionStart,
                                      int itemCount)
```
    Notifies any registered observer that a given number of components have been inserted to the specified position in the provider.
    
    参数:
    
    positionStart - Indicates the position of the first component that has been inserted.
    
    itemCount - Indicates the number of components that have been inserted.
    
    从以下版本开始:
    
    7
  - notifyRemovedAt
```
public final void notifyRemovedAt(int position)
```
    Notifies any registered observer that a component has been removed from the specified position in the provider.
    
    参数:
    
    position - Indicates the position of the component that has been removed.
    
    从以下版本开始:
    
    7
  - notifyRangeRemoved
```
public final void notifyRangeRemoved(int positionStart,
                                     int itemCount)
```
    Notifies any registered observer that a given number of components have been removed from the specified position in the provider.
    
    参数:
    
    positionStart - Indicates the position of the first component that has been removed.
    
    itemCount - Indicates the number of components that have been removed.
    
    从以下版本开始:
    
    7
  - notifyPositionMoved
```
public final void notifyPositionMoved(int fromPosition,
                                      int toPosition)
```
    Notifies any registered observer that a component has been moved from one position to another in the provider.
    
    参数:
    
    fromPosition - Indicates the previous position of the component.
    
    toPosition - Indicates the new position of the component.
    
    从以下版本开始:
    
    7
  - onComponentOwnerToCachePool
```
public void onComponentOwnerToCachePool(E owner)
```
    Called when the component corresponding to the ComponentOwner created by the provider is reclaimed to the ListComponentPool.
    
    参数:
    
    owner - Indicates the ComponentOwner of the component that is reclaimed.
    
    从以下版本开始:
    
    7
  - onComponentBoundToWindow
```
public void onComponentBoundToWindow(E owner)
```
    Called when the component corresponding to the ComponentOwner created by the provider is bound to the window.
    
    参数:
    
    owner - Indicates the ComponentOwner of the component that is bound to the window.
    
    从以下版本开始:
    
    7
  - onComponentUnboundFromWindow
```
public void onComponentUnboundFromWindow(E owner)
```
    Called when the component corresponding to the ComponentOwner created by the provider is unbound from the window.
    
    参数:
    
    owner - Indicates the ComponentOwner of the component that is unbound from the window.
    
    从以下版本开始:
    
    7
  - onBoundToListComponent
```
public void onBoundToListComponent(ListComponent listContainer)
```
    Called when a ListComponent is bound to the provider.
    
    参数:
    
    listComponent - Indicates the ListComponent bound to the provider.
    
    从以下版本开始:
    
    7
  - onUnboundFromListComponent
```
public void onUnboundFromListComponent(ListComponent listContainer)
```
    Called when a ListComponent is unbound from the provider.
    
    参数:
    
    listComponent - Indicates the ListComponent unbound from the provider.
    
    从以下版本开始:
    
    7
  - hasObserversRegistered
```
public final boolean hasObserversRegistered()
```
    Checks whether an observer is registered with the provider.
    
    返回:
    
    Returns true if one or more observers are registered with the provider; returns false otherwise.
    
    从以下版本开始:
    
    7
  - registerDataObserver
```
public void registerDataObserver(ProviderSubscriber subscriber)
```
    Registers an observer to observe data changes.
    
    参数:
    
    subscriber - Indicates the observer to register.
    
    从以下版本开始:
    
    7
  - unregisterDataObserver
```
public void unregisterDataObserver(ProviderSubscriber subscriber)
```
    Unregisters an observer used to observe data changes.
    
    参数:
    
    subscriber - Indicates the observer to unregister.
    
    从以下版本开始:
    
    7

类 Provider<E extends ComponentOwner>

字段概要

构造器概要

方法概要

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

字段详细资料

INVALID_ID

mNativePtr

构造器详细资料

Provider

方法详细资料

onCreateComponentOwner

getComponentOwner

getItemComponent

getItemNumber

onBindComponentOwner

onBindComponentOwner

getNativePtr

setHasUniqueIdentifier

hasUniqueIdentifier

getItemComponentType

getComponentId

notifyDataCollectionChanged

notifyUpdatedAt

notifyUpdatedAt

notifyRangeUpdated

notifyRangeUpdated

notifyInsertedAt

notifyRangeInserted

notifyRemovedAt

notifyRangeRemoved

notifyPositionMoved

onComponentOwnerToCachePool

onComponentBoundToWindow

onComponentUnboundFromWindow

onBoundToListComponent

onUnboundFromListComponent

hasObserversRegistered

registerDataObserver

unregisterDataObserver