ProviderFormInfo

java.lang.Object
- ohos.aafwk.ability.ProviderFormInfo

所有已实现的接口:

Sequenceable
```
public class ProviderFormInfo
extends Object
implements Sequenceable
```
Provides methods for the Form provider to set form information such as the content to be displayed on the remote form and the trigger events.
A form displays brief information about a Page ability on the UI of another application and provides basic interactive features.
The following two roles are involved in the presentation of a form depending on who provides or displays the content:
- Provider: Provides the form content to be displayed. The form provider controls the display content, display logic, and component click events triggered on a form.
  - The form provider uses the standard pattern, which allows it to create and manage multiple Form instances uniquely identified by their form ID.
  - A provider can provide display contents for multiple clients.
- Client: Displays the form content. The form client controls the form layout.
  - A client can display the content provided by multiple form providers.
  - Clients display forms on AbilitySlice objects. Only one client can connect to the Form Manager Service on a single AbilitySlice.
  - Clients can use the layout component provided by an AbilitySlice to lay out Form instances displayed on the ability slice.
The typical interaction process for a client to display a form is as follows:
1. The client calls AbilitySlice#acquireForm(Intent, AbilitySlice.FormCallback) to send a request to the Form Manager Service through the form framework to request the form to be displayed.
2. The Form Manager Service calls Ability#onCreateForm(Intent) on the form provider to notify the form provider to create a Form instance. When creating a Form instance, specify the form name and grid style in an Intent object. You can also set attributes of components and register a listener for click events.
3. The form framework calls AbilitySlice.FormCallback#onAcquired(int, Form) on the client to notify the client in an asynchronous way that the form display request has been processed.
4. The client calls Form#getComponent() to obtain the root component of the form, and uses the layout method provided in AbilitySlice to inflate the form content to the layout of the client.
The form provider provides the following functions:
- Creating a form: After the client calls AbilitySlice#acquireForm(Intent, AbilitySlice.FormCallback), the form framework then calls Ability#onCreateForm(Intent) on the form provider to notify the provider to create a Form instance.
- Setting the binding data for a JS form: The form provider calls setJsBindingData(ohos.aafwk.ability.FormBindingData) to set the values of variables in the JavaScript code for a JS form.
- Setting the layout for a Java form: The form provider calls methods defined in ComponentProvider to set the layout and click events for a form, and uses mergeActions(ohos.agp.components.ComponentProvider) to merge the specified actions to the created form.
- Updating a form: The form framework calls Ability#onUpdateForm(int) on the form provider to notify the form provider to update a Form instance. The form provider then obtains the latest form data and calls Ability#updateForm(int, FormBindingData) or Ability#updateForm(int, ComponentProvider) to update a JS form or Java form, respectively.
- Deleting a form: The form framework calls Ability#onDeleteForm(int) on the form provider to notify the form provider to delete a Form instance. The form provider then deletes the persistent form instance data.
- Triggering a JS form event: The form framework calls Ability#onTriggerFormEvent(int, String) on the form provider to notify the form provider that a JS form event has been triggered. This callback must be overridden to perform operations after the specified event is triggered.
从以下版本开始:

5

SystemCapability

SystemCapability.Aafwk#ABILITY

嵌套类概要
- 从接口继承的嵌套类/接口 ohos.utils.Sequenceable
  Sequenceable.Producer<T>

字段概要

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

static Sequenceable.Producer<ProviderFormInfo> PRODUCER
Creates a ProviderFormInfo object from a Parcel object.

字段
限定符和类型	字段	说明
`static Sequenceable.Producer<ProviderFormInfo>`	`PRODUCER`	Creates a `ProviderFormInfo` object from a `Parcel` object.

构造器概要

构造器
构造器	说明
`ProviderFormInfo()`	A constructor used to create a `ProviderFormInfo` instance for a JS form.
`ProviderFormInfo(int resId, Context context)`	A constructor used to create a `ProviderFormInfo` instance for a Java form.

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法	说明
`static ProviderFormInfo`	`createFromParcel(Parcel parcel)`	Creates a `ProviderFormInfo` object from a specified `Parcel` object.
`ComponentProvider`	`getComponentProvider()`	Obtains the `ComponentProvider` data contained in this `ProviderFormInfo` object.
`FormBindingData`	`getJsBindingData()`	Obtains the binding data of the JS form.
`boolean`	`isJsForm()`	Checks whether this form is a JS form.
`boolean`	`marshalling(Parcel out)`	Marshals this `ProviderFormInfo` object into a `Parcel` object.
`void`	`mergeActions(ComponentProvider componentProviderActions)`	Merges the actions specified in a `ComponentProvider` into the `ComponentProvider` object contained in this `ProviderFormInfo` object.
`void`	`setJsBindingData(FormBindingData data)`	Sets binding data for the JS form in this `ProviderFormInfo` object.
`boolean`	`unmarshalling(Parcel in)`	Unmarshals this `ProviderFormInfo` object from a `Parcel` object.

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

