com.tencentcloudapi.ess.v20201111.models

Class Component

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.ess.v20201111.models.Component

public class Component
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
Component()
Component(Component source) NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

Method Summary

Modifier and Type	Method and Description
Long	getComponentDateFontSize() Get 日期控件类型字号
String	getComponentExtra() Get 参数控件样式
Float	getComponentHeight() Get 参数控件高度，单位px
String	getComponentId() Get 控件编号
String	getComponentName() Get 控件名称
Long	getComponentPage() Get 参数控件所在页码，取值为：1-N
Float	getComponentPosX() Get 参数控件X位置，单位px
Float	getComponentPosY() Get 参数控件Y位置，单位px
String	getComponentRecipientId() Get 控件关联的签署人ID
Boolean	getComponentRequired() Get 是否必选，默认为false
String	getComponentType() Get 如果是 Component 控件类型，则可选类型为： TEXT - 内容文本控件 DATE - 内容日期控件 SELECT - 勾选框控件 如果是 SignComponent 控件类型，则可选类型为： SIGN_SEAL - 签署印章控件 SIGN_DATE - 签署日期控件 SIGN_SIGNATURE - 手写签名控件
String	getComponentValue() Get 控件所填写的内容
Float	getComponentWidth() Get 参数控件宽度，单位px
Long	getFileIndex() Get 控件所属文件的序号（模板中的resourceId排列序号，取值为：0-N）
String	getGenerateMode() Get NORMAL 正常模式，使用坐标制定签署控件位置 FIELD 表单域，需使用ComponentName指定表单域名称 KEYWORD 关键字，使用ComponentId指定关键字
Boolean	getIsFormType() Get 是否是表单域类型，默认不存在
void	setComponentDateFontSize(Long ComponentDateFontSize) Set 日期控件类型字号
void	setComponentExtra(String ComponentExtra) Set 参数控件样式
void	setComponentHeight(Float ComponentHeight) Set 参数控件高度，单位px
void	setComponentId(String ComponentId) Set 控件编号
void	setComponentName(String ComponentName) Set 控件名称
void	setComponentPage(Long ComponentPage) Set 参数控件所在页码，取值为：1-N
void	setComponentPosX(Float ComponentPosX) Set 参数控件X位置，单位px
void	setComponentPosY(Float ComponentPosY) Set 参数控件Y位置，单位px
void	setComponentRecipientId(String ComponentRecipientId) Set 控件关联的签署人ID
void	setComponentRequired(Boolean ComponentRequired) Set 是否必选，默认为false
void	setComponentType(String ComponentType) Set 如果是 Component 控件类型，则可选类型为： TEXT - 内容文本控件 DATE - 内容日期控件 SELECT - 勾选框控件 如果是 SignComponent 控件类型，则可选类型为： SIGN_SEAL - 签署印章控件 SIGN_DATE - 签署日期控件 SIGN_SIGNATURE - 手写签名控件
void	setComponentValue(String ComponentValue) Set 控件所填写的内容
void	setComponentWidth(Float ComponentWidth) Set 参数控件宽度，单位px
void	setFileIndex(Long FileIndex) Set 控件所属文件的序号（模板中的resourceId排列序号，取值为：0-N）
void	setGenerateMode(String GenerateMode) Set NORMAL 正常模式，使用坐标制定签署控件位置 FIELD 表单域，需使用ComponentName指定表单域名称 KEYWORD 关键字，使用ComponentId指定关键字
void	setIsFormType(Boolean IsFormType) Set 是否是表单域类型，默认不存在
void	toMap(HashMap<String,String> map, String prefix) Internal implementation, normal users should not use it.

Methods inherited from class com.tencentcloudapi.common.AbstractModel

any, fromJsonString, getBinaryParams, getMultipartRequestParams, set, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, toJsonString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Component

public Component()

Component

public Component(Component source)

NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

Method Detail

getComponentType

public String getComponentType()

Get 如果是 Component 控件类型，则可选类型为： TEXT - 内容文本控件 DATE - 内容日期控件 SELECT - 勾选框控件 如果是 SignComponent 控件类型，则可选类型为： SIGN_SEAL - 签署印章控件 SIGN_DATE - 签署日期控件 SIGN_SIGNATURE - 手写签名控件

Returns:

ComponentType 如果是 Component 控件类型，则可选类型为： TEXT - 内容文本控件 DATE - 内容日期控件 SELECT - 勾选框控件 如果是 SignComponent 控件类型，则可选类型为： SIGN_SEAL - 签署印章控件 SIGN_DATE - 签署日期控件 SIGN_SIGNATURE - 手写签名控件

setComponentType

public void setComponentType(String ComponentType)

Set 如果是 Component 控件类型，则可选类型为： TEXT - 内容文本控件 DATE - 内容日期控件 SELECT - 勾选框控件 如果是 SignComponent 控件类型，则可选类型为： SIGN_SEAL - 签署印章控件 SIGN_DATE - 签署日期控件 SIGN_SIGNATURE - 手写签名控件

Parameters:

ComponentType - 如果是 Component 控件类型，则可选类型为： TEXT - 内容文本控件 DATE - 内容日期控件 SELECT - 勾选框控件 如果是 SignComponent 控件类型，则可选类型为： SIGN_SEAL - 签署印章控件 SIGN_DATE - 签署日期控件 SIGN_SIGNATURE - 手写签名控件

getComponentWidth

public Float getComponentWidth()

Get 参数控件宽度，单位px

