ComponentProvider

java.lang.Object
- ohos.agp.components.ComponentProvider

所有已实现的接口:

Sequenceable
```
public class ComponentProvider
extends Object
implements Sequenceable
```
Provides remote components for cross-process display.
This class provides a set of basic operations for modifying the content of remote components. It is commonly used for developing notifications displayed in the notification bar as well as widgets on the desktop or home screen.

从以下版本开始:

1

嵌套类概要

嵌套类
限定符和类型	类	说明
`static class`	`ComponentProvider.Action`	Describes actions that can be performed on remote components.
`static class`	`ComponentProvider.ComponentProviderException`	Throws an exception for an error that occurs during a remote component operation.

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

字段概要

字段
限定符和类型	字段	说明
`static int`	`APPLY_TYPE_ACTIONS_ONLY`	Applies all of the actions after a `ComponentProvider` object is updated.
`static int`	`APPLY_TYPE_LAYOUT_AND_ACTIONS`	Inflates the layout and applies all of the actions after a `ComponentProvider` object is created.

构造器概要

构造器
构造器	说明
`ComponentProvider()`	Default constructor used to create a `ComponentProvider`.
`ComponentProvider(int layoutId, Context context)`	A constructor used to create a `ComponentProvider` instance based on the layout ID and `Context` of the application.

方法概要

所有方法实例方法具体方法
限定符和类型	方法	说明
`void`	`applyAction(ComponentContainer root)`	Applies all of the actions in the current process.
`Collection<ComponentProvider.Action>`	`getActions()`	Obtains all actions.
`ComponentContainer`	`getAllComponents()`	Obtains all components in a `ComponentContainer`.
`int`	`getApplyType()`	Obtains the operation type.
`String`	`getDefaultBundleName()`	Obtains the default bundle name.
`int`	`getLayoutId()`	Obtains the layout ID.
`void`	`inflateLayout(Context context)`	Inflates the layout based on layout definition.
`boolean`	`isValidComponentId(int componentId)`	Checks whether a component is valid based on the provided component ID.
`boolean`	`marshalling(Parcel out)`	Marshals a `ComponentProvider` object and then writes it into a `Parcel`object.
`void`	`mergeAction(ComponentProvider.Action action)`	Merges `ComponentProvider.Action` objects into a `ComponentProvider` object.
`void`	`mergeActions(Collection<ComponentProvider.Action> actions)`	Merges and stores all `Action` objects into a `ComponentProvider` object.
`void`	`resetActions()`	Clears all actions in the current `ComponentProvider` object.
`ComponentProvider.Action`	`setAccessibilityDescription(int componentId, String description)`	Sets the description of the accessibility mode for a specified component..
`boolean`	`setApplyType(int applyType)`	Sets the operation type.
`ComponentProvider.Action`	`setBackgroundPixelMap(int componentId, PixelMap pixelMap)`	Sets the background image of a component.
`ComponentProvider.Action`	`setBoolean(int componentId, String methodName, boolean value)`	Invokes a specified interface of a component.
`ComponentProvider.Action`	`setClipToContourEnabled(int componentId, boolean enable)`	Sets whether the contour of a component can be used for content clipping.
`ComponentProvider.Action`	`setComponentContainerLayoutConfig(int componentId, ComponentContainer.LayoutConfig params)`	Sets the margin layout parameters of a component.
`void`	`setDefaultBundleName(String bundleName)`	Sets the default bundle name for obtaining resources.
`ComponentProvider.Action`	`setDouble(int componentId, String methodName, double value)`	Invokes a specified interface of a component.
`ComponentProvider.Action`	`setFloat(int componentId, String methodName, float value)`	Invokes a specified interface of a component.
`ComponentProvider.Action`	`setImageContent(int componentId, int resId)`	Sets the content to be displayed on a specified image component.
`ComponentProvider.Action`	`setImagePixelMap(int componentId, PixelMap pixelMap)`	Sets the image content for a component.
`ComponentProvider.Action`	`setInt(int componentId, String methodName, int value)`	Invokes a specified interface of a component.
`ComponentProvider.Action`	`setIntentAgent(int componentId, IntentAgent intent)`	Sets the `IntentAgent` object for a remote component.
`ComponentProvider.Action`	`setLong(int componentId, String methodName, long value)`	Invokes a specified interface of a component.
`ComponentProvider.Action`	`setPadding(int componentId, int top, int bottom, int left, int right)`	Sets the padding for a component.
`ComponentProvider.Action`	`setPixelMap(int componentId, String methodName, PixelMap value)`	Invokes a specified interface of a component.
`ComponentProvider.Action`	`setProgressBar(int componentId, int max, int progress, boolean indeterminate)`	Sets the progress of `ProgressBar`.
`ComponentProvider.Action`	`setString(int componentId, String methodName, String value)`	Invokes a specified interface of a component.
`ComponentProvider.Action`	`setText(int componentId, String text)`	Sets the text content for a component.
`ComponentProvider.Action`	`setTextAlignment(int componentId, int textAlignment)`	Sets the text alignment mode for a component.
`ComponentProvider.Action`	`setTextColor(int componentId, Color color)`	Sets the text color for a component.
`ComponentProvider.Action`	`setTextSize(int componentId, int size)`	Sets the text size for a component.
`ComponentProvider.Action`	`setTextSize(int componentId, int size, Text.TextSizeType textSizeType)`	Sets the text size of the component.
`ComponentProvider.Action`	`setVisibility(int componentId, int visibility)`	Sets the visibility of a component.
`boolean`	`unmarshalling(Parcel in)`	Unmarshals (or initializes) a `ComponentProvider` object using content read from a `Parcel` object.

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

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

