Payment Card Cvv View
Convenience view for collecting CVV details from a user
Important:
User-entered CVV details are intentionally restricted to reduce PCI compliance scope
Styling/Branding
This view provides full support for styling and customization, which can be accomplished in the following ways:
Individual Style Attributes: Style specific aspects of the view individually
Text Appearance Style Attributes: Style text using Android's TextAppearance styles
Background Resource Attributes: Style the background using drawable resources
XML attributes can be set directly on the view or they can be defined in a style that gets applied to the view. The following examples each produce the same result:
Customizations applied directly to the view:
// NOTE: This example assumes a namespace definition of `app`. Replace
// this with your own namespace qualifier if you use something different
<com.olo.olopay.controls.PaymentCardCvvView
app:cvvBorderColor="@color/android:black"
app:cvvBorderWidth="2dp" />
/>
Customizations applied in a style:
// Style definition
<style name="MyCvvStyle">
<item name="cvvBorderColor">@color/android:black</item>
<item name="cvvBorderWidth">2dp</item>
</style>
// Layout file
<com.olo.olopay.controls.PaymentCardCvvView
style="@style/MyCvvStyle" />
Individual Style Attributes
These attributes are responsible for controlling a single aspect of the view. In the case of conflicting styles between these attributes and Text Appearance Style Attributes or Background Resource Attributes these attributes take precedence.
This view supports the following attributes for styling/branding purposes:
cursorColor / (See setCursorColor)
cvvBackgroundColor / (See setCvvBackgroundStyle)
cvvBorderColor / (See setCvvBackgroundStyle)
cvvBorderRadius / (See setCvvBackgroundStyle)
cvvBorderWidth / (See setCvvBackgroundStyle)
cvvBottomPadding / (See setCvvPadding)
cvvEndPadding / (See setCvvPadding)
cvvHint / (See setHintText)
cvvStartPadding / (See setCvvPadding)
cvvTopPadding / (See setCvvPadding)
displayErrors / (See displayErrors)
errorBackgroundColor / (See setErrorBackgroundStyle)
errorBorderColor / (See setErrorBackgroundStyle)
errorBorderRadius / (See setErrorBackgroundStyle)
errorBorderWidth / (See setErrorBackgroundStyle)
errorBottomPadding / (See setErrorPadding)
errorEndPadding / (See setErrorPadding)
errorGravity / (See setErrorGravity)
errorStartPadding / (See setErrorPadding)
errorTextColor / (See setErrorTextColor)
errorTextSize / (See setErrorTextSize)
errorTopPadding / (See setErrorPadding)
hintTextColor / (See setHintTextColor)
textColor / (See setTextColor)
textSize / (See setTextSize)
verticalSpacing / (See setVerticalSpacing)
Important:
Some customizations are only possible when using Text Appearance Style Attributes or Background Resource Attributes. Refer to those sections for more information.
Text Appearance Attributes
Unlike the text attributes specified in Individual Style Attributes above, where each attribute specifies one aspect of the text's appearance, these attributes define the entire appearance through one attribute using a text appearance style. These styles can define text color, text size, hint text color, or even have different appearances defined based on the state of the view (e.g. focused or unfocused, enabled or disabled). For a full list of available attributes, see TextAppearance.
This view supports the following text appearance resource attributes for styling/branding purposes:
textAppearance / (See setTextAppearance)
errorTextAppearance / (See setErrorTextAppearance)
Important
Text attributes defined directly on this view (from the Individual Style Attributes section above) will override attributes defined by the textAppearance
and errorTextAppearance
attributes
Background Attributes
Unlike the background attributes specified in Individual Style Attributes above, where each attribute specifies one aspect of the background, these attributes define the entire background through one resource id. For example, a single drawable resource could be used that specifies padding, border color, border radius, and a gradient background, or even have different backgrounds defined based on the state of the view (e.g. focused or unfocused, enabled or disabled).
This view supports the following background resource attributes for styling/branding purposes:
cvvBackground / (See setCvvBackgroundResource)
errorBackground / (See setErrorBackgroundResource)
Important
Background attributes from the Individual Style Attributes section above take precedence over these background attributes.
Constructors
Creates a new instance of PaymentCardCvvView
Properties
Set this to receive notifications when configuration changes occur
Set this to receive callbacks about card input events for this control
Get an ICvvTokenParams instance that can be used to create an ICvvUpdateToken instance. If the field is not valid this will return null.
XML Attribute: displayErrors
Provides a snapshot of the current state of the field
Functions
Dismisses the keyboard, if visible, and removes focus from the input field in this control
Gets the font of the error message
Get the error message that would be displayed if isValid is false. Note that isValid having a value of false
does not necessarily mean there will be an error message (see ignoreUneditedFieldErrors param)
Check if there is an error message to be displayed.
Moves focus to the input field
XML Attribute: cursorColor
XML Attribute: cvvBackground
XML Attributes: cvvBackgroundColor, cvvBorderColor, cvvBorderWidth, cvvBorderRadius
XML Attributes: cvvStartPadding, cvvTopPadding, cvvEndPadding, cvvBottomPadding
XML Attribute: android:enabled
XML Attribute: errorBackground
XML Attributes: errorBackgroundColor, errorBorderColor, errorBorderWidth, errorBorderRadius
Sets the error font for the error message
XML Attribute: errorGravity
XML Attributes: errorStartPadding, errorTopPadding, errorEndPadding, errorBottomPadding
XML Attribute: errorTextAppearance
XML Attribute: errorTextColor
XML Attribute: errorTextSize
XML Attribute: android:gravity
XML Attribute: cvvHint
XML Attribute: hintTextColor
XML Attribute: textAppearance
XML Attribute: textColor
XML Attribute: textSize
XML Attribute: verticalSpacing