forage-android/com.joinforage.forage.android.core.ui.element/ForagePinElement

ForagePinElement

abstract class ForagePinElement @JvmOverloads constructor(context: Context, attrs: AttributeSet? = null, defStyleAttr: Int = R.attr.foragePanEditTextStyle) : ForageVaultElement<PinEditTextState> , EditTextElement

A ForageElement that securely collects a card PIN. You need a ForagePinElement to call the ForageSDK online-only or ForageTerminalSDK POS methods that:

Check a card's balance
Collect a card PIN to defer payment capture to the server
Capture a payment immediately
Refund a Payment immediately (POS-only)
Collect a card PIN to defer payment refund to the server (POS-only)

<!-- Example forage_pin_component.xml -->
<?xml version="1.0" encoding="utf-8"?>
<androidx.constraintlayout.widget.ConstraintLayout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    android:layout_width="match_parent"
    android:layout_height="match_parent">

    <com.joinforage.forage.android.ui.ForagePINEditText
        android:id="@+id/foragePinEditText"
        android:layout_width="0dp"
        android:layout_height="wrap_content"
        android:layout_margin="16dp"
        app:layout_constraintBottom_toBottomOf="parent"
        app:layout_constraintEnd_toEndOf="parent"
        app:layout_constraintStart_toStartOf="parent"
        app:layout_constraintTop_toTopOf="parent"
    />

</androidx.constraintlayout.widget.ConstraintLayout>

Inheritors

ForagePINEditText

Constructors

ForagePinElement

@JvmOverloads

constructor(context: Context, attrs: AttributeSet? = null, defStyleAttr: Int = R.attr.foragePanEditTextStyle)

Inherited properties

typeface

abstract var typeface: Typeface?

The Typeface that is used to render text within the ForageElement.

Functions

clearText

open override fun clearText()

Clears the text input field of the ForageElement.

getElementState

open override fun getElementState(): PinEditTextState

Gets the current ElementState state of the ForageElement.

setBoxStrokeColor

open override fun setBoxStrokeColor(boxStrokeColor: Int)

Sets the border color of the input field.

setBoxStrokeWidth

open override fun setBoxStrokeWidth(boxStrokeWidth: Int)

Sets the border thickness of the input field.

setBoxStrokeWidthFocused

open override fun setBoxStrokeWidthFocused(boxStrokeWidth: Int)

Sets the border thickness of the input field when the field is in focus state.

setHint

open override fun ~~setHint~~(hint: String)

setHintTextColor

open override fun ~~setHintTextColor~~(hintTextColor: Int)

setOnBlurEventListener

open override fun setOnBlurEventListener(l: SimpleElementListener)

Sets an event listener to be fired when the ForageElement is blurred.

setOnChangeEventListener

open override fun setOnChangeEventListener(l: StatefulElementListener<PinEditTextState>)

Sets an event listener to be fired when the text inside the ForageElement input field changes.

setOnFocusEventListener

open override fun setOnFocusEventListener(l: SimpleElementListener)

Sets an event listener to be fired when the ForageElement is in focus.

setTextColor

open override fun setTextColor(textColor: Int)

Sets the text color for the ForageElement.

setTextSize

open override fun setTextSize(textSize: Float)

Sets the text size for the ForageElement.

showKeyboard

open override fun showKeyboard()

Explicitly request that the current input method's soft input be shown to the user, if needed. This only has an effect if the ForageElement is focused, which can be done using .requestFocus()

ForagePinElement

See also

Inheritors

Constructors

Inherited properties

Functions

Inherited functions