- 字段详细资料
  - APPLY_TYPE_ACTIONS_ONLY
```
public static final int APPLY_TYPE_ACTIONS_ONLY
```
    Applies all of the actions after a ComponentProvider object is updated.
    This allows the components to be updated in another application.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    常量字段值
  - APPLY_TYPE_LAYOUT_AND_ACTIONS
```
public static final int APPLY_TYPE_LAYOUT_AND_ACTIONS
```
    Inflates the layout and applies all of the actions after a ComponentProvider object is created.
    This allows the created components to be displayed in another application.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    常量字段值
- 构造器详细资料
  - ComponentProvider
```
public ComponentProvider()
```
    Default constructor used to create a ComponentProvider.
    
    从以下版本开始:
    
    1
  - ComponentProvider
```
public ComponentProvider(int layoutId,
                         Context context)
```
    A constructor used to create a ComponentProvider instance based on the layout ID and Context of the application.
    
    参数:
    
    layoutId - Indicates the layout ID.
    
    context - Indicates the Context of the application.
    
    从以下版本开始:
    
    2
- 方法详细资料
  - setApplyType
```
public boolean setApplyType(int applyType)
```
    Sets the operation type.
    The operation type can be APPLY_TYPE_LAYOUT_AND_ACTIONS or APPLY_TYPE_ACTIONS_ONLY. The APPLY_TYPE_LAYOUT_AND_ACTIONS type means to inflate the layout and apply all of the actions, whereas the APPLY_TYPE_ACTIONS_ONLY type means to apply all of the actions only.
    
    参数:
    
    applyType - Indicates the operation type, which can only be APPLY_TYPE_LAYOUT_AND_ACTIONS or APPLY_TYPE_ACTIONS_ONLY. A value other than these two will cause failure to invoke the current method.
    
    返回:
    
    Returns true if the operation type is set successfully; returns false otherwise.
    
    从以下版本开始:
    
    1
  - getApplyType
```
public int getApplyType()
```
    Obtains the operation type.
    
    返回:
    
    Returns the operation type, which can be either APPLY_TYPE_LAYOUT_AND_ACTIONS or APPLY_TYPE_ACTIONS_ONLY.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    setApplyType(int)
  - setDefaultBundleName
```
public void setDefaultBundleName(String bundleName)
```
    Sets the default bundle name for obtaining resources.
    
    参数:
    
    bundleName - Indicates the bundle name to set. Before converting ohos resources into ones that can be identified by other systems, you need the bundle name to locate the ohos resources. If the bundle name is incorrect, ohos resources cannot be located, and the conversion will fail.
    
    从以下版本开始:
    
    4
  - getDefaultBundleName
```
public String getDefaultBundleName()
```
    Obtains the default bundle name.
    
    返回:
    
    Returns the default bundle name.
    
    从以下版本开始:
    
    4
    
    另请参阅:
    
    setDefaultBundleName(String)
  - isValidComponentId
```
public boolean isValidComponentId(int componentId)
```
    Checks whether a component is valid based on the provided component ID.
    This method finds the ComponentProvider corresponding to the provided component ID.
    
    参数:
    
    componentId - Indicates the component ID.
    
    返回:
    
    Returns true if a component with the given ID is found; returns false otherwise.
    
    从以下版本开始:
    
    1
  - marshalling
```
public boolean marshalling(Parcel out)
```
    Marshals a ComponentProvider object and then writes it into a Parcelobject.
    
    指定者:
    
    marshalling 在接口中 Sequenceable
    
    参数:
    
    out - Indicates the object into which the marshaled ComponentProvider object will be written.
    
    返回:
    
    Returns true if marshaling is successful; returns false otherwise.
    
    从以下版本开始:
    
    1
  - unmarshalling
```
public boolean unmarshalling(Parcel in)
```
    Unmarshals (or initializes) a ComponentProvider object using content read from a Parcel object.
    
    指定者:
    
    unmarshalling 在接口中 Sequenceable
    
    参数:
    
    in - Indicates the ComponentProvider object to unmarshal.
    
    返回:
    
    Returns true if Unmarshals (or initializes) a ComponentProvider object success, returns false otherwise.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    marshalling(Parcel)
  - inflateLayout
```
public void inflateLayout(Context context)
```
    Inflates the layout based on layout definition.
    If the layout in ComponentProvider needs to be displayed, inflate the layout based on the Context of the application.
    
    参数:
    
    context - Indicates the Context of the current application.
    
    从以下版本开始:
    
    2
  - getAllComponents
```
public ComponentContainer getAllComponents()
```
    Obtains all components in a ComponentContainer.
    
    返回:
    
    Returns the ComponentContainer object containing all components.
    
    从以下版本开始:
    
    1
  - applyAction
```
public void applyAction(ComponentContainer root)
```
    Applies all of the actions in the current process.
    
    参数:
    
    root - Indicates all components of the ComponentProvider object.
    
    从以下版本开始:
    
    1
  - getActions
```
public Collection<ComponentProvider.Action> getActions()
```
    Obtains all actions.
    
    返回:
    
    Returns all ComponentProvider.Action objects.
    
    从以下版本开始:
    
    1
  - getLayoutId
```
public int getLayoutId()
```
    Obtains the layout ID.
    
    返回:
    
    Returns the layout ID.
    
    从以下版本开始:
    
    3
  - mergeActions
```
public void mergeActions(Collection<ComponentProvider.Action> actions)
```
    Merges and stores all Action objects into a ComponentProvider object.
    
    参数:
    
    actions - Indicates the list of Action objects.
    
    从以下版本开始:
    
    1
  - setTextSize
```
public ComponentProvider.Action setTextSize(int componentId,
                                            int size)
```
    Sets the text size for a component.
    This method is equivalent to Text#setTextSize(int). However, it requires that you manually invoke applyAction(ohos.agp.components.ComponentContainer).
    
    参数:
    
    componentId - Indicates the component ID.
    
    size - Indicates the text size.
    
    返回:
    
    Returns the Action object.
    
    从以下版本开始:
    
    1
  - setTextSize
```
public ComponentProvider.Action setTextSize(int componentId,
                                            int size,
                                            Text.TextSizeType textSizeType)
```
    Sets the text size of the component.
    This method is equivalent to Text#setTextSize(int, ohos.agp.components.Text.TextSizeType). You need to call applyAction(ohos.agp.components.ComponentContainer) for the method to take effect.
    
    参数:
    
    componentId - Indicates the component ID.
    
    size - Indicates the text size.
    
    textSizeType - Indicates the unit of the text size, as enumerated in Text.TextSizeType.
    
    返回:
    
    Returns an Action object.
    
    从以下版本开始:
    
    5
  - setTextColor
