Package com.boldsign.model
Class FormField
- java.lang.Object
-
- com.boldsign.model.FormField
-
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.8.0") public class FormField extends Object
FormField
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classFormField.CustomTypeAdapterFactorystatic classFormField.FieldTypeEnumGets or Sets fieldTypestatic classFormField.FontEnumGets or Sets fontstatic classFormField.ResizeOptionEnumGets or Sets resizeOptionstatic classFormField.TextAlignEnumGets or Sets textAlignstatic classFormField.TextDirectionEnumGets or Sets textDirectionstatic classFormField.ValidationTypeEnumGets or Sets validationType
-
Field Summary
-
Constructor Summary
Constructors Constructor Description FormField()
-
Method Summary
-
-
-
Field Detail
-
SERIALIZED_NAME_FIELD_TYPE
public static final String SERIALIZED_NAME_FIELD_TYPE
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_PAGE_NUMBER
public static final String SERIALIZED_NAME_PAGE_NUMBER
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_BOUNDS
public static final String SERIALIZED_NAME_BOUNDS
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_ID
public static final String SERIALIZED_NAME_ID
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_NAME
public static final String SERIALIZED_NAME_NAME
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_IS_REQUIRED
public static final String SERIALIZED_NAME_IS_REQUIRED
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_IS_READ_ONLY
public static final String SERIALIZED_NAME_IS_READ_ONLY
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_VALUE
public static final String SERIALIZED_NAME_VALUE
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_FONT_SIZE
public static final String SERIALIZED_NAME_FONT_SIZE
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_FONT
public static final String SERIALIZED_NAME_FONT
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_FONT_HEX_COLOR
public static final String SERIALIZED_NAME_FONT_HEX_COLOR
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_IS_BOLD_FONT
public static final String SERIALIZED_NAME_IS_BOLD_FONT
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_IS_ITALIC_FONT
public static final String SERIALIZED_NAME_IS_ITALIC_FONT
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_IS_UNDER_LINE_FONT
public static final String SERIALIZED_NAME_IS_UNDER_LINE_FONT
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_LINE_HEIGHT
public static final String SERIALIZED_NAME_LINE_HEIGHT
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_CHARACTER_LIMIT
public static final String SERIALIZED_NAME_CHARACTER_LIMIT
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_GROUP_NAME
public static final String SERIALIZED_NAME_GROUP_NAME
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_LABEL
public static final String SERIALIZED_NAME_LABEL
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_PLACE_HOLDER
public static final String SERIALIZED_NAME_PLACE_HOLDER
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_VALIDATION_TYPE
public static final String SERIALIZED_NAME_VALIDATION_TYPE
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_VALIDATION_CUSTOM_REGEX
public static final String SERIALIZED_NAME_VALIDATION_CUSTOM_REGEX
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_VALIDATION_CUSTOM_REGEX_MESSAGE
public static final String SERIALIZED_NAME_VALIDATION_CUSTOM_REGEX_MESSAGE
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_DATE_FORMAT
public static final String SERIALIZED_NAME_DATE_FORMAT
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_TIME_FORMAT
public static final String SERIALIZED_NAME_TIME_FORMAT
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_IMAGE_INFO
public static final String SERIALIZED_NAME_IMAGE_INFO
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_ATTACHMENT_INFO
public static final String SERIALIZED_NAME_ATTACHMENT_INFO
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_EDITABLE_DATE_FIELD_SETTINGS
public static final String SERIALIZED_NAME_EDITABLE_DATE_FIELD_SETTINGS
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_HYPERLINK_TEXT
public static final String SERIALIZED_NAME_HYPERLINK_TEXT
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_CONDITIONAL_RULES
public static final String SERIALIZED_NAME_CONDITIONAL_RULES
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_DATA_SYNC_TAG
public static final String SERIALIZED_NAME_DATA_SYNC_TAG
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_DROPDOWN_OPTIONS
public static final String SERIALIZED_NAME_DROPDOWN_OPTIONS
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_TEXT_ALIGN
public static final String SERIALIZED_NAME_TEXT_ALIGN
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_TEXT_DIRECTION
public static final String SERIALIZED_NAME_TEXT_DIRECTION
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_CHARACTER_SPACING
public static final String SERIALIZED_NAME_CHARACTER_SPACING
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_BACKGROUND_HEX_COLOR
public static final String SERIALIZED_NAME_BACKGROUND_HEX_COLOR
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_TAB_INDEX
public static final String SERIALIZED_NAME_TAB_INDEX
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_FORMULA_FIELD_SETTINGS
public static final String SERIALIZED_NAME_FORMULA_FIELD_SETTINGS
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_RESIZE_OPTION
public static final String SERIALIZED_NAME_RESIZE_OPTION
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_ALLOW_EDIT_FORM_FIELD
public static final String SERIALIZED_NAME_ALLOW_EDIT_FORM_FIELD
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_ALLOW_DELETE_FORM_FIELD
public static final String SERIALIZED_NAME_ALLOW_DELETE_FORM_FIELD
- See Also:
- Constant Field Values
-
SERIALIZED_NAME_COLLABORATION_SETTINGS
public static final String SERIALIZED_NAME_COLLABORATION_SETTINGS
- See Also:
- Constant Field Values
-
-
Method Detail
-
fieldType
public FormField fieldType(FormField.FieldTypeEnum fieldType)
-
getFieldType
@Nonnull public FormField.FieldTypeEnum getFieldType()
Get fieldType- Returns:
- fieldType
-
setFieldType
public void setFieldType(FormField.FieldTypeEnum fieldType)
-
setPageNumber
public void setPageNumber(Integer pageNumber)
-
setBounds
public void setBounds(Rectangle bounds)
-
setId
public void setId(String id)
-
setName
public void setName(String name)
-
setIsRequired
public void setIsRequired(Boolean isRequired)
-
setIsReadOnly
public void setIsReadOnly(Boolean isReadOnly)
-
setValue
public void setValue(String value)
-
setFontSize
public void setFontSize(Float fontSize)
-
font
public FormField font(FormField.FontEnum font)
-
getFont
@Nullable public FormField.FontEnum getFont()
Get font- Returns:
- font
-
setFont
public void setFont(FormField.FontEnum font)
-
setFontHexColor
public void setFontHexColor(String fontHexColor)
-
setIsBoldFont
public void setIsBoldFont(Boolean isBoldFont)
-
setIsItalicFont
public void setIsItalicFont(Boolean isItalicFont)
-
getIsUnderLineFont
@Nullable public Boolean getIsUnderLineFont()
Get isUnderLineFont- Returns:
- isUnderLineFont
-
setIsUnderLineFont
public void setIsUnderLineFont(Boolean isUnderLineFont)
-
getLineHeight
@Nullable public Integer getLineHeight()
Get lineHeight minimum: 0 maximum: 2147483647- Returns:
- lineHeight
-
setLineHeight
public void setLineHeight(Integer lineHeight)
-
getCharacterLimit
@Nullable public Integer getCharacterLimit()
Get characterLimit minimum: 0 maximum: 2147483647- Returns:
- characterLimit
-
setCharacterLimit
public void setCharacterLimit(Integer characterLimit)
-
setGroupName
public void setGroupName(String groupName)
-
setLabel
public void setLabel(String label)
-
setPlaceHolder
public void setPlaceHolder(String placeHolder)
-
validationType
public FormField validationType(FormField.ValidationTypeEnum validationType)
-
getValidationType
@Nullable public FormField.ValidationTypeEnum getValidationType()
Get validationType- Returns:
- validationType
-
setValidationType
public void setValidationType(FormField.ValidationTypeEnum validationType)
-
getValidationCustomRegex
@Nullable public String getValidationCustomRegex()
Get validationCustomRegex- Returns:
- validationCustomRegex
-
setValidationCustomRegex
public void setValidationCustomRegex(String validationCustomRegex)
-
validationCustomRegexMessage
public FormField validationCustomRegexMessage(String validationCustomRegexMessage)
-
getValidationCustomRegexMessage
@Nullable public String getValidationCustomRegexMessage()
Get validationCustomRegexMessage- Returns:
- validationCustomRegexMessage
-
setValidationCustomRegexMessage
public void setValidationCustomRegexMessage(String validationCustomRegexMessage)
-
setDateFormat
public void setDateFormat(String dateFormat)
-
setTimeFormat
public void setTimeFormat(String timeFormat)
-
setImageInfo
public void setImageInfo(ImageInfo imageInfo)
-
attachmentInfo
public FormField attachmentInfo(AttachmentInfo attachmentInfo)
-
getAttachmentInfo
@Nullable public AttachmentInfo getAttachmentInfo()
Get attachmentInfo- Returns:
- attachmentInfo
-
setAttachmentInfo
public void setAttachmentInfo(AttachmentInfo attachmentInfo)
-
editableDateFieldSettings
public FormField editableDateFieldSettings(EditableDateFieldSettings editableDateFieldSettings)
-
getEditableDateFieldSettings
@Nullable public EditableDateFieldSettings getEditableDateFieldSettings()
Get editableDateFieldSettings- Returns:
- editableDateFieldSettings
-
setEditableDateFieldSettings
public void setEditableDateFieldSettings(EditableDateFieldSettings editableDateFieldSettings)
-
getHyperlinkText
@Nullable public String getHyperlinkText()
Get hyperlinkText- Returns:
- hyperlinkText
-
setHyperlinkText
public void setHyperlinkText(String hyperlinkText)
-
conditionalRules
public FormField conditionalRules(List<ConditionalRule> conditionalRules)
-
addConditionalRulesItem
public FormField addConditionalRulesItem(ConditionalRule conditionalRulesItem)
-
getConditionalRules
@Nullable public List<ConditionalRule> getConditionalRules()
Get conditionalRules- Returns:
- conditionalRules
-
setConditionalRules
public void setConditionalRules(List<ConditionalRule> conditionalRules)
-
setDataSyncTag
public void setDataSyncTag(String dataSyncTag)
-
getDropdownOptions
@Nullable public List<String> getDropdownOptions()
Get dropdownOptions- Returns:
- dropdownOptions
-
textAlign
public FormField textAlign(FormField.TextAlignEnum textAlign)
-
getTextAlign
@Nullable public FormField.TextAlignEnum getTextAlign()
Get textAlign- Returns:
- textAlign
-
setTextAlign
public void setTextAlign(FormField.TextAlignEnum textAlign)
-
textDirection
public FormField textDirection(FormField.TextDirectionEnum textDirection)
-
getTextDirection
@Nullable public FormField.TextDirectionEnum getTextDirection()
Get textDirection- Returns:
- textDirection
-
setTextDirection
public void setTextDirection(FormField.TextDirectionEnum textDirection)
-
getCharacterSpacing
@Nullable public Float getCharacterSpacing()
Get characterSpacing- Returns:
- characterSpacing
-
setCharacterSpacing
public void setCharacterSpacing(Float characterSpacing)
-
getBackgroundHexColor
@Nullable public String getBackgroundHexColor()
Get backgroundHexColor- Returns:
- backgroundHexColor
-
setBackgroundHexColor
public void setBackgroundHexColor(String backgroundHexColor)
-
getTabIndex
@Nullable public Integer getTabIndex()
Get tabIndex minimum: -1 maximum: 2147483647- Returns:
- tabIndex
-
setTabIndex
public void setTabIndex(Integer tabIndex)
-
formulaFieldSettings
public FormField formulaFieldSettings(FormulaFieldSettings formulaFieldSettings)
-
getFormulaFieldSettings
@Nullable public FormulaFieldSettings getFormulaFieldSettings()
Get formulaFieldSettings- Returns:
- formulaFieldSettings
-
setFormulaFieldSettings
public void setFormulaFieldSettings(FormulaFieldSettings formulaFieldSettings)
-
resizeOption
public FormField resizeOption(FormField.ResizeOptionEnum resizeOption)
-
getResizeOption
@Nullable public FormField.ResizeOptionEnum getResizeOption()
Get resizeOption- Returns:
- resizeOption
-
setResizeOption
public void setResizeOption(FormField.ResizeOptionEnum resizeOption)
-
getAllowEditFormField
@Nullable public Boolean getAllowEditFormField()
Get allowEditFormField- Returns:
- allowEditFormField
-
setAllowEditFormField
public void setAllowEditFormField(Boolean allowEditFormField)
-
getAllowDeleteFormField
@Nullable public Boolean getAllowDeleteFormField()
Get allowDeleteFormField- Returns:
- allowDeleteFormField
-
setAllowDeleteFormField
public void setAllowDeleteFormField(Boolean allowDeleteFormField)
-
collaborationSettings
public FormField collaborationSettings(CollaborationSettings collaborationSettings)
-
getCollaborationSettings
@Nullable public CollaborationSettings getCollaborationSettings()
Get collaborationSettings- Returns:
- collaborationSettings
-
setCollaborationSettings
public void setCollaborationSettings(CollaborationSettings collaborationSettings)
-
createFormData
public Map<String,Object> createFormData() throws ApiException
- Throws:
ApiException
-
validateJsonElement
public static void validateJsonElement(com.google.gson.JsonElement jsonElement) throws IOExceptionValidates the JSON Element and throws an exception if issues found- Parameters:
jsonElement- JSON Element- Throws:
IOException- if the JSON Element is invalid with respect to FormField
-
fromJson
public static FormField fromJson(String jsonString) throws IOException
Create an instance of FormField given an JSON string- Parameters:
jsonString- JSON string- Returns:
- An instance of FormField
- Throws:
IOException- if the JSON string is invalid with respect to FormField
-
toJson
public String toJson()
Convert an instance of FormField to an JSON string- Returns:
- JSON string
-
-