从接口继承的方法 ohos.utils.Sequenceable
hasFileDescriptor

- 字段详细资料
  - PRODUCER
```
public static final Sequenceable.Producer<ProviderFormInfo> PRODUCER
```
    Creates a ProviderFormInfo object from a Parcel object. This constant is used together with marshalling(ohos.utils.Parcel) and is the encapsulation of the unmarshalling(ohos.utils.Parcel) method.
    
    从以下版本开始:
    
    5
- 构造器详细资料
  - ProviderFormInfo
```
public ProviderFormInfo(int resId,
                        Context context)
```
    A constructor used to create a ProviderFormInfo instance for a Java form.
    
    参数:
    
    resId - Indicates the ID of the layout file used in the ProviderFormInfo instance.
    
    context - Indicates the ability context, which is used for initialization.
    
    从以下版本开始:
    
    5
  - ProviderFormInfo
```
public ProviderFormInfo()
```
    A constructor used to create a ProviderFormInfo instance for a JS form.
    
    从以下版本开始:
    
    5
- 方法详细资料
  - createFromParcel
```
public static ProviderFormInfo createFromParcel(Parcel parcel)
```
    Creates a ProviderFormInfo object from a specified Parcel object. This method is used together with Parcel.writeSequenceable(Sequenceable) and is the encapsulation of the Parcel.readSequenceable(Sequenceable) method.
    
    参数:
    
    parcel - Indicates the Parcel object from which data of the new ProviderFormInfo object is read.
    
    返回:
    
    Returns the created ProviderFormInfo object.
    
    从以下版本开始:
    
    5
    
    另请参阅:
    
    Parcel.writeSequenceable(ohos.utils.Sequenceable)
  - getComponentProvider
```
public ComponentProvider getComponentProvider()
```
    Obtains the ComponentProvider data contained in this ProviderFormInfo object.
    
    返回:
    
    Returns the ComponentProvider object.
    
    从以下版本开始:
    
    5
  - marshalling
```
public boolean marshalling(Parcel out)
```
    Marshals this ProviderFormInfo object into a Parcel object.
    
    指定者:
    
    marshalling 在接口中 Sequenceable
    
    参数:
    
    out - Indicates the Parcel object for marshalling.
    
    返回:
    
    Returns true if the marshalling is successful; returns false otherwise.
    
    从以下版本开始:
    
    5
  - unmarshalling
```
public boolean unmarshalling(Parcel in)
```
    Unmarshals this ProviderFormInfo object from a Parcel object.
    
    指定者:
    
    unmarshalling 在接口中 Sequenceable
    
    参数:
    
    in - Indicates the Parcel object for unmarshalling.
    
    返回:
    
    Returns true if the unmarshalling is successful; returns false otherwise.
    
    从以下版本开始:
    
    5
  - mergeActions
```
public void mergeActions(ComponentProvider componentProviderActions)
```
    Merges the actions specified in a ComponentProvider into the ComponentProvider object contained in this ProviderFormInfo object.
    
    参数:
    
    componentProviderActions - Indicates the ComponentProvider object containing the actions to merge.
    
    从以下版本开始:
    
    5
  - getJsBindingData
```
public FormBindingData getJsBindingData()
```
    Obtains the binding data of the JS form.
    
    返回:
    
    Returns the binding data of the JS form.
    
    从以下版本开始:
    
    5
  - setJsBindingData
```
public void setJsBindingData(FormBindingData data)
```
    Sets binding data for the JS form in this ProviderFormInfo object.
    
    参数:
    
    data - Indicates the binding data to set.
    
    从以下版本开始:
    
    5
  - isJsForm
```
public boolean isJsForm()
```
    Checks whether this form is a JS form.
    
    返回:
    
    Returns true if this form is a JS form; returns false otherwise.
    
    从以下版本开始:
    
    5

类 ProviderFormInfo

嵌套类概要

从接口继承的嵌套类/接口 ohos.utils.Sequenceable

字段概要

构造器概要

方法概要

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

从接口继承的方法 ohos.utils.Sequenceable

字段详细资料

PRODUCER

构造器详细资料

ProviderFormInfo

ProviderFormInfo

方法详细资料

createFromParcel

getComponentProvider

marshalling

unmarshalling

mergeActions

getJsBindingData

setJsBindingData

isJsForm