```
public ComponentProvider.Action setTextColor(int componentId,
                                             Color color)
```
    Sets the text color for a component.
    This method is equivalent to Text#setTextColor(Color). However, it requires that you manually invoke applyAction(ohos.agp.components.ComponentContainer).
    
    参数:
    
    componentId - Indicates the component ID.
    
    color - Indicates the text color to set to. For details, see the definitions in Color.
    
    返回:
    
    Returns the Action object.
    
    从以下版本开始:
    
    1
  - setTextAlignment
```
public ComponentProvider.Action setTextAlignment(int componentId,
                                                 int textAlignment)
```
    Sets the text alignment mode for a component.
    This method is equivalent to Text#setTextAlignment(int). However, it requires that you manually invoke applyAction(ohos.agp.components.ComponentContainer).
    
    参数:
    
    componentId - Indicates the component ID.
    
    textAlignment - Indicates the text alignment mode to set to.
    
    返回:
    
    Returns the Action object.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    TextAlignment
  - setComponentContainerLayoutConfig
```
public ComponentProvider.Action setComponentContainerLayoutConfig(int componentId,
                                                                  ComponentContainer.LayoutConfig params)
```
    Sets the margin layout parameters of a component.
    This method is equivalent to Component#setLayoutConfig(ComponentContainer.LayoutConfig). However, it requires that you manually invoke applyAction(ohos.agp.components.ComponentContainer).
    
    参数:
    
    componentId - Indicates the component ID.
    
    params - Indicates the layout parameters to set.
    
    返回:
    
    Returns the Action object.
    
    从以下版本开始:
    
    1
  - setVisibility
```
public ComponentProvider.Action setVisibility(int componentId,
                                              int visibility)
```
    Sets the visibility of a component.
    This method is equivalent to Component#setVisibility(int). However, it requires that you manually invoke applyAction(ohos.agp.components.ComponentContainer).
    
    参数:
    
    componentId - Indicates the component ID.
    
    visibility - Indicates the component's visibility.
    
    返回:
    
    Returns the Action object.
    
    从以下版本开始:
    
    1
    
    另请参阅:
    
    Component.VISIBLE, Component.INVISIBLE, Component.HIDE
  - setProgressBar
```
public ComponentProvider.Action setProgressBar(int componentId,
                                               int max,
                                               int progress,
                                               boolean indeterminate)
```
    Sets the progress of ProgressBar.
    This method is equivalent to ProgressBar#setMaxValue(int), ProgressBar#setProgressValue(int), and ProgressBar#setIndeterminate(boolean). However, it requires that you manually invoke applyAction(ohos.agp.components.ComponentContainer).
    
    参数:
    
    componentId - Indicates the component ID.
    
    max - Indicates the maximum value of the progress bar.
    
    progress - Indicates the current progress.
    
    indeterminate - Indicates whether the progress is indeterminate. true means that the progress is indeterminate; false means otherwise.
    
    返回:
    
    Returns the Action object.
    
    从以下版本开始:
    
    1
  - setPadding
```
public ComponentProvider.Action setPadding(int componentId,
                                           int top,
                                           int bottom,
                                           int left,
                                           int right)
```
    Sets the padding for a component.
    This method is equivalent to Component#setPadding(int, int, int, int). However, it requires that you manually invoke applyAction(ohos.agp.components.ComponentContainer).
    
    参数:
    
    componentId - Indicates the component ID.
    
    top - Indicates the number of pixels for top padding.
    
    bottom - Indicates the number of pixels for bottom padding.
    
    left - Indicates the number of pixels for left padding.
    
    right - Indicates the number of pixels for right padding.
    
    返回:
    
    Returns the Action object.
    
    从以下版本开始:
    
    1
  - setText
