OloPaySDK/com.olo.olopay.controls/PaymentCardDetailsForm

PaymentCardDetailsForm

class PaymentCardDetailsForm @JvmOverloads constructor(context: Context, attrs: AttributeSet?, defStyleAttr: Int) : ConstraintLayout, CardValidCallback

Convenience multi-field form for collecting card details from a user. Card fields are separated into multiple input fields, and the control has a "card" style background.

Important:

User-entered card details are intentionally restricted for PCI compliance

Styling/Branding

This class can be styled in the following ways:

Override color resource values
Set styles programmatically

Override color resource values

This class can be styled by overriding the following color resource values:

olopay_paymentcarddetailsform_edittext_textcolor
olopay_paymentcarddetailsform_edittext_disabledtextcolor
olopay_paymentcarddetailsform_background
olopay_paymentcarddetailsform_disabledbackground
olopay_paymentcarddetailsform_errorcolor
olopay_paymentcarddetailsform_bordercolor

In addition, since this form uses an instance of [PaymentCardDetailsMultiLineView] under the hood, many of the fields can be styled by following style documentation for [PaymentCardDetailsMultiLineView].

Note that values specifically called out here will take precedence over similar values for customizing the same attributes on PaymentCardDetailsMultiLineView. For example, olopay_paymentcarddetailsmultilineview_edittext_textcolor won't have an effect on this form because of olopay_paymentcarddetailsform_edittext_textcolor

Set styles programmatically

A number of methods exist that allow you to style PaymentCardDetailsForm. Methods exist for changing the background style (color, border, radius, etc), the text colors, error text colors, hint text colors, font, and font size.

Constructors

PaymentCardDetailsForm

@JvmOverloads

fun PaymentCardDetailsForm(context: Context, attrs: AttributeSet? = null, defStyleAttr: Int = 0)

Creates a new instance of PaymentCardDetailsForm

Properties

cardBrand

val cardBrand: CardBrand

The detected card brand based on the currently entered card number

formValidCallback

var formValidCallback: FormValidCallback? = null

Callback to be notified when the card transitions to valid and invalid states

isValid

val isValid: Boolean

true if all fields are complete and valid, otherwise false

paymentMethodParams

val paymentMethodParams: IPaymentMethodParams?

Get an IPaymentMethodParams instance that can be used to create an IPaymentMethod instance. If the form is not valid this will return null.

Functions

clearFields

fun clearFields()

Clears all text fields in the control

dismissKeyboard

fun dismissKeyboard()

Dismisses the keyboard, if visible, and removes focus from input fields in this control

isEnabled

open override fun isEnabled(): Boolean

True if the form is enabled and can accept user input, false otherwise

requestFocus

fun requestFocus(field: CardField, showKeyboard: Boolean)

Moves focus to the specified input field

setCardBackgroundColor

fun setCardBackgroundColor(color: Int)

Sets the border color for this view

@RequiresApi(value = 27)

fun setCardBackgroundColor(colorHex: String)

Sets the border color for this view IMPORTANT: This method requires API level 27 or higher

setCardBorderColor

fun setCardBorderColor(color: Int)

Sets the border color for this view

@RequiresApi(value = 27)

fun setCardBorderColor(colorHex: String)

Sets the border color for this view IMPORTANT: This method requires API level 27 or higher

setCardBorderRadius

fun setCardBorderRadius(radius: Float)

Sets the card corner radius for this view

setCardBorderWidth

fun setCardBorderWidth(widthPx: Int)

Sets the border width for this view.

setCardElevation

fun setCardElevation(elevationPx: Float)

Sets the elevation of the card background

setCardPadding

fun setCardPadding(startPx: Int?, topPx: Int?, endPx: Int?, bottomPx: Int?)

Sets the padding for the area immediately surrounding the card input fields.

setCountry

fun setCountry(countryCode: String)

Sets the two letter country code for this form

setCursorColor

@RequiresApi(value = 29)

fun setCursorColor(color: Int)

@RequiresApi(value = 29)

fun setCursorColor(colorHex: String)

Sets the color for the cursor, selection handles, and text selection highlight IMPORTANT: This method requires API Level 29 or higher

setEnabled

open override fun setEnabled(enabled: Boolean)

Enables or disables the control

setErrorFont

fun setErrorFont(font: Typeface)

Sets the error font for error messages

setErrorPadding

fun setErrorPadding(startPx: Int?, topPx: Int?, endPx: Int?, bottomPx: Int?)

Sets the padding for the error message displayed below the card input fields.

setErrorTextColor

fun setErrorTextColor(color: Int)

Sets the error text color for all input fields and error messages

@RequiresApi(value = 27)

fun setErrorTextColor(colorHex: String)

Sets the error text color for all input fields and error messages IMPORTANT: This method requires API level 27 or higher

setErrorTextSize

fun setErrorTextSize(size: Float)

Sets the text size for error messages

setFieldDividerColor

fun setFieldDividerColor(color: Int)

Sets the color for the field dividers

@RequiresApi(value = 27)

fun setFieldDividerColor(colorHex: String)

Sets the color for the field dividers IMPORTANT: This method requires API level 27 or higher

setFieldDividerWidth

fun setFieldDividerWidth(widthPx: Int)

Sets the width of the field dividers

setFocusedHintTextColor

fun setFocusedHintTextColor(color: Int)

Sets the hint text color for when a field has focus. Note that setHintTextColor overrides this value, so this method must be called after calling setHintTextColor.

@RequiresApi(value = 27)

fun setFocusedHintTextColor(colorHex: String)

Sets the hint text color for when a field has focus. Note that setHintTextColor overrides this value, so this method must be called after calling setHintTextColor. IMPORTANT: This method requires API level 27 or higher

setFont

fun setFont(font: Typeface)

Sets the font for all input fields

setHintText