Component (tencentcloud-sdk-java 3.1.576 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractModel
- - com.tencentcloudapi.essbasic.v20210526.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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Long`	`getComponentDateFontSize()` Get 日期签署控件的字号，默认为 12 签署区日期控件会转换成图片格式并带存证，需要通过字体决定图片大小
`String`	`getComponentDescription()` Get 控件描述，不能超过30个字符
`String`	`getComponentExtra()` Get 参数控件样式，json格式表述不同类型的控件会有部分非通用参数 TEXT控件可以指定字体例如：{"FontSize":12}
`Float`	`getComponentHeight()` Get 参数控件高度，默认100，单位px 表单域和关键字转换控件不用填
`String`	`getComponentId()` Get 控件编号注：当GenerateMode=3时，通过"^"来决定是否使用关键字整词匹配能力。例：当GenerateMode=3时，如果传入关键字"^甲方签署^"，则会在PDF文件中有且仅有"甲方签署"关键字的地方进行对应操作。如传入的关键字为"甲方签署"，则PDF文件中每个出现关键字的位置都会执行相应操作。创建控件时，此值为空查询时返回完整结构
`String`	`getComponentName()` Get 控件简称，不能超过30个字符
`Long`	`getComponentPage()` Get 参数控件所在页码，从1开始
`Float`	`getComponentPosX()` Get 参数控件X位置，单位px
`Float`	`getComponentPosY()` Get 参数控件Y位置，单位px
`Boolean`	`getComponentRequired()` Get 定义控件是否为必填项，默认为false
`String`	`getComponentType()` Get 如果是Component控件类型，则可选的字段为： TEXT - 普通文本控件； MULTI_LINE_TEXT - 多行文本控件； CHECK_BOX - 勾选框控件； FILL_IMAGE - 图片控件； DYNAMIC_TABLE - 动态表格控件； ATTACHMENT - 附件控件； SELECTOR - 选择器控件；如果是SignComponent控件类型，则可选的字段为 SIGN_SEAL - 签署印章控件； SIGN_DATE - 签署日期控件； SIGN_SIGNATURE - 用户签名控件； SIGN_PERSONAL_SEAL - 个人签署印章控件（使用文件发起暂不支持此类型）；表单域的控件不能作为印章和签名控件
`String`	`getComponentValue()` Get 控件填充vaule，ComponentType和传入值类型对应关系： TEXT - 文本内容 MULTI_LINE_TEXT - 文本内容 CHECK_BOX - true/false FILL_IMAGE、ATTACHMENT - 附件的FileId，需要通过UploadFiles接口上传获取 SELECTOR - 选项值 DYNAMIC_TABLE - 传入json格式的表格内容，具体见数据结构FlowInfo：https://cloud.tencent.com/document/api/1420/61525#FlowInfo
`Float`	`getComponentWidth()` Get 参数控件宽度，默认100，单位px 表单域和关键字转换控件不用填
`String`	`getDocumentId()` Get 控件所属文档的Id, 模块相关接口为空值
`Long`	`getFileIndex()` Get 控件所属文件的序号 (文档中文件的排列序号，从0开始)
`String`	`getGenerateMode()` Get 控件生成的方式： NORMAL - 普通控件 FIELD - 表单域 KEYWORD - 关键字
`Float`	`getOffsetX()` Get 指定关键字时横坐标偏移量，单位pt
`Float`	`getOffsetY()` Get 指定关键字时纵坐标偏移量，单位pt
`void`	`setComponentDateFontSize(Long ComponentDateFontSize)` Set 日期签署控件的字号，默认为 12 签署区日期控件会转换成图片格式并带存证，需要通过字体决定图片大小
`void`	`setComponentDescription(String ComponentDescription)` Set 控件描述，不能超过30个字符
`void`	`setComponentExtra(String ComponentExtra)` Set 参数控件样式，json格式表述不同类型的控件会有部分非通用参数 TEXT控件可以指定字体例如：{"FontSize":12}
`void`	`setComponentHeight(Float ComponentHeight)` Set 参数控件高度，默认100，单位px 表单域和关键字转换控件不用填
`void`	`setComponentId(String ComponentId)` Set 控件编号注：当GenerateMode=3时，通过"^"来决定是否使用关键字整词匹配能力。例：当GenerateMode=3时，如果传入关键字"^甲方签署^"，则会在PDF文件中有且仅有"甲方签署"关键字的地方进行对应操作。如传入的关键字为"甲方签署"，则PDF文件中每个出现关键字的位置都会执行相应操作。创建控件时，此值为空查询时返回完整结构
`void`	`setComponentName(String ComponentName)` Set 控件简称，不能超过30个字符
`void`	`setComponentPage(Long ComponentPage)` Set 参数控件所在页码，从1开始
`void`	`setComponentPosX(Float ComponentPosX)` Set 参数控件X位置，单位px
`void`	`setComponentPosY(Float ComponentPosY)` Set 参数控件Y位置，单位px
`void`	`setComponentRequired(Boolean ComponentRequired)` Set 定义控件是否为必填项，默认为false
`void`	`setComponentType(String ComponentType)` Set 如果是Component控件类型，则可选的字段为： TEXT - 普通文本控件； MULTI_LINE_TEXT - 多行文本控件； CHECK_BOX - 勾选框控件； FILL_IMAGE - 图片控件； DYNAMIC_TABLE - 动态表格控件； ATTACHMENT - 附件控件； SELECTOR - 选择器控件；如果是SignComponent控件类型，则可选的字段为 SIGN_SEAL - 签署印章控件； SIGN_DATE - 签署日期控件； SIGN_SIGNATURE - 用户签名控件； SIGN_PERSONAL_SEAL - 个人签署印章控件（使用文件发起暂不支持此类型）；表单域的控件不能作为印章和签名控件
`void`	`setComponentValue(String ComponentValue)` Set 控件填充vaule，ComponentType和传入值类型对应关系： TEXT - 文本内容 MULTI_LINE_TEXT - 文本内容 CHECK_BOX - true/false FILL_IMAGE、ATTACHMENT - 附件的FileId，需要通过UploadFiles接口上传获取 SELECTOR - 选项值 DYNAMIC_TABLE - 传入json格式的表格内容，具体见数据结构FlowInfo：https://cloud.tencent.com/document/api/1420/61525#FlowInfo
`void`	`setComponentWidth(Float ComponentWidth)` Set 参数控件宽度，默认100，单位px 表单域和关键字转换控件不用填
`void`	`setDocumentId(String DocumentId)` Set 控件所属文档的Id, 模块相关接口为空值
`void`	`setFileIndex(Long FileIndex)` Set 控件所属文件的序号 (文档中文件的排列序号，从0开始)
`void`	`setGenerateMode(String GenerateMode)` Set 控件生成的方式： NORMAL - 普通控件 FIELD - 表单域 KEYWORD - 关键字
`void`	`setOffsetX(Float OffsetX)` Set 指定关键字时横坐标偏移量，单位pt
`void`	`setOffsetY(Float OffsetY)` Set 指定关键字时纵坐标偏移量，单位pt
`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
  - getComponentId
```
public String getComponentId()
```
    Get 控件编号注：当GenerateMode=3时，通过"^"来决定是否使用关键字整词匹配能力。例：当GenerateMode=3时，如果传入关键字"^甲方签署^"，则会在PDF文件中有且仅有"甲方签署"关键字的地方进行对应操作。如传入的关键字为"甲方签署"，则PDF文件中每个出现关键字的位置都会执行相应操作。创建控件时，此值为空查询时返回完整结构
    
    Returns:
    
    ComponentId 控件编号注：当GenerateMode=3时，通过"^"来决定是否使用关键字整词匹配能力。例：当GenerateMode=3时，如果传入关键字"^甲方签署^"，则会在PDF文件中有且仅有"甲方签署"关键字的地方进行对应操作。如传入的关键字为"甲方签署"，则PDF文件中每个出现关键字的位置都会执行相应操作。创建控件时，此值为空查询时返回完整结构
  - setComponentId
```
public void setComponentId(String ComponentId)
```
    Set 控件编号注：当GenerateMode=3时，通过"^"来决定是否使用关键字整词匹配能力。例：当GenerateMode=3时，如果传入关键字"^甲方签署^"，则会在PDF文件中有且仅有"甲方签署"关键字的地方进行对应操作。如传入的关键字为"甲方签署"，则PDF文件中每个出现关键字的位置都会执行相应操作。创建控件时，此值为空查询时返回完整结构
    
    Parameters:
    
    ComponentId - 控件编号注：当GenerateMode=3时，通过"^"来决定是否使用关键字整词匹配能力。例：当GenerateMode=3时，如果传入关键字"^甲方签署^"，则会在PDF文件中有且仅有"甲方签署"关键字的地方进行对应操作。如传入的关键字为"甲方签署"，则PDF文件中每个出现关键字的位置都会执行相应操作。创建控件时，此值为空查询时返回完整结构
  - getComponentType
```
public String getComponentType()
```
    Get 如果是Component控件类型，则可选的字段为： TEXT - 普通文本控件； MULTI_LINE_TEXT - 多行文本控件； CHECK_BOX - 勾选框控件； FILL_IMAGE - 图片控件； DYNAMIC_TABLE - 动态表格控件； ATTACHMENT - 附件控件； SELECTOR - 选择器控件；如果是SignComponent控件类型，则可选的字段为 SIGN_SEAL - 签署印章控件； SIGN_DATE - 签署日期控件； SIGN_SIGNATURE - 用户签名控件； SIGN_PERSONAL_SEAL - 个人签署印章控件（使用文件发起暂不支持此类型）；表单域的控件不能作为印章和签名控件
    
    Returns:
    
    ComponentType 如果是Component控件类型，则可选的字段为： TEXT - 普通文本控件； MULTI_LINE_TEXT - 多行文本控件； CHECK_BOX - 勾选框控件； FILL_IMAGE - 图片控件； DYNAMIC_TABLE - 动态表格控件； ATTACHMENT - 附件控件； SELECTOR - 选择器控件；如果是SignComponent控件类型，则可选的字段为 SIGN_SEAL - 签署印章控件； SIGN_DATE - 签署日期控件； SIGN_SIGNATURE - 用户签名控件； SIGN_PERSONAL_SEAL - 个人签署印章控件（使用文件发起暂不支持此类型）；表单域的控件不能作为印章和签名控件
  - setComponentType
```
public void setComponentType(String ComponentType)
```
    Set 如果是Component控件类型，则可选的字段为： TEXT - 普通文本控件； MULTI_LINE_TEXT - 多行文本控件； CHECK_BOX - 勾选框控件； FILL_IMAGE - 图片控件； DYNAMIC_TABLE - 动态表格控件； ATTACHMENT - 附件控件； SELECTOR - 选择器控件；如果是SignComponent控件类型，则可选的字段为 SIGN_SEAL - 签署印章控件； SIGN_DATE - 签署日期控件； SIGN_SIGNATURE - 用户签名控件； SIGN_PERSONAL_SEAL - 个人签署印章控件（使用文件发起暂不支持此类型）；表单域的控件不能作为印章和签名控件
    
    Parameters:
    
    ComponentType - 如果是Component控件类型，则可选的字段为： TEXT - 普通文本控件； MULTI_LINE_TEXT - 多行文本控件； CHECK_BOX - 勾选框控件； FILL_IMAGE - 图片控件； DYNAMIC_TABLE - 动态表格控件； ATTACHMENT - 附件控件； SELECTOR - 选择器控件；如果是SignComponent控件类型，则可选的字段为 SIGN_SEAL - 签署印章控件； SIGN_DATE - 签署日期控件； SIGN_SIGNATURE - 用户签名控件； SIGN_PERSONAL_SEAL - 个人签署印章控件（使用文件发起暂不支持此类型）；表单域的控件不能作为印章和签名控件
  - getComponentName
```
public String getComponentName()
```
    Get 控件简称，不能超过30个字符
    
    Returns:
    
    ComponentName 控件简称，不能超过30个字符
  - setComponentName
```
public void setComponentName(String ComponentName)
```
    Set 控件简称，不能超过30个字符
    
    Parameters:
    
    ComponentName - 控件简称，不能超过30个字符
  - getComponentRequired
```
public Boolean getComponentRequired()
```
    Get 定义控件是否为必填项，默认为false
    
    Returns:
    
    ComponentRequired 定义控件是否为必填项，默认为false
  - setComponentRequired
```
public void setComponentRequired(Boolean ComponentRequired)
```
    Set 定义控件是否为必填项，默认为false
    
    Parameters:
    
    ComponentRequired - 定义控件是否为必填项，默认为false
  - getFileIndex
```
public Long getFileIndex()
```
    Get 控件所属文件的序号 (文档中文件的排列序号，从0开始)
    
    Returns:
    
    FileIndex 控件所属文件的序号 (文档中文件的排列序号，从0开始)
  - setFileIndex
```
public void setFileIndex(Long FileIndex)
```
    Set 控件所属文件的序号 (文档中文件的排列序号，从0开始)
    
    Parameters:
    
    FileIndex - 控件所属文件的序号 (文档中文件的排列序号，从0开始)
  - getGenerateMode
```
public String getGenerateMode()
```
    Get 控件生成的方式： NORMAL - 普通控件 FIELD - 表单域 KEYWORD - 关键字
    
    Returns:
    
    GenerateMode 控件生成的方式： NORMAL - 普通控件 FIELD - 表单域 KEYWORD - 关键字
  - setGenerateMode
```
public void setGenerateMode(String GenerateMode)
```
    Set 控件生成的方式： NORMAL - 普通控件 FIELD - 表单域 KEYWORD - 关键字
    
    Parameters:
    
    GenerateMode - 控件生成的方式： NORMAL - 普通控件 FIELD - 表单域 KEYWORD - 关键字
  - getComponentWidth
```
public Float getComponentWidth()
```
    Get 参数控件宽度，默认100，单位px 表单域和关键字转换控件不用填
    
    Returns:
    
    ComponentWidth 参数控件宽度，默认100，单位px 表单域和关键字转换控件不用填
  - setComponentWidth
```
public void setComponentWidth(Float ComponentWidth)
```
    Set 参数控件宽度，默认100，单位px 表单域和关键字转换控件不用填
    
    Parameters:
    
    ComponentWidth - 参数控件宽度，默认100，单位px 表单域和关键字转换控件不用填
  - getComponentHeight
```
public Float getComponentHeight()
```
    Get 参数控件高度，默认100，单位px 表单域和关键字转换控件不用填
    
    Returns:
    
    ComponentHeight 参数控件高度，默认100，单位px 表单域和关键字转换控件不用填
  - setComponentHeight
```
public void setComponentHeight(Float ComponentHeight)
```
    Set 参数控件高度，默认100，单位px 表单域和关键字转换控件不用填
    
    Parameters:
    
    ComponentHeight - 参数控件高度，默认100，单位px 表单域和关键字转换控件不用填
  - getComponentPage
```
public Long getComponentPage()
```
    Get 参数控件所在页码，从1开始
    
    Returns:
    
    ComponentPage 参数控件所在页码，从1开始
  - setComponentPage
```
public void setComponentPage(Long ComponentPage)
```
    Set 参数控件所在页码，从1开始
    
    Parameters:
    
    ComponentPage - 参数控件所在页码，从1开始
  - 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
  - getComponentExtra
```
public String getComponentExtra()
```
    Get 参数控件样式，json格式表述不同类型的控件会有部分非通用参数 TEXT控件可以指定字体例如：{"FontSize":12}
    
    Returns:
    
    ComponentExtra 参数控件样式，json格式表述不同类型的控件会有部分非通用参数 TEXT控件可以指定字体例如：{"FontSize":12}
  - setComponentExtra
```
public void setComponentExtra(String ComponentExtra)
```
    Set 参数控件样式，json格式表述不同类型的控件会有部分非通用参数 TEXT控件可以指定字体例如：{"FontSize":12}
    
    Parameters:
    
    ComponentExtra - 参数控件样式，json格式表述不同类型的控件会有部分非通用参数 TEXT控件可以指定字体例如：{"FontSize":12}
  - getComponentValue
```
public String getComponentValue()
```
    Get 控件填充vaule，ComponentType和传入值类型对应关系： TEXT - 文本内容 MULTI_LINE_TEXT - 文本内容 CHECK_BOX - true/false FILL_IMAGE、ATTACHMENT - 附件的FileId，需要通过UploadFiles接口上传获取 SELECTOR - 选项值 DYNAMIC_TABLE - 传入json格式的表格内容，具体见数据结构FlowInfo：https://cloud.tencent.com/document/api/1420/61525#FlowInfo
    
    Returns:
    
    ComponentValue 控件填充vaule，ComponentType和传入值类型对应关系： TEXT - 文本内容 MULTI_LINE_TEXT - 文本内容 CHECK_BOX - true/false FILL_IMAGE、ATTACHMENT - 附件的FileId，需要通过UploadFiles接口上传获取 SELECTOR - 选项值 DYNAMIC_TABLE - 传入json格式的表格内容，具体见数据结构FlowInfo：https://cloud.tencent.com/document/api/1420/61525#FlowInfo
  - setComponentValue
```
public void setComponentValue(String ComponentValue)
```
    Set 控件填充vaule，ComponentType和传入值类型对应关系： TEXT - 文本内容 MULTI_LINE_TEXT - 文本内容 CHECK_BOX - true/false FILL_IMAGE、ATTACHMENT - 附件的FileId，需要通过UploadFiles接口上传获取 SELECTOR - 选项值 DYNAMIC_TABLE - 传入json格式的表格内容，具体见数据结构FlowInfo：https://cloud.tencent.com/document/api/1420/61525#FlowInfo
    
    Parameters:
    
    ComponentValue - 控件填充vaule，ComponentType和传入值类型对应关系： TEXT - 文本内容 MULTI_LINE_TEXT - 文本内容 CHECK_BOX - true/false FILL_IMAGE、ATTACHMENT - 附件的FileId，需要通过UploadFiles接口上传获取 SELECTOR - 选项值 DYNAMIC_TABLE - 传入json格式的表格内容，具体见数据结构FlowInfo：https://cloud.tencent.com/document/api/1420/61525#FlowInfo
  - getComponentDateFontSize
```
public Long getComponentDateFontSize()
```
    Get 日期签署控件的字号，默认为 12 签署区日期控件会转换成图片格式并带存证，需要通过字体决定图片大小
    
    Returns:
    
    ComponentDateFontSize 日期签署控件的字号，默认为 12 签署区日期控件会转换成图片格式并带存证，需要通过字体决定图片大小
  - setComponentDateFontSize
```
public void setComponentDateFontSize(Long ComponentDateFontSize)
```
    Set 日期签署控件的字号，默认为 12 签署区日期控件会转换成图片格式并带存证，需要通过字体决定图片大小
    
    Parameters:
    
    ComponentDateFontSize - 日期签署控件的字号，默认为 12 签署区日期控件会转换成图片格式并带存证，需要通过字体决定图片大小
  - getDocumentId
```
public String getDocumentId()
```
    Get 控件所属文档的Id, 模块相关接口为空值
    
    Returns:
    
    DocumentId 控件所属文档的Id, 模块相关接口为空值
  - setDocumentId
```
public void setDocumentId(String DocumentId)
```
    Set 控件所属文档的Id, 模块相关接口为空值
    
    Parameters:
    
    DocumentId - 控件所属文档的Id, 模块相关接口为空值
  - getComponentDescription
```
public String getComponentDescription()
```
    Get 控件描述，不能超过30个字符
    
    Returns:
    
    ComponentDescription 控件描述，不能超过30个字符
  - setComponentDescription
```
public void setComponentDescription(String ComponentDescription)
```
    Set 控件描述，不能超过30个字符
    
    Parameters:
    
    ComponentDescription - 控件描述，不能超过30个字符
  - getOffsetX
```
public Float getOffsetX()
```
    Get 指定关键字时横坐标偏移量，单位pt
    
    Returns:
    
    OffsetX 指定关键字时横坐标偏移量，单位pt
  - setOffsetX
```
public void setOffsetX(Float OffsetX)
```
    Set 指定关键字时横坐标偏移量，单位pt
    
    Parameters:
    
    OffsetX - 指定关键字时横坐标偏移量，单位pt
  - getOffsetY
```
public Float getOffsetY()
```
    Get 指定关键字时纵坐标偏移量，单位pt
    
    Returns:
    
    OffsetY 指定关键字时纵坐标偏移量，单位pt
  - setOffsetY
```
public void setOffsetY(Float OffsetY)
```
    Set 指定关键字时纵坐标偏移量，单位pt
    
    Parameters:
    
    OffsetY - 指定关键字时纵坐标偏移量，单位pt
  - toMap
```
public void toMap(HashMap<String,String> map,
                  String prefix)
```
    Internal implementation, normal users should not use it.
    
    Specified by:
    
    toMap in class AbstractModel

Class Component

Constructor Summary

Method Summary

Methods inherited from class com.tencentcloudapi.common.AbstractModel

Methods inherited from class java.lang.Object

Constructor Detail

Component

Component

Method Detail

getComponentId

setComponentId

getComponentType

setComponentType

getComponentName

setComponentName

getComponentRequired

setComponentRequired

getFileIndex

setFileIndex

getGenerateMode

setGenerateMode

getComponentWidth

setComponentWidth

getComponentHeight

setComponentHeight

getComponentPage

setComponentPage

getComponentPosX

setComponentPosX

getComponentPosY

setComponentPosY

getComponentExtra

setComponentExtra

getComponentValue

setComponentValue

getComponentDateFontSize

setComponentDateFontSize

getDocumentId

setDocumentId

getComponentDescription

setComponentDescription

getOffsetX

setOffsetX

getOffsetY

setOffsetY

toMap