```
public ComponentProvider.Action setText(int componentId,
                                        String text)
```
    Sets the text content for a component.
    This method is equivalent to Text#setText(String). However, it requires that you manually invoke applyAction(ohos.agp.components.ComponentContainer).
    
    参数:
    
    componentId - Indicates the component ID.
    
    text - Indicates the text content to set for the component.
    
    返回:
    
    Returns the Action object.
    
    从以下版本开始:
    
    1
  - setAccessibilityDescription
```
public ComponentProvider.Action setAccessibilityDescription(int componentId,
                                                            String description)
```
    Sets the description of the accessibility mode for a specified component..
    This method is equivalent to Component#setAccessibilityDescription(String), except that you must call applyAction(ohos.agp.components.ComponentContainer).
    
    参数:
    
    componentId - Indicates the component ID.
    
    description - Indicates the description to set.
    
    返回:
    
    Returns the Action object.
    
    从以下版本开始:
    
    4
    
    另请参阅:
    
    setDefaultBundleName(String)
  - setClipToContourEnabled
```
public ComponentProvider.Action setClipToContourEnabled(int componentId,
                                                        boolean enable)
```
    Sets whether the contour of a component can be used for content clipping.
    This method is equivalent to ohos.agp.components.Component#setClipToContourEnabled(boolean), except that you must call applyAction(ohos.agp.components.ComponentContainer).
    
    参数:
    
    componentId - Indicates the component ID.
    
    enable - Indicates whether clipping is supported.
    
    返回:
    
    Returns the Action object.
    
    从以下版本开始:
    
    7
  - mergeAction
```
public void mergeAction(ComponentProvider.Action action)
```
    Merges ComponentProvider.Action objects into a ComponentProvider object.
    
    参数:
    
    action - Indicates the merge action to perform.
    
    从以下版本开始:
    
    1
  - resetActions
```
public void resetActions()
```
    Clears all actions in the current ComponentProvider object.
    
    从以下版本开始:
    
    1
  - setInt
```
public ComponentProvider.Action setInt(int componentId,
                                       String methodName,
                                       int value)
```
    Invokes a specified interface of a component. This interface accepts only one parameter of the int type.
    
    参数:
    
    componentId - Indicates the component ID.
    
    methodName - Indicates the name of the interface to invoke.
    
    value - Indicates the parameter of the interface to invoke.
    
    返回:
    
    Returns the Action object.
    
    从以下版本开始:
    
    1
  - setString
```
public ComponentProvider.Action setString(int componentId,
                                          String methodName,
                                          String value)
```
    Invokes a specified interface of a component. This interface accepts only one parameter of the string type.
    
    参数:
    
    componentId - Indicates the component ID.
    
    methodName - Indicates the name of the interface to invoke.
    
    value - Indicates the parameter of the interface to invoke.
    
    返回:
    
    Returns the Action object.
    
    从以下版本开始:
    
    1
  - setFloat
```
public ComponentProvider.Action setFloat(int componentId,
                                         String methodName,
                                         float value)
```
    Invokes a specified interface of a component. This interface accepts only one parameter of the float type.
    
    参数:
    
    componentId - Indicates the component ID.
    
    methodName - Indicates the name of the interface to invoke.
    
    value - Indicates the parameter of the interface to invoke.
    
    返回:
    
    Returns the Action object.
    
    从以下版本开始:
    
    1
  - setDouble
```
public ComponentProvider.Action setDouble(int componentId,
                                          String methodName,
                                          double value)
```
    Invokes a specified interface of a component. This interface accepts only one parameter of the double type.
    
    参数:
    
    componentId - Indicates the component ID.
    
    methodName - Indicates the name of the interface to invoke.
    
    value - Indicates the parameter of the interface to invoke.
    
    返回:
    
    Returns the Action object.
    
    从以下版本开始:
    
    1
  - setLong
```
public ComponentProvider.Action setLong(int componentId,
                                        String methodName,
                                        long value)
```
    Invokes a specified interface of a component. This interface accepts only one parameter of the long type.
    
    参数:
    
    componentId - Indicates the component ID.
    
    methodName - Indicates the name of the interface to invoke.
    
    value - Indicates the parameter of the interface to invoke.
    
    返回:
    
    Returns the Action object.
    
    从以下版本开始:
    
    1
  - setBoolean
