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

ForagePanElement

abstract class ForagePanElement @JvmOverloads constructor(context: Context, attrs: AttributeSet? = null, defStyleAttr: Int = R.attr.foragePanEditTextStyle) : LinearLayout, ForageElement<PanEditTextState> , EditTextElement, DynamicEnvElement

A ForageElement that securely collects a customer's card number. You need a ForagePanElement to call the ForageSDK online-only method to com.joinforage.forage.android.ForageSDK.tokenizeEBTCard, or the ForageTerminalSDK POS method to com.joinforage.forage.android.pos.ForageTerminalSDK.tokenizeCard.

<!-- Example forage_pan_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.ForagePANEditText
            android:id="@+id/foragePanEditText"
            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

ForagePANEditText

Constructors

ForagePanElement

@JvmOverloads

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

Properties

typeface

open override 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(): PanEditTextState

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.

setForageConfig

open override fun setForageConfig(forageConfig: ForageConfig)

Sets the necessary ForageConfig configuration properties for a ForageElement. setForageConfig must be called before any other methods can be executed on the Element.

setHint

open override fun setHint(hint: String)

Sets the text to be displayed when the ForageElement input field is empty.

setHintTextColor

open override fun setHintTextColor(hintTextColor: Int)

Sets the hint text color.

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<PanEditTextState>)

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()

ForagePanElement

See also

Inheritors

Constructors

Properties

Functions

Inherited functions