Package com.hellosign.openapi.model
Class TemplateResponseDocumentFormField
- java.lang.Object
-
- com.hellosign.openapi.model.TemplateResponseDocumentFormField
-
@Generated("org.openapitools.codegen.languages.JavaClientCodegen") public class TemplateResponseDocumentFormField extends java.lang.Object
TemplateResponseDocumentFormField
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
TemplateResponseDocumentFormField.TypeEnum
The type of this form field.
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
JSON_PROPERTY_API_ID
static java.lang.String
JSON_PROPERTY_AVG_TEXT_LENGTH
static java.lang.String
JSON_PROPERTY_FONT_FAMILY
static java.lang.String
JSON_PROPERTY_GROUP
static java.lang.String
JSON_PROPERTY_HEIGHT
static java.lang.String
JSON_PROPERTY_IS_MULTILINE
static java.lang.String
JSON_PROPERTY_NAME
static java.lang.String
JSON_PROPERTY_ORIGINAL_FONT_SIZE
static java.lang.String
JSON_PROPERTY_REQUIRED
static java.lang.String
JSON_PROPERTY_SIGNER
static java.lang.String
JSON_PROPERTY_TYPE
static java.lang.String
JSON_PROPERTY_WIDTH
static java.lang.String
JSON_PROPERTY_X
static java.lang.String
JSON_PROPERTY_Y
-
Constructor Summary
Constructors Constructor Description TemplateResponseDocumentFormField()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description TemplateResponseDocumentFormField
apiId(java.lang.String apiId)
TemplateResponseDocumentFormField
avgTextLength(TemplateResponseFieldAvgTextLength avgTextLength)
java.util.Map<java.lang.String,java.lang.Object>
createFormData()
boolean
equals(java.lang.Object o)
Return true if this TemplateResponseDocumentFormField object is equal to o.TemplateResponseDocumentFormField
fontFamily(java.lang.String fontFamily)
java.lang.String
getApiId()
A unique id for the form field.TemplateResponseFieldAvgTextLength
getAvgTextLength()
Get avgTextLengthjava.lang.String
getFontFamily()
Font family used in this form field's text.java.lang.String
getGroup()
The name of the group this field is in.java.lang.Integer
getHeight()
The height in pixels of this form field.java.lang.Boolean
getIsMultiline()
Whether this form field is multiline text.java.lang.String
getName()
The name of the form field.java.lang.Integer
getOriginalFontSize()
Original font size used in this form field's text.java.lang.Boolean
getRequired()
Boolean showing whether or not this field is required.java.lang.String
getSigner()
The signer of the Form Field.TemplateResponseDocumentFormField.TypeEnum
getType()
The type of this form field.java.lang.Integer
getWidth()
The width in pixels of this form field.java.lang.Integer
getX()
The horizontal offset in pixels for this form field.java.lang.Integer
getY()
The vertical offset in pixels for this form field.TemplateResponseDocumentFormField
group(java.lang.String group)
int
hashCode()
TemplateResponseDocumentFormField
height(java.lang.Integer height)
TemplateResponseDocumentFormField
isMultiline(java.lang.Boolean isMultiline)
TemplateResponseDocumentFormField
name(java.lang.String name)
TemplateResponseDocumentFormField
originalFontSize(java.lang.Integer originalFontSize)
TemplateResponseDocumentFormField
required(java.lang.Boolean required)
void
setApiId(java.lang.String apiId)
void
setAvgTextLength(TemplateResponseFieldAvgTextLength avgTextLength)
void
setFontFamily(java.lang.String fontFamily)
void
setGroup(java.lang.String group)
void
setHeight(java.lang.Integer height)
void
setIsMultiline(java.lang.Boolean isMultiline)
void
setName(java.lang.String name)
void
setOriginalFontSize(java.lang.Integer originalFontSize)
void
setRequired(java.lang.Boolean required)
void
setSigner(java.lang.String signer)
void
setType(TemplateResponseDocumentFormField.TypeEnum type)
void
setWidth(java.lang.Integer width)
void
setX(java.lang.Integer x)
void
setY(java.lang.Integer y)
TemplateResponseDocumentFormField
signer(java.lang.String signer)
java.lang.String
toString()
TemplateResponseDocumentFormField
type(TemplateResponseDocumentFormField.TypeEnum type)
TemplateResponseDocumentFormField
width(java.lang.Integer width)
TemplateResponseDocumentFormField
x(java.lang.Integer x)
TemplateResponseDocumentFormField
y(java.lang.Integer y)
-
-
-
Field Detail
-
JSON_PROPERTY_API_ID
public static final java.lang.String JSON_PROPERTY_API_ID
- See Also:
- Constant Field Values
-
JSON_PROPERTY_NAME
public static final java.lang.String JSON_PROPERTY_NAME
- See Also:
- Constant Field Values
-
JSON_PROPERTY_TYPE
public static final java.lang.String JSON_PROPERTY_TYPE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_SIGNER
public static final java.lang.String JSON_PROPERTY_SIGNER
- See Also:
- Constant Field Values
-
JSON_PROPERTY_X
public static final java.lang.String JSON_PROPERTY_X
- See Also:
- Constant Field Values
-
JSON_PROPERTY_Y
public static final java.lang.String JSON_PROPERTY_Y
- See Also:
- Constant Field Values
-
JSON_PROPERTY_WIDTH
public static final java.lang.String JSON_PROPERTY_WIDTH
- See Also:
- Constant Field Values
-
JSON_PROPERTY_HEIGHT
public static final java.lang.String JSON_PROPERTY_HEIGHT
- See Also:
- Constant Field Values
-
JSON_PROPERTY_REQUIRED
public static final java.lang.String JSON_PROPERTY_REQUIRED
- See Also:
- Constant Field Values
-
JSON_PROPERTY_GROUP
public static final java.lang.String JSON_PROPERTY_GROUP
- See Also:
- Constant Field Values
-
JSON_PROPERTY_AVG_TEXT_LENGTH
public static final java.lang.String JSON_PROPERTY_AVG_TEXT_LENGTH
- See Also:
- Constant Field Values
-
JSON_PROPERTY_IS_MULTILINE
public static final java.lang.String JSON_PROPERTY_IS_MULTILINE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_ORIGINAL_FONT_SIZE
public static final java.lang.String JSON_PROPERTY_ORIGINAL_FONT_SIZE
- See Also:
- Constant Field Values
-
JSON_PROPERTY_FONT_FAMILY
public static final java.lang.String JSON_PROPERTY_FONT_FAMILY
- See Also:
- Constant Field Values
-
-
Method Detail
-
apiId
public TemplateResponseDocumentFormField apiId(java.lang.String apiId)
-
getApiId
@Nullable public java.lang.String getApiId()
A unique id for the form field.- Returns:
- apiId
-
setApiId
public void setApiId(java.lang.String apiId)
-
name
public TemplateResponseDocumentFormField name(java.lang.String name)
-
getName
@Nullable public java.lang.String getName()
The name of the form field.- Returns:
- name
-
setName
public void setName(java.lang.String name)
-
type
public TemplateResponseDocumentFormField type(TemplateResponseDocumentFormField.TypeEnum type)
-
getType
@Nullable public TemplateResponseDocumentFormField.TypeEnum getType()
The type of this form field. See [field types](/api/reference/constants/#field-types).- Returns:
- type
-
setType
public void setType(TemplateResponseDocumentFormField.TypeEnum type)
-
signer
public TemplateResponseDocumentFormField signer(java.lang.String signer)
-
getSigner
@Nullable public java.lang.String getSigner()
The signer of the Form Field.- Returns:
- signer
-
setSigner
public void setSigner(java.lang.String signer)
-
x
public TemplateResponseDocumentFormField x(java.lang.Integer x)
-
getX
@Nullable public java.lang.Integer getX()
The horizontal offset in pixels for this form field.- Returns:
- x
-
setX
public void setX(java.lang.Integer x)
-
y
public TemplateResponseDocumentFormField y(java.lang.Integer y)
-
getY
@Nullable public java.lang.Integer getY()
The vertical offset in pixels for this form field.- Returns:
- y
-
setY
public void setY(java.lang.Integer y)
-
width
public TemplateResponseDocumentFormField width(java.lang.Integer width)
-
getWidth
@Nullable public java.lang.Integer getWidth()
The width in pixels of this form field.- Returns:
- width
-
setWidth
public void setWidth(java.lang.Integer width)
-
height
public TemplateResponseDocumentFormField height(java.lang.Integer height)
-
getHeight
@Nullable public java.lang.Integer getHeight()
The height in pixels of this form field.- Returns:
- height
-
setHeight
public void setHeight(java.lang.Integer height)
-
required
public TemplateResponseDocumentFormField required(java.lang.Boolean required)
-
getRequired
@Nullable public java.lang.Boolean getRequired()
Boolean showing whether or not this field is required.- Returns:
- required
-
setRequired
public void setRequired(java.lang.Boolean required)
-
group
public TemplateResponseDocumentFormField group(java.lang.String group)
-
getGroup
@Nullable public java.lang.String getGroup()
The name of the group this field is in. If this field is not a group, this defaults to `null`.- Returns:
- group
-
setGroup
public void setGroup(java.lang.String group)
-
avgTextLength
public TemplateResponseDocumentFormField avgTextLength(TemplateResponseFieldAvgTextLength avgTextLength)
-
getAvgTextLength
@Nullable public TemplateResponseFieldAvgTextLength getAvgTextLength()
Get avgTextLength- Returns:
- avgTextLength
-
setAvgTextLength
public void setAvgTextLength(TemplateResponseFieldAvgTextLength avgTextLength)
-
isMultiline
public TemplateResponseDocumentFormField isMultiline(java.lang.Boolean isMultiline)
-
getIsMultiline
@Nullable public java.lang.Boolean getIsMultiline()
Whether this form field is multiline text.- Returns:
- isMultiline
-
setIsMultiline
public void setIsMultiline(java.lang.Boolean isMultiline)
-
originalFontSize
public TemplateResponseDocumentFormField originalFontSize(java.lang.Integer originalFontSize)
-
getOriginalFontSize
@Nullable public java.lang.Integer getOriginalFontSize()
Original font size used in this form field's text.- Returns:
- originalFontSize
-
setOriginalFontSize
public void setOriginalFontSize(java.lang.Integer originalFontSize)
-
fontFamily
public TemplateResponseDocumentFormField fontFamily(java.lang.String fontFamily)
-
getFontFamily
@Nullable public java.lang.String getFontFamily()
Font family used in this form field's text.- Returns:
- fontFamily
-
setFontFamily
public void setFontFamily(java.lang.String fontFamily)
-
equals
public boolean equals(java.lang.Object o)
Return true if this TemplateResponseDocumentFormField object is equal to o.- Overrides:
equals
in classjava.lang.Object
-
hashCode
public int hashCode()
- Overrides:
hashCode
in classjava.lang.Object
-
toString
public java.lang.String toString()
- Overrides:
toString
in classjava.lang.Object
-
createFormData
public java.util.Map<java.lang.String,java.lang.Object> createFormData() throws ApiException
- Throws:
ApiException
-
-