```
public ComponentProvider.Action setBoolean(int componentId,
                                           String methodName,
                                           boolean value)
```
    Invokes a specified interface of a component. This interface accepts only one parameter of the boolean type.
    
    参数:
    
    componentId - Indicates the component ID.
    
    methodName - Indicates the name of the interface to invoke.
    
    value - Indicates the parameter of the interface to invoke.
    
    返回:
    
    Returns the Action object.
    
    从以下版本开始:
    
    1
  - setPixelMap
```
public ComponentProvider.Action setPixelMap(int componentId,
                                            String methodName,
                                            PixelMap value)
```
    Invokes a specified interface of a component. This interface accepts only one PixelMap parameter.
    
    参数:
    
    componentId - Indicates the component ID.
    
    methodName - Indicates the name of the interface to invoke.
    
    value - Indicates the parameter of the interface to invoke.
    
    返回:
    
    Returns the Action object.
    
    从以下版本开始:
    
    1
  - setImagePixelMap
```
public ComponentProvider.Action setImagePixelMap(int componentId,
                                                 PixelMap pixelMap)
```
    Sets the image content for a component.
    This method is equivalent to Image#setPixelMap(PixelMap). However, it requires that you manually invoke applyAction(ohos.agp.components.ComponentContainer).
    
    参数:
    
    componentId - Indicates the component ID.
    
    pixelMap - Indicates the image content to set.
    
    返回:
    
    Returns the Action object.
    
    从以下版本开始:
    
    3
  - setImageContent
```
public ComponentProvider.Action setImageContent(int componentId,
                                                int resId)
```
    Sets the content to be displayed on a specified image component.
    This method is equivalent toImage#setPixelMap(int). You need to call applyAction(ohos.agp.components.ComponentContainer) for the method to take effect.
    
    参数:
    
    componentId - Indicates the ID of the image component.
    
    resId - Indicates the resource ID of the content to be displayed on the image component. The content can be an image in the PNG, SVG, or another applicable format.
    
    返回:
    
    Returns an Action object.
    
    从以下版本开始:
    
    5
  - setBackgroundPixelMap
```
public ComponentProvider.Action setBackgroundPixelMap(int componentId,
                                                      PixelMap pixelMap)
```
    Sets the background image of a component.
    This method is equivalent to Component#setBackground(Element). However, it requires that you manually invoke applyAction(ohos.agp.components.ComponentContainer).
    
    参数:
    
    componentId - Indicates the component ID.
    
    pixelMap - Indicates the background image to set.
    
    返回:
    
    Returns the Action object.
    
    从以下版本开始:
    
    1
  - setIntentAgent
```
public ComponentProvider.Action setIntentAgent(int componentId,
                                               IntentAgent intent)
```
    Sets the IntentAgent object for a remote component.
    
    参数:
    
    componentId - Indicates the remote component ID.
    
    intent - Indicates intent to use.
    
    返回:
    
    Returns the Action object.
    
    从以下版本开始:
    
    3

类 ComponentProvider

嵌套类概要

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

字段概要

构造器概要

方法概要

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

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

字段详细资料

APPLY_TYPE_ACTIONS_ONLY

APPLY_TYPE_LAYOUT_AND_ACTIONS

构造器详细资料

ComponentProvider

ComponentProvider

方法详细资料

setApplyType

getApplyType

setDefaultBundleName

getDefaultBundleName

isValidComponentId

marshalling

unmarshalling

inflateLayout

getAllComponents

applyAction

getActions

getLayoutId

mergeActions

setTextSize

setTextSize

setTextColor

setTextAlignment

setComponentContainerLayoutConfig

setVisibility

setProgressBar

setPadding

setText

setAccessibilityDescription

setClipToContourEnabled

mergeAction

resetActions

setInt

setString

setFloat

setDouble

setLong

setBoolean

setPixelMap

setImagePixelMap

setImageContent

setBackgroundPixelMap

setIntentAgent