Returns:

ComponentWidth 参数控件宽度，单位px

setComponentWidth

public void setComponentWidth(Float ComponentWidth)

Set 参数控件宽度，单位px

Parameters:

ComponentWidth - 参数控件宽度，单位px

getComponentHeight

public Float getComponentHeight()

Get 参数控件高度，单位px

Returns:

ComponentHeight 参数控件高度，单位px

setComponentHeight

public void setComponentHeight(Float ComponentHeight)

Set 参数控件高度，单位px

Parameters:

ComponentHeight - 参数控件高度，单位px

getComponentPage

public Long getComponentPage()

Get 参数控件所在页码，取值为：1-N

Returns:

ComponentPage 参数控件所在页码，取值为：1-N

setComponentPage

public void setComponentPage(Long ComponentPage)

Set 参数控件所在页码，取值为：1-N

Parameters:

ComponentPage - 参数控件所在页码，取值为：1-N

getComponentPosX

public Float getComponentPosX()

Get 参数控件X位置，单位px

Returns:

ComponentPosX 参数控件X位置，单位px

setComponentPosX

public void setComponentPosX(Float ComponentPosX)

Set 参数控件X位置，单位px

Parameters:

ComponentPosX - 参数控件X位置，单位px

getComponentPosY

public Float getComponentPosY()

Get 参数控件Y位置，单位px

Returns:

ComponentPosY 参数控件Y位置，单位px

setComponentPosY

public void setComponentPosY(Float ComponentPosY)

Set 参数控件Y位置，单位px

Parameters:

ComponentPosY - 参数控件Y位置，单位px

getFileIndex

public Long getFileIndex()

Get 控件所属文件的序号（模板中的resourceId排列序号，取值为：0-N）

Returns:

FileIndex 控件所属文件的序号（模板中的resourceId排列序号，取值为：0-N）

setFileIndex

public void setFileIndex(Long FileIndex)

Set 控件所属文件的序号（模板中的resourceId排列序号，取值为：0-N）

Parameters:

FileIndex - 控件所属文件的序号（模板中的resourceId排列序号，取值为：0-N）

getComponentId

public String getComponentId()

Get 控件编号

Returns:

ComponentId 控件编号

setComponentId

public void setComponentId(String ComponentId)

Set 控件编号

Parameters:

ComponentId - 控件编号

getComponentName

public String getComponentName()

Get 控件名称

Returns:

ComponentName 控件名称

setComponentName

public void setComponentName(String ComponentName)

Set 控件名称

Parameters:

ComponentName - 控件名称

getComponentRequired

public Boolean getComponentRequired()

Get 是否必选，默认为false

Returns:

ComponentRequired 是否必选，默认为false

setComponentRequired

public void setComponentRequired(Boolean ComponentRequired)

Set 是否必选，默认为false

Parameters:

ComponentRequired - 是否必选，默认为false

getComponentExtra

public String getComponentExtra()

Get 参数控件样式

Returns:

ComponentExtra 参数控件样式

setComponentExtra

public void setComponentExtra(String ComponentExtra)

Set 参数控件样式

Parameters:

ComponentExtra - 参数控件样式

getComponentRecipientId

public String getComponentRecipientId()

Get 控件关联的签署人ID

Returns:

ComponentRecipientId 控件关联的签署人ID

setComponentRecipientId

public void setComponentRecipientId(String ComponentRecipientId)

Set 控件关联的签署人ID

Parameters:

ComponentRecipientId - 控件关联的签署人ID

getComponentValue

public String getComponentValue()

Get 控件所填写的内容

Returns:

ComponentValue 控件所填写的内容

setComponentValue

public void setComponentValue(String ComponentValue)

Set 控件所填写的内容

Parameters:

ComponentValue - 控件所填写的内容

getIsFormType

public Boolean getIsFormType()

Get 是否是表单域类型，默认不存在

Returns:

IsFormType 是否是表单域类型，默认不存在

setIsFormType

public void setIsFormType(Boolean IsFormType)

Set 是否是表单域类型，默认不存在

Parameters:

IsFormType - 是否是表单域类型，默认不存在

getGenerateMode

public String getGenerateMode()

Get NORMAL 正常模式，使用坐标制定签署控件位置 FIELD 表单域，需使用ComponentName指定表单域名称 KEYWORD 关键字，使用ComponentId指定关键字

Returns:

GenerateMode NORMAL 正常模式，使用坐标制定签署控件位置 FIELD 表单域，需使用ComponentName指定表单域名称 KEYWORD 关键字，使用ComponentId指定关键字

setGenerateMode

public void setGenerateMode(String GenerateMode)

Set NORMAL 正常模式，使用坐标制定签署控件位置 FIELD 表单域，需使用ComponentName指定表单域名称 KEYWORD 关键字，使用ComponentId指定关键字

Parameters:

GenerateMode - NORMAL 正常模式，使用坐标制定签署控件位置 FIELD 表单域，需使用ComponentName指定表单域名称 KEYWORD 关键字，使用ComponentId指定关键字

getComponentDateFontSize

public Long getComponentDateFontSize()

Get 日期控件类型字号

Returns:

ComponentDateFontSize 日期控件类型字号

setComponentDateFontSize

public void setComponentDateFontSize(Long ComponentDateFontSize)

Set 日期控件类型字号

Parameters:

ComponentDateFontSize - 日期控件类型字号

toMap

public void toMap(HashMap<String,String> map,
                  String prefix)

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel