鸿蒙OS FormInfo

FormInfo

java.lang.Object

|---ohos.bundle.FormInfo

public class FormInfo
extends Object
implements Sequenceable

提供有关表单的信息

嵌套类摘要

修饰符和类型	类	描述
class	FormInfo.CustomizeData	定义自定义数据。
static class	FormInfo.FormType	枚举表单的类型。

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

字段摘要

修饰符和类型	字段	描述
static Sequenceable.ProducerFormInfo	PRODUCER	从 Parcel 对象创建 FormInfo 对象。

构造函数摘要

构造函数	描述
FormInfo()	用于创建 FormInfo 实例的默认构造函数。
FormInfo(FormInfo source)	用于通过复制现有实例的属性来创建 FormInfo 实例的构造函数。

方法总结

修饰符和类型	方法	描述
String	getAbilityName()	获取该表单所属ability的类名。
String	getBundleName()	获取此表单所属的应用程序的捆绑包名称。
String	getColorMode()	获取此表单的颜色模式。
MapString,String	getCustomizeDatas()	获取此表单中定义的自定义数据。
String	getDeepLink()	已弃用。 此更改从 API 版本 5 开始生效。由 getFormConfigAbility() 替换
int	getDefaultDimension()	获取此表单的默认网格样式。
String	getDescription()	获取此表单的描述。
String	getFormConfigAbility()	获取关于该表单的表单配置能力。
String	getFormName()	获取此表单的名称。
boolean	getFormVisibleNotify()	获取此表单的通知是否可见。
String	getJsComponentName()	获取此 JS 表单的 JS 组件名称。
String	getModuleName()	获取该表单所属的应用模块的名称。
String	getOriginalBundleName()	获取此表单所属的应用程序的捆绑包名称。
ListInteger	getSupportDimensions()	获取此表单支持的网格样式。
FormInfo.FormType	getType()	获取此表单的类型。
boolean	isDefaultForm()	检查此表单是否为默认表单。
boolean	marshalling(Parcel out)	将此 FormInfo 对象编组为 Parcel 对象。
boolean	unmarshalling(Parcel in)	从 Parcel 对象中解组此 FormInfo 对象。

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

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

字段详细信息

PRODUCER

public static final Sequenceable.ProducerFormInfo PRODUCER

从 Parcel 对象创建 FormInfo 对象。 该常量与 marshalling(ohos.utils.Parcel) 一起使用，是对 unmarshalling(ohos.utils.Parcel) 方法的封装。

构造函数详细信息

FormInfo

public FormInfo()

用于创建 FormInfo 实例的默认构造函数。

FormInfo

public FormInfo(FormInfo source)

用于通过复制现有实例的属性来创建 FormInfo 实例的构造函数。

参数:

参数名称	参数描述
source	指示现有的 FormInfo 实例。

方法详情

getBundleName

public String getBundleName()

获取此表单所属的应用程序的捆绑包名称。

返回:

返回应用程序包名称。

getOriginalBundleName

public String getOriginalBundleName()

获取此表单所属的应用程序的捆绑包名称。

返回:

返回应用程序包名称。

getModuleName

public String getModuleName()

获取该表单所属的应用模块的名称。

返回:

返回模块名称。

getAbilityName

public String getAbilityName()

获取该表单所属ability的类名。

返回:

返回ability类名称。

getFormName

public String getFormName()

获取此表单的名称。

返回:

返回表单名称。

getDescription

public String getDescription()

获取此表单的描述。

返回:

返回表单描述。

getFormVisibleNotify

public boolean getFormVisibleNotify()

获取此表单的通知是否可见。

返回:

返回表单是否可见通知。

getType

public FormInfo.FormType getType()

获取此表单的类型。

返回:

返回表单类型。

getColorMode

public String getColorMode()

获取此表单的颜色模式。

返回:

返回此表单的颜色模式，可以是自动、深色或浅色。

getJsComponentName

public String getJsComponentName()

获取此 JS 表单的 JS 组件名称。

该方法仅在该表单的类型为 JS 时有效。

返回:

如果此表单是 JS 表单，则返回 JS 组件名称； 否则返回 null。

getDeepLink

@Deprecated public String getDeepLink()

已弃用。 此更改从 API 版本 5 开始生效。由 getFormConfigAbility() 替换

获取该表单的深层链接信息。

深层链接是用户定义的 URI，它链接到应用程序的特定页面。

返回:

返回深层链接信息。

getFormConfigAbility

public String getFormConfigAbility()

获取关于该表单的表单配置ability。

表单配置能力是用户定义的ability。

返回:

返回表单配置ability。

isDefaultForm

public boolean isDefaultForm()

检查此表单是否为默认表单。

如果未指定表单名称，则表单被视为默认表单。 具体来说，系统根据Ohos应用的config.json文件中forms下定义的isDefault属性的值来判断一个表单是否为默认表单。

返回:

如果此表单是默认表单，则返回 true； 否则返回 false。

getDefaultDimension

public int getDefaultDimension()

获取此表单的默认网格样式。

返回:

返回默认的网格样式。 支持的网格样式为 1（一行两列）、2（两行两列）、3（2 行 4 列）和 4（4 行 4 列）。

getSupportDimensions

public ListInteger getSupportDimensions()

获取此表单支持的网格样式。

返回:

返回支持的网格样式列表，可以是1（1行2列）、2（2行2列）、3（2行4列）、4（4行4列）的任意组合 .

getCustomizeDatas

public MapString,String getCustomizeDatas()

获取此表单中定义的自定义数据。

返回:

返回包含自定义数据的 Map 对象。

marshalling

public boolean marshalling(Parcel out)

将此 FormInfo 对象编组为 Parcel 对象。

指定者：

接口 Sequenceable 中的编组

参数：

参数名称	参数描述
out	指示用于编组的 Parcel 对象。

返回:

如果编组成功，则返回 true； 否则返回 false。

unmarshalling

public boolean unmarshalling(Parcel in)

从 Parcel 对象中解组此 FormInfo 对象。

指定者：

在接口 Sequenceable 中解组

参数：

参数名称	参数描述
in	指示用于解组的 Parcel 对象。

返回:

如果解组成功，则返回 true； 否则返回 false。