SSNEditText

Provides a user interface element that represents a Social Security Number (SSN).

Set field name

Sets the text to be used for data transfer to VGS proxy. Usually, it is similar to field-name in JSON path in your inbound route filters. It is highly important to specify this parameter because the VGSCollect module relies on it too.

Warning: You must set up fieldName in other way input field will be ignored by VGSCollect.

XML

<com.verygoodsecurity.vgscollect.widget.SSNEditText
    android:id="@+id/ssnField"
    android:layout_width="match_parent"
    android:layout_height="wrap_content"
    app:fieldName="ssn_field_name"/>

Kotlin

val ssnField = findViewById<SSNEditText>(R.id.ssnField)
ssnField.setFieldName("ssn_field_name")

Java

SSNEditText ssnField = findViewById(R.id.ssnField);
ssnField.setFieldName("ssn_field_name");

Define the required state

Specifies whether the text inside input field is required to be filled.

When app:isRequired set as true, then input data should be valid only. If app:isRequired set as false, then input data will be valid in case the field is empty. Otherwise input data should be valid.

By default, a widget is required.

XML

<com.verygoodsecurity.vgscollect.widget.SSNEditText
    android:id="@+id/ssnField"
    android:layout_width="match_parent"
    android:layout_height="wrap_content"
    app:isRequired="false"/>

Kotlin

val ssnField = findViewById<SSNEditText>(R.id.ssnField)
ssnField.isRequired(false)

Java

SSNEditText ssnField = findViewById(R.id.ssnField);
ssnField.isRequired(false);

Define number group divider

To set the symbol that will divide groups of digits in the number add app:numberDivider to your field's declaration in xml. By default, Collect SDK adds - character as divider symbol.

XML

<com.verygoodsecurity.vgscollect.widget.SSNEditText
    android:id="@+id/ssnField"
    android:layout_width="match_parent"
    android:layout_height="wrap_content"
    app:numberDivider="-"/>

Kotlin

val ssnField = findViewById<SSNEditText>(R.id.ssnField)
ssnField.setDivider('-')

Java

SSNEditText ssnField = SSNEditText(R.id.ssnField);
ssnField.setDivider('-');

Also, VGS Collect SDK gives an ability to change or to remove divider symbol before it has been submitted to the Proxy.

To set the symbol that will divide groups of digits in the number add app:outputNumberDivider to your field's declaration in xml. By default, Collect SDK adds - character as divider symbol.

Info: app:numberDivider and app:outputNumberDivider should contain only one character.

XML

<com.verygoodsecurity.vgscollect.widget.SSNEditText
    android:id="@+id/ssnField"
    android:layout_width="match_parent"
    android:layout_height="wrap_content"
    app:outputNumberDivider="-"/>

Kotlin

val ssnField = findViewById<SSNEditText>(R.id.ssnField)
ssnField.setOutputDivider('-')

Java

SSNEditText ssnField = findViewById(R.id.ssnField);
ssnField.setOutputDivider('-');

Additional XML attributes

Attribute	Description
app:numberDivider	Sets the symbol that will divide groups of digits in the number. This divider will be visible to user in `SSNEditText` field.
app:outputNumberDivider	Sets the symbol that will divide groups of digits before submit to the Proxy.
app:inputType	Set the type of the content with a constant as defined for input field.
app:imeOptions	Specify soft input method for the input method action. By default, the system uses a actionNext Plain textor actionDone Plain textaction.
app:fontFamily	Default font family (named by string or as a font resource reference) for the text.
app:fieldName	Sets the text to be used for data transfer to VGS proxy. Usually, it is similar to field-name in JSON path in your inbound route filters.
app:isRequired	Specifies whether the text inside input field is required to be filled.
app:textSize	Size of the text.
app:ellipsize	If set, causes words that are longer than the view is wide to be ellipsized instead of broken in the middle.
app:ellipsize	If set, causes words that are longer than the view is wide to be ellipsized instead of broken in the middle.
app:text	Text to display.
app:textColor	Text color.
app:maxLines	Makes the View be at most this many lines tall.
app:minLines	Makes the View be at least this many lines tall.
app:textStyle	Style (normal, bold, italic) for text.
app:cursorVisible	Makes the cursor visible (the default) or invisible.
app:gravity	Specifies how to align the text by the view’s x- or y-axis when the text is smaller than the view.
app:scrollHorizontally	When the text is allowed to be wider than the view (and therefore can be scrolled horizontally).
app:hint	Hint text to display when the text is empty.