鴻蒙OS FormInfo

FormInfo

java.lang.Object

|---ohos.bundle.FormInfo

public class FormInfo
extends Object
implements Sequenceable

提供有關(guān)表單的信息

嵌套類摘要

修飾符和類型	類	描述
class	FormInfo.CustomizeData	定義自定義數(shù)據(jù)。
static class	FormInfo.FormType	枚舉表單的類型。

從接口 ohos.utils.Sequenceable 繼承的嵌套類/接口
Sequenceable.ProducerT

字段摘要

修飾符和類型	字段	描述
static Sequenceable.ProducerFormInfo	PRODUCER	從 Parcel 對象創(chuàng)建 FormInfo 對象。

構(gòu)造函數(shù)摘要

構(gòu)造函數(shù)	描述
FormInfo()	用于創(chuàng)建 FormInfo 實例的默認(rèn)構(gòu)造函數(shù)。
FormInfo(FormInfo source)	用于通過復(fù)制現(xiàn)有實例的屬性來創(chuàng)建 FormInfo 實例的構(gòu)造函數(shù)。

方法總結(jié)

修飾符和類型	方法	描述
String	getAbilityName()	獲取該表單所屬ability的類名。
String	getBundleName()	獲取此表單所屬的應(yīng)用程序的捆綁包名稱。
String	getColorMode()	獲取此表單的顏色模式。
MapString,String	getCustomizeDatas()	獲取此表單中定義的自定義數(shù)據(jù)。
String	getDeepLink()	已棄用。 此更改從 API 版本 5 開始生效。由 getFormConfigAbility() 替換
int	getDefaultDimension()	獲取此表單的默認(rèn)網(wǎng)格樣式。
String	getDescription()	獲取此表單的描述。
String	getFormConfigAbility()	獲取關(guān)于該表單的表單配置能力。
String	getFormName()	獲取此表單的名稱。
boolean	getFormVisibleNotify()	獲取此表單的通知是否可見。
String	getJsComponentName()	獲取此 JS 表單的 JS 組件名稱。
String	getModuleName()	獲取該表單所屬的應(yīng)用模塊的名稱。
String	getOriginalBundleName()	獲取此表單所屬的應(yīng)用程序的捆綁包名稱。
ListInteger	getSupportDimensions()	獲取此表單支持的網(wǎng)格樣式。
FormInfo.FormType	getType()	獲取此表單的類型。
boolean	isDefaultForm()	檢查此表單是否為默認(rèn)表單。
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

字段詳細(xì)信息

PRODUCER

public static final Sequenceable.ProducerFormInfo PRODUCER

從 Parcel 對象創(chuàng)建 FormInfo 對象。 該常量與 marshalling(ohos.utils.Parcel) 一起使用，是對 unmarshalling(ohos.utils.Parcel) 方法的封裝。

構(gòu)造函數(shù)詳細(xì)信息

FormInfo

public FormInfo()

用于創(chuàng)建 FormInfo 實例的默認(rèn)構(gòu)造函數(shù)。

FormInfo

public FormInfo(FormInfo source)

用于通過復(fù)制現(xiàn)有實例的屬性來創(chuàng)建 FormInfo 實例的構(gòu)造函數(shù)。

參數(shù):

參數(shù)名稱	參數(shù)描述
source	指示現(xiàn)有的 FormInfo 實例。

方法詳情

getBundleName

public String getBundleName()

獲取此表單所屬的應(yīng)用程序的捆綁包名稱。

返回:

返回應(yīng)用程序包名稱。

getOriginalBundleName

public String getOriginalBundleName()

獲取此表單所屬的應(yīng)用程序的捆綁包名稱。

返回:

返回應(yīng)用程序包名稱。

getModuleName

public String getModuleName()

獲取該表單所屬的應(yīng)用模塊的名稱。

返回:

返回模塊名稱。

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，它鏈接到應(yīng)用程序的特定頁面。

返回:

返回深層鏈接信息。

getFormConfigAbility

public String getFormConfigAbility()

獲取關(guān)于該表單的表單配置ability。

表單配置能力是用戶定義的ability。

返回:

返回表單配置ability。

isDefaultForm

public boolean isDefaultForm()

檢查此表單是否為默認(rèn)表單。

如果未指定表單名稱，則表單被視為默認(rèn)表單。 具體來說，系統(tǒng)根據(jù)Ohos應(yīng)用的config.json文件中forms下定義的isDefault屬性的值來判斷一個表單是否為默認(rèn)表單。

返回:

如果此表單是默認(rèn)表單，則返回 true； 否則返回 false。

getDefaultDimension

public int getDefaultDimension()

獲取此表單的默認(rèn)網(wǎng)格樣式。

返回:

返回默認(rèn)的網(wǎng)格樣式。 支持的網(wǎng)格樣式為 1（一行兩列）、2（兩行兩列）、3（2 行 4 列）和 4（4 行 4 列）。

getSupportDimensions

public ListInteger getSupportDimensions()

獲取此表單支持的網(wǎng)格樣式。

返回:

返回支持的網(wǎng)格樣式列表，可以是1（1行2列）、2（2行2列）、3（2行4列）、4（4行4列）的任意組合 .

getCustomizeDatas

public MapString,String getCustomizeDatas()

獲取此表單中定義的自定義數(shù)據(jù)。

返回:

返回包含自定義數(shù)據(jù)的 Map 對象。

marshalling

public boolean marshalling(Parcel out)

將此 FormInfo 對象編組為 Parcel 對象。

指定者：

接口 Sequenceable 中的編組

參數(shù)：

參數(shù)名稱	參數(shù)描述
out	指示用于編組的 Parcel 對象。

返回:

如果編組成功，則返回 true； 否則返回 false。

unmarshalling

public boolean unmarshalling(Parcel in)

從 Parcel 對象中解組此 FormInfo 對象。

指定者：

在接口 Sequenceable 中解組

參數(shù)：

參數(shù)名稱	參數(shù)描述
in	指示用于解組的 Parcel 對象。

返回:

如果解組成功，則返回 true； 否則返回 false。