FormInfo

java.lang.Object
- ohos.bundle.FormInfo

所有已实现的接口:

Sequenceable
```
public class FormInfo
extends Object
implements Sequenceable
```
Provides information about a form.

从以下版本开始:

5

嵌套类概要

嵌套类
限定符和类型类说明

class FormInfo.CustomizeData
Defines custom data.

static class FormInfo.FormType
Enumerates types of a form.
- 从接口继承的嵌套类/接口 ohos.utils.Sequenceable
  Sequenceable.Producer<T>

嵌套类
限定符和类型	类	说明
`class`	`FormInfo.CustomizeData`	Defines custom data.
`static class`	`FormInfo.FormType`	Enumerates types of a form.

字段概要

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

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

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

构造器概要

构造器
构造器	说明
`FormInfo()`	Default constructor used to create a `FormInfo` instance.
`FormInfo(FormInfo source)`	A constructor used to create a `FormInfo` instance by copying attributes of an existing one.

方法概要

所有方法实例方法具体方法已过时的方法
限定符和类型	方法	说明
`String`	`getAbilityName()`	Obtains the class name of the ability to which this form belongs.
`String`	`getBundleName()`	Obtains the bundle name of the application to which this form belongs.
`String`	`getColorMode()`	Obtains the color mode of this form.
`Map<String,String>`	`getCustomizeDatas()`	Obtains the custom data defined in this form.
`String`	`getDeepLink()`	已过时。 This change is effective since API version 5. Replaced by `getFormConfigAbility()`
`int`	`getDefaultDimension()`	Obtains the default grid style of this form.
`String`	`getDescription()`	Obtains the description of this form.
`String`	`getFormConfigAbility()`	Obtains the form config ability about this form.
`String`	`getFormName()`	Obtains the name of this form.
`boolean`	`getFormVisibleNotify()`	Obtains whether notify visible of this form.
`String`	`getJsComponentName()`	Obtains the JS component name of this JS form.
`String`	`getModuleName()`	Obtains the name of the application module to which this form belongs.
`String`	`getOriginalBundleName()`	Obtains the bundle name of the application to which this form belongs.
`List<Integer>`	`getSupportDimensions()`	Obtains the grid styles supported by this form.
`FormInfo.FormType`	`getType()`	Obtains the type of this form.
`boolean`	`isDefaultForm()`	Checks whether this form is a default form.
`boolean`	`marshalling(Parcel out)`	Marshals this `FormInfo` object into a `Parcel` object.
`boolean`	`unmarshalling(Parcel in)`	Unmarshals this `FormInfo` 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<FormInfo> PRODUCER
```
    Creates a FormInfo 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
- 构造器详细资料
  - FormInfo
```
public FormInfo()
```
    Default constructor used to create a FormInfo instance.
    
    从以下版本开始:
    
    5
  - FormInfo
```
public FormInfo(FormInfo source)
```
    A constructor used to create a FormInfo instance by copying attributes of an existing one.
    
    参数:
    
    source - Indicates the existing FormInfo instance.
    
    从以下版本开始:
    
    5
- 方法详细资料
  - getBundleName
```
public String getBundleName()
```
    Obtains the bundle name of the application to which this form belongs.
    
    返回:
    
    Returns the application bundle name.
    
    从以下版本开始:
    
    5
  - getOriginalBundleName
```
public String getOriginalBundleName()
```
    Obtains the bundle name of the application to which this form belongs.
    
    返回:
    
    Returns the application bundle name.
    
    从以下版本开始:
    
    5
  - getModuleName
```
public String getModuleName()
```
    Obtains the name of the application module to which this form belongs.
    
    返回:
    
    Returns the module name.
    
    从以下版本开始:
    
    5
  - getAbilityName
```
public String getAbilityName()
```
    Obtains the class name of the ability to which this form belongs.
    
    返回:
    
    Returns the ability class name.
    
    从以下版本开始:
    
    5
  - getFormName
```
public String getFormName()
```
    Obtains the name of this form.
    
    返回:
    
    Returns the form name.
    
    从以下版本开始:
    
    5
  - getDescription
```
public String getDescription()
```
    Obtains the description of this form.
    
    返回:
    
    Returns the form description.
    
    从以下版本开始:
    
    5
  - getFormVisibleNotify
```
public boolean getFormVisibleNotify()
```
    Obtains whether notify visible of this form.
    
    返回:
    
    Returns whether the form visible notify.
    
    从以下版本开始:
    
    5
  - getType
```
public FormInfo.FormType getType()
```
    Obtains the type of this form.
    
    返回:
    
    Returns the form type.
    
    从以下版本开始:
    
    5
  - getColorMode
```
public String getColorMode()
```
    Obtains the color mode of this form.
    
    返回:
    
    Returns the color mode of this form, which can be auto, dark, or light.
    
    从以下版本开始:
    
    5
  - getJsComponentName
```
public String getJsComponentName()
```
    Obtains the JS component name of this JS form.
    This method is valid only when the type of this form is JS.
    
    返回:
    
    Returns the JS component name if this form is a JS form; returns null otherwise.
    
    从以下版本开始:
    
    5
  - getDeepLink
```
@Deprecated
public String getDeepLink()
```
    已过时。 This change is effective since API version 5. Replaced by getFormConfigAbility()
    
    Obtains the deep link information about this form.
    A deep link is a user-defined URI that links to a specific page of an app.
    
    返回:
    
    Returns the deep link information.
    
    从以下版本开始:
    
    5
  - getFormConfigAbility
```
public String getFormConfigAbility()
```
    Obtains the form config ability about this form.
    A form config ability is a user-defined ability.
    
    返回:
    
    Returns the form config ability.
    
    从以下版本开始:
    
    5
  - isDefaultForm
```
public boolean isDefaultForm()
```
    Checks whether this form is a default form.
    A form is considered a default form if no form name is specified. Specifically, the system determines whether a form is a default form based on the value of the isDefault attribute defined under forms in the config.json file of the Ohos application.
    
    返回:
    
    Returns true if this form is a default form; returns false otherwise.
    
    从以下版本开始:
    
    5
  - getDefaultDimension
```
public int getDefaultDimension()
```
    Obtains the default grid style of this form.
    
    返回:
    
    Returns the default grid style. The supported grid styles are 1 (one row and two columns), 2 (two rows and two columns), 3 (2 rows and 4 columns), and 4 (4 rows and 4 columns).
    
    从以下版本开始:
    
    5
    
    另请参阅:
    
    getSupportDimensions()
  - getSupportDimensions
```
public List<Integer> getSupportDimensions()
```
    Obtains the grid styles supported by this form.
    
    返回:
    
    Returns the list of grid styles supported, which can be any combination of 1 (one row and two columns), 2 (two rows and two columns), 3 (2 rows and 4 columns), and 4 (4 rows and 4 columns).
    
    从以下版本开始:
    
    5
  - getCustomizeDatas
```
public Map<String,String> getCustomizeDatas()
```
    Obtains the custom data defined in this form.
    
    返回:
    
    Returns the Map object containing the custom data.
    
    从以下版本开始:
    
    5
  - marshalling
```
public boolean marshalling(Parcel out)
```
    Marshals this FormInfo 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 FormInfo 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

类 FormInfo

嵌套类概要

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

字段概要

构造器概要

方法概要

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

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

字段详细资料

PRODUCER

构造器详细资料

FormInfo

FormInfo

方法详细资料

getBundleName

getOriginalBundleName

getModuleName

getAbilityName

getFormName

getDescription

getFormVisibleNotify

getType

getColorMode

getJsComponentName

getDeepLink

getFormConfigAbility

isDefaultForm

getDefaultDimension

getSupportDimensions

getCustomizeDatas

marshalling

unmarshalling