AbilityForm

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

所有已实现的接口:

Sequenceable
```
public final class AbilityForm
extends Object
implements Sequenceable
```
Displays brief information about another Ability.
The following two roles are involved in the presentation of an AbilityForm depending on who provides or displays the content:
- Supplier: Provides the AbilityForm content to be displayed. The supplier controls the display content and logic.
  - The supplier uses the singleton pattern.
  - One supplier can provide display contents for multiple clients.
- Client: Displays the AbilityForm content. The client controls the AbilityForm layout.
  - A client can display the content provided by only one supplier.
  - Clients display the AbilityForm on AbilitySlice objects. Multiple clients can display AbilityForm contents on the same AbilitySlice.
  - Clients can use the layout component provided by an AbilitySlice to lay out AbilityForm instances displayed on the ability slice.
The typical interaction process for a client to display an AbilityForm for the first time is as follows:
1. The client calls the AbilitySlice#acquireAbilityFormAsync(Intent, OnAcquiredCallback) method to send an asynchronous request to the supplier through the AbilityForm framework to request the AbilityForm to be displayed.
2. The AbilityForm framework calls back the Ability#onCreateForm() method on the supplier to notify the developer of the supplier to create an AbilityForm instance. You need to provide a layout file when creating an AbilityForm. You can also set attributes of components and register a listener for click events.
3. The AbilityForm framework calls back the OnAcquiredCallback#onAcquired(AbilityForm) method on the client to notify the developer of the client in an asynchronous way that the AbilityForm display request has been processed.
4. The developer of the client calls the AbilityForm#getComponent() method to obtain the root component of the AbilityForm, and uses the layout method provided in AbilitySlice to inflate the AbilityForm content to the layout of the client.
The supplier provides the following functions:
- Creating an AbilityForm: After the developer of the client calls AbilitySlice#acquireAbilityFormAsync(Intent, OnAcquiredCallback) to send an asynchronous request to the supplier through the AbilityForm framework to request the AbilityForm to be displayed, the AbilityForm framework calls back the Ability#onCreateForm() method on the supplier to notify the developer of the supplier to create an AbilityForm instance. You need to provide a layout file when creating an AbilityForm. You can also set attributes of components and register a listener for click events.
- Setting component attributes: The developer of the supplier can set attributes of components on the client by calling methods such as AbilityForm#setText(int, String).
- Setting a click listener: The developer of the supplier can call AbilityForm#registerViewListener(int, ViewListener) to listen for click events of specific components.
The client provides the following functions:
- Obtaining an AbilityForm: The developer of the client calls AbilitySlice#acquireAbilityFormAsync(Intent, OnAcquiredCallback) to send an asynchronous request to the supplier through the AbilityForm framework to request the AbilityForm to be displayed.
- Releasing an AbilityForm: The developer of the client calls AbilitySlice#releaseAbilityForm(AbilityForm) to release an AbilityForm.
- Controlling the AbilityForm layout: The developer of the client calls the getComponent() method to obtain the root component of the AbilityForm, and uses the layout method provided in AbilitySlice to inflate the AbilityForm content to the layout of the client.
- Displaying complete AbilityForm content: The developer of the client calls startFullPage() to display the complete content of an AbilityForm.
从以下版本开始:

1

SystemCapability

SystemCapability.Aafwk#ABILITY

嵌套类概要

嵌套类
限定符和类型	类	说明
`static interface`	`AbilityForm.OnAcquiredCallback`	Provides callback methods that are invoked when an `AbilityForm` instance created by the supplier is obtained or destroyed on the client.

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

字段概要

字段
限定符和类型	字段	说明
`static String`	`PERMISSION_REQUIRE_FORM`	Indicates the permission to obtain an `AbilityForm`.
`static Sequenceable.Producer<AbilityForm>`	`PRODUCER`	Creates a `AbilityForm` instance from a `Parcel`.

构造器概要

构造器
构造器说明

AbilityForm(int resId, Context context)
A constructor used to create an AbilityForm instance on the AbilityForm supplier.

构造器
构造器	说明
`AbilityForm(int resId, Context context)`	A constructor used to create an `AbilityForm` instance on the `AbilityForm` supplier.

方法概要

所有方法实例方法具体方法
限定符和类型	方法	说明
`Component`	`getComponent()`	Obtains the root component of an `AbilityForm` from the supplier.
`Intent`	`getFullPageIntent()`	Obtains the `Intent` for starting full page display.
`boolean`	`marshalling(Parcel out)`	Marshals an `AbilityForm` object into a `Parcel`.
`boolean`	`registerViewListener(int componentId, ViewListener listener)`	Registers a listener by the AbilityForm supplier to listen for click events of a component on the AbilityForm client.
`void`	`sendActions(ComponentProvider remoteComponentActions)`	Sends the supplier's actions configured in the `ComponentProvider` object to the client.
`void`	`setFullPageIntent(Intent intent)`	Sets the `Intent` used for starting full page display.
`void`	`setText(int componentId, String text)`	Sets the text to be displayed for a specific component on the `AbilityForm` supplier.
`void`	`setTextSize(int componentId, int size)`	Sets the font size of a specific component on the `AbilityForm` supplier.
`void`	`startFullPage()`	Switches to full page display of the `AbilityForm` by the AbilityForm client.
`boolean`	`unmarshalling(Parcel in)`	Unmarshals an `AbilityForm` object from a `Parcel`.

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

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

- 字段详细资料
  - PERMISSION_REQUIRE_FORM
