Apryse WebViewer

Class: FormFieldCreationManager

Core. FormFieldCreationManager

A manager class that controls form field creation and editing

new FormFieldCreationManager(annotationManager)

Parameters:
Name Type Description
annotationManager Core.AnnotationManager The annotation manager instance

Extends

  • EventHandler

Members

<static> Events

Properties:
Name Type Description
FORM_CREATION_STARTED string Core.FormFieldCreationManager.formFieldCreationModeStarted
FORM_CREATION_ENDED string Core.FormFieldCreationManager.formFieldCreationModeEnded
FORM_CREATION_EMPTY_FIELD_NAMES string Core.FormFieldCreationManager.formFieldEmptyFieldNames

Methods

allowToolsInFormFieldCreationMode(tools)

Adds tools to the list of tools that are allowed to be used in form field creation mode
Parameters:
Name Type Description
tools Array.<string> The names of the tools to be added

disableShowingMarkupAnnotations()

Disables the display of markup annotations during form field creation

disallowToolsInFormFieldCreationMode(tools)

Removes tools from the list of tools that are allowed to be used in form field creation mode
Parameters:
Name Type Description
tools Array.<string> The names of the tools to be removed

enableShowingMarkupAnnotations()

Enables the display of markup annotations during form field creation

endFormFieldCreationMode()

Ends the Form Field Creation mode, converting all the form field place holder annotations into Widget annotations with their respective fields.

getFieldLabels()

Returns the labels being used to store the field custom data
Returns:
The labels used to store the field custom data
Type
Core.FormFieldCreationManager.FieldLabels

getIndicatorText(widgetAnnotation)

Gets the field indicator text
Parameters:
Name Type Description
widgetAnnotation Core.Annotations.WidgetAnnotation The widget annotation to pull the field indicator text from
Returns:
The field indicator text
Type
string

getRadioButtonGroups()

Gets the existing radio button groups
Returns:
Array with Radio Button group names
Type
Array.<string>

getShowIndicator(widgetAnnotation)

Gets whether or not the form field indicator should be shown
Parameters:
Name Type Description
widgetAnnotation Core.Annotations.WidgetAnnotation The widget annotation to pull the field indicator flag from
Returns:
Whether or not to show the field indicator
Type
boolean

getSignatureOption(signatureWidget)

Gets the signature option for signature widgets. Returns either fullSignature or initials
Parameters:
Name Type Description
signatureWidget Core.Annotations.SignatureWidgetAnnotation The widget annotation to pull the signature option from
Returns:
One of the signature options - either fullSignature or initials
Type
Core.FormFieldCreationManager.SignatureOptions

isInFormFieldCreationMode()

Gets if the Form Field Creation manager is currently in creation mode

isShowingMarkupAnnotations()

Checks if markup annotations are being displayed during form field creation
Returns:
True if markup annotations are shown during form field creation
Type
boolean

isToolAllowedInFormFieldCreationMode(toolName)

Returns whether or not a tool is allowed to be used in form field creation mode
Parameters:
Name Type Description
toolName string The name of the tool to check
Returns:
Whether or not the tool is allowed in forms mode
Type
boolean

setFieldName(widget, fieldName)

Sets the form field name
Parameters:
Name Type Description
widget Core.Annotations.WidgetAnnotation The form field widget
fieldName string The field name
Returns:
Validation response indicating if the name is valid
Type
Core.FormFieldCreationManager.FieldNameValidationResponse

setIndicatorText(widgetAnnotation, indicatorText)

Set the field indicator text
Parameters:
Name Type Description
widgetAnnotation Core.Annotations.WidgetAnnotation The widget annotation to set the field indicator text on
indicatorText string The indicator text

setShowIndicator(widgetAnnotation, showIndicator)

Set whether or not to show the field indicator
Parameters:
Name Type Description
widgetAnnotation Core.Annotations.WidgetAnnotation The widget annotation to set the field indicator flag on
showIndicator boolean Whether or not to show the field indicator

setSignatureOption(signatureWidget, signatureOption)

Sets whether a signature widget should take in a full signature, or initials
Parameters:
Name Type Description
signatureWidget Core.Annotations.SignatureWidgetAnnotation The signature widget
signatureOption Core.FormFieldCreationManager.SignatureOptions The type of signature

startFormFieldCreationMode()

Starts the Form Field Creation mode, a mode in which all annotations are hidden and only form field place holder annotations can be added

Type Definitions

FieldLabels

Field custom data labels
Type:
  • Object
Properties:
Name Type Description
FIELD_VALUE string Label for field value custom data
FLAGS string Label for field flags custom data
READ_ONLY string Label for read only custom data
REQUIRED string Label for required custom data
OPTIONS string Label for options custom data
MULTI_SELECT string Label for multi select custom data
SHOW_INDICATOR string Label for show indicator custom data
INDICATOR_TEXT string Label for indicator text custom data
SIGNATURE_TYPE string Label for signature type custom data
IS_DATA_PLACEHOLDER_COPY string Label for data placeholder copy custom data

FieldNameValidationErrorType

Field name validation error type
Type:
  • 'empty' | 'duplicate'

FieldNameValidationResponse

Field name validation response
Type:
  • Object
Properties:
Name Type Argument Description
isValid boolean Whether the field name is valid
errorType Core.FormFieldCreationManager.FieldNameValidationErrorType <optional>
 The type of validation error if not valid

SignatureOptions

Signature Options
Type:
  • 'fullSignature' | 'initialsSignature'

Events

formFieldCreationModeEnded

Triggered when form field creation mode is ended

formFieldCreationModeStarted

Triggered when form field creation mode is started

formFieldEmptyFieldNames

Triggered when there are form fields with empty field names