Package com.tencentcloudapi.essbasic.v20201222.models

Class Component

    • Constructor Summary

      Constructors 
      Constructor 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 Description
      String getComponentExtra()
      Get 参数控件样式
      Float getComponentHeight()
      Get 参数控件高度，单位px
      String getComponentId()
      Get 控件编号 注： 当GenerateMode=3时，通过"^"来决定是否使用关键字整词匹配能力。 例： 当GenerateMode=3时，如果传入关键字"^甲方签署^"，则会在PDF文件中有且仅有"甲方签署"关键字的地方进行对应操作。 如传入的关键字为"甲方签署"，则PDF文件中每个出现关键字的位置都会执行相应操作。
      String getComponentName()
      Get 控件名称
      Long getComponentPage()
      Get 参数控件所在页码
      Float getComponentPosX()
      Get 参数控件X位置，单位px
      Float getComponentPosY()
      Get 参数控件Y位置，单位px
      Boolean getComponentRequired()
      Get 定义控件是否为必填项，默认为false
      String getComponentType()
      Get 如果是Component控件类型，则可选的字段为： TEXT - 普通文本控件； DATE - 普通日期控件； SELECT- 勾选框控件； 如果是SignComponent控件类型，则可选的字段为 SIGN_SEAL- 签署印章控件； SIGN_DATE- 签署日期控件； SIGN_SIGNATURE - 用户签名控件；
      String getComponentValue()
      Get 印章ID，如果是手写签名则为jpg或png格式的base64图片 SIGN_SEAL控件,可以用ORG_DEFAULT_SEAL表示主企业的默认印章 SIGN_SEAL控件,可以用SUBORG_DEFAULT_SEAL表示子企业的默认印章 SIGN_SEAL控件,可以用USER_DEFAULT_SEAL表示个人默认印章
      Float getComponentWidth()
      Get 参数控件宽度，单位px
      Long getFileIndex()
      Get 控件所属文件的序号 (模板中的resourceId排列序号)
      String getGenerateExtra()
      Get 不同GenerateMode对应的额外信息
      Long getGenerateMode()
      Get 控件生成的方式： 0 - 普通控件 1 - 表单域 2 - html 控件 3 - 关键字
      Long getSealOperate()
      Get 如果是SIGN_SEAL类型的签署控件, 参数标识H5签署界面是否在该签署区上进行放置展示, 1为放置,其他为不放置
      void setComponentExtra​(String ComponentExtra)
      Set 参数控件样式
      void setComponentHeight​(Float ComponentHeight)
      Set 参数控件高度，单位px
      void setComponentId​(String ComponentId)
      Set 控件编号 注： 当GenerateMode=3时，通过"^"来决定是否使用关键字整词匹配能力。 例： 当GenerateMode=3时，如果传入关键字"^甲方签署^"，则会在PDF文件中有且仅有"甲方签署"关键字的地方进行对应操作。 如传入的关键字为"甲方签署"，则PDF文件中每个出现关键字的位置都会执行相应操作。
      void setComponentName​(String ComponentName)
      Set 控件名称
      void setComponentPage​(Long ComponentPage)
      Set 参数控件所在页码
      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 - 普通文本控件； DATE - 普通日期控件； SELECT- 勾选框控件； 如果是SignComponent控件类型，则可选的字段为 SIGN_SEAL- 签署印章控件； SIGN_DATE- 签署日期控件； SIGN_SIGNATURE - 用户签名控件；
      void setComponentValue​(String ComponentValue)
      Set 印章ID，如果是手写签名则为jpg或png格式的base64图片 SIGN_SEAL控件,可以用ORG_DEFAULT_SEAL表示主企业的默认印章 SIGN_SEAL控件,可以用SUBORG_DEFAULT_SEAL表示子企业的默认印章 SIGN_SEAL控件,可以用USER_DEFAULT_SEAL表示个人默认印章
      void setComponentWidth​(Float ComponentWidth)
      Set 参数控件宽度，单位px
      void setFileIndex​(Long FileIndex)
      Set 控件所属文件的序号 (模板中的resourceId排列序号)
      void setGenerateExtra​(String GenerateExtra)
      Set 不同GenerateMode对应的额外信息
      void setGenerateMode​(Long GenerateMode)
      Set 控件生成的方式： 0 - 普通控件 1 - 表单域 2 - html 控件 3 - 关键字
      void setSealOperate​(Long SealOperate)
      Set 如果是SIGN_SEAL类型的签署控件, 参数标识H5签署界面是否在该签署区上进行放置展示, 1为放置,其他为不放置
      void toMap​(HashMap<String,​String> map, String prefix)
      Internal implementation, normal users should not use it.

    • 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 - 普通文本控件； 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 - 用户签名控件；

      • 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

      • getFileIndex

        public Long getFileIndex()
        Get 控件所属文件的序号 (模板中的resourceId排列序号)
        Returns:
        FileIndex 控件所属文件的序号 (模板中的resourceId排列序号)

      • setFileIndex

        public void setFileIndex​(Long FileIndex)
        Set 控件所属文件的序号 (模板中的resourceId排列序号)
        Parameters:
        FileIndex - 控件所属文件的序号 (模板中的resourceId排列序号)

      • getGenerateMode

        public Long getGenerateMode()
        Get 控件生成的方式： 0 - 普通控件 1 - 表单域 2 - html 控件 3 - 关键字
        Returns:
        GenerateMode 控件生成的方式： 0 - 普通控件 1 - 表单域 2 - html 控件 3 - 关键字

      • setGenerateMode

        public void setGenerateMode​(Long GenerateMode)
        Set 控件生成的方式： 0 - 普通控件 1 - 表单域 2 - html 控件 3 - 关键字
        Parameters:
        GenerateMode - 控件生成的方式： 0 - 普通控件 1 - 表单域 2 - html 控件 3 - 关键字

      • 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 参数控件所在页码
        Returns:
        ComponentPage 参数控件所在页码

      • setComponentPage

        public void setComponentPage​(Long ComponentPage)
        Set 参数控件所在页码
        Parameters:
        ComponentPage - 参数控件所在页码

      • 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 参数控件样式
        Returns:
        ComponentExtra 参数控件样式

      • setComponentExtra

        public void setComponentExtra​(String ComponentExtra)
        Set 参数控件样式
        Parameters:
        ComponentExtra - 参数控件样式

      • getComponentValue

        public String getComponentValue()
        Get 印章ID，如果是手写签名则为jpg或png格式的base64图片 SIGN_SEAL控件,可以用ORG_DEFAULT_SEAL表示主企业的默认印章 SIGN_SEAL控件,可以用SUBORG_DEFAULT_SEAL表示子企业的默认印章 SIGN_SEAL控件,可以用USER_DEFAULT_SEAL表示个人默认印章
        Returns:
        ComponentValue 印章ID，如果是手写签名则为jpg或png格式的base64图片 SIGN_SEAL控件,可以用ORG_DEFAULT_SEAL表示主企业的默认印章 SIGN_SEAL控件,可以用SUBORG_DEFAULT_SEAL表示子企业的默认印章 SIGN_SEAL控件,可以用USER_DEFAULT_SEAL表示个人默认印章

      • setComponentValue

        public void setComponentValue​(String ComponentValue)
        Set 印章ID，如果是手写签名则为jpg或png格式的base64图片 SIGN_SEAL控件,可以用ORG_DEFAULT_SEAL表示主企业的默认印章 SIGN_SEAL控件,可以用SUBORG_DEFAULT_SEAL表示子企业的默认印章 SIGN_SEAL控件,可以用USER_DEFAULT_SEAL表示个人默认印章
        Parameters:
        ComponentValue - 印章ID，如果是手写签名则为jpg或png格式的base64图片 SIGN_SEAL控件,可以用ORG_DEFAULT_SEAL表示主企业的默认印章 SIGN_SEAL控件,可以用SUBORG_DEFAULT_SEAL表示子企业的默认印章 SIGN_SEAL控件,可以用USER_DEFAULT_SEAL表示个人默认印章

      • getSealOperate

        public Long getSealOperate()
        Get 如果是SIGN_SEAL类型的签署控件, 参数标识H5签署界面是否在该签署区上进行放置展示, 1为放置,其他为不放置
        Returns:
        SealOperate 如果是SIGN_SEAL类型的签署控件, 参数标识H5签署界面是否在该签署区上进行放置展示, 1为放置,其他为不放置

      • setSealOperate

        public void setSealOperate​(Long SealOperate)
        Set 如果是SIGN_SEAL类型的签署控件, 参数标识H5签署界面是否在该签署区上进行放置展示, 1为放置,其他为不放置
        Parameters:
        SealOperate - 如果是SIGN_SEAL类型的签署控件, 参数标识H5签署界面是否在该签署区上进行放置展示, 1为放置,其他为不放置

      • getGenerateExtra

        public String getGenerateExtra()
        Get 不同GenerateMode对应的额外信息
        Returns:
        GenerateExtra 不同GenerateMode对应的额外信息

      • setGenerateExtra

        public void setGenerateExtra​(String GenerateExtra)
        Set 不同GenerateMode对应的额外信息
        Parameters:
        GenerateExtra - 不同GenerateMode对应的额外信息