```
public static final String PERMISSION_REQUIRE_FORM
```
    Indicates the permission to obtain an AbilityForm.
    Applications functioning as the AbilityForm client, for example, the home screen, must have this permission. This permission is not available to third-party applications.
    
    从以下版本开始:
    
    3
    
    另请参阅:
    
    常量字段值
  - PRODUCER
```
public static final Sequenceable.Producer<AbilityForm> PRODUCER
```
    Creates a AbilityForm instance from a Parcel.
    
    从以下版本开始:
    
    4
- 构造器详细资料
  - AbilityForm
```
public AbilityForm(int resId,
                   Context context)
```
    A constructor used to create an AbilityForm instance on the AbilityForm supplier.
    The supplier uses this constructor to create an instance in response to the Ability#onCreateForm() method.
    
    参数:
    
    resId - Indicates the id of the layout resource file of the AbilityForm.
    
    context - Indicates the Ability context, which is used for asynchronous message processing of the AbilityForm supplier.
    
    抛出:
    
    IllegalStateException - invalid parameter
    
    从以下版本开始:
    
    2
- 方法详细资料
  - marshalling
```
public boolean marshalling(Parcel out)
```
    Marshals an AbilityForm object into a Parcel.
    
    指定者:
    
    marshalling 在接口中 Sequenceable
    
    参数:
    
    out - Indicates the Parcel object for marshalling.
    
    返回:
    
    Returns true if the marshalling is successful; returns false otherwise.
    
    从以下版本开始:
    
    1
  - unmarshalling
```
public boolean unmarshalling(Parcel in)
```
    Unmarshals an AbilityForm object from a Parcel.
    
    指定者:
    
    unmarshalling 在接口中 Sequenceable
    
    参数:
    
    in - Indicates the Parcel object for unmarshalling.
    
    返回:
    
    Returns true if the unmarshalling is successful; returns false otherwise.
    
    从以下版本开始:
    
    1
  - getFullPageIntent
```
public Intent getFullPageIntent()
```
    Obtains the Intent for starting full page display.
    You can use helper methods such as Ability.LayoutParamsHelper#setX(int) to set the display area for full page in the obtained Intent, and then use the AbilityForm#setFullPageIntent(Intent) method to pass the modified Intent back to the AbilityForm.
    
    返回:
    
    Returns the Intent for starting full page display.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    startFullPage(), setFullPageIntent(Intent)
  - setText
```
public void setText(int componentId,
                    String text)
```
    Sets the text to be displayed for a specific component on the AbilityForm supplier.
    
    参数:
    
    componentId - Identifies the component to be set. The value cannot be a negative number.
    
    text - Indicates the text to be displayed.
    
    从以下版本开始:
    
    1
  - setTextSize
```
public void setTextSize(int componentId,
                        int size)
```
    Sets the font size of a specific component on the AbilityForm supplier.
    
    参数:
    
    componentId - Identifies the component to be set. The value cannot be a negative number.
    
    size - Indicates the font size to be set. The value must be greater than 0.
    
    抛出:
    
    IllegalArgumentException - invalid argument
    
    从以下版本开始:
    
    1
  - sendActions
```
public void sendActions(ComponentProvider remoteComponentActions)
```
    Sends the supplier's actions configured in the ComponentProvider object to the client.
    The AbilityForm framework then applies these actions on the client for the actions to take effect.
    
    参数:
    
    remoteComponentActions - Indicates the actions to be sent to the client.
    
    抛出:
    
    IllegalStateException - if client stub is in a wrong state
    
    从以下版本开始:
    
    1
  - getComponent
```
public Component getComponent()
```
    Obtains the root component of an AbilityForm from the supplier.
    
    返回:
    
    Returns the root component.
    
    从以下版本开始:
    
    4
  - registerViewListener
```
public boolean registerViewListener(int componentId,
                                    ViewListener listener)
```
    Registers a listener by the AbilityForm supplier to listen for click events of a component on the AbilityForm client.
    
    参数:
    
    componentId - Identifies the component to be listened on. The value cannot be a negative number.
    
    listener - Indicates the callback method to be called when a component is clicked.
    
    返回:
    
    Returns true if the registration is successful; returns false otherwise.
    
    从以下版本开始:
    
    1
  - startFullPage
```
public void startFullPage()
```
    Switches to full page display of the AbilityForm by the AbilityForm client.
    Typically, the AbilityForm client starts the full page display by performing the following steps:
    1. The client uses AbilityForm#getFullPageIntent() in AbilityForm.OnAcquiredCallback#onAcquired(AbilityForm) to obtain the Intent for starting full page display.
    2. The client uses methods such as Ability.LayoutParamsHelper#setX(int) to set layout parameters in the obtained Intent.
    3. The client calls AbilityForm#setFullPageIntent(Intent) to pass the configured Intent back to the AbilityForm.
    从以下版本开始:
    
    1
    
    另请参阅:
    
    setFullPageIntent(Intent), getFullPageIntent()
  - setFullPageIntent
```
public void setFullPageIntent(Intent intent)
```
    Sets the Intent used for starting full page display.
    After calling AbilityForm#getFullPageIntent() to obtain the Intent for starting full page display, the client can set Intent parameters and then call the current method to pass the Intent back to the AbilityForm.
    
    参数:
    
    intent - Indicates the Intent for starting full page display.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    startFullPage(), getFullPageIntent()

类 AbilityForm

嵌套类概要

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

字段概要

构造器概要

方法概要

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

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

字段详细资料

PERMISSION_REQUIRE_FORM

PRODUCER

构造器详细资料

AbilityForm

方法详细资料

marshalling

unmarshalling

getFullPageIntent

setText

setTextSize

sendActions

getComponent

registerViewListener

startFullPage

setFullPageIntent