CurrencyEditText

This library provides components CurrencyTextEdit and CurrencyMaterialTextEdit that can replace regular TextEdit. With built-in number formatting, these components are useful for entering monetary amounts and other numeric values.

Library Features:

• Support for formatting both by locale and by setting a separate group separator and decimal separator
• When entering a decimal point, the dot and comma buttons work the same way.
• Easily enter positive and negative values (just press minus regardless of cursor position)
• Optional currency symbol prefix
• Ability to set and get value as BigDecimal
• A simple way to define a validator and a changes listener
• The library is used in popular applications (see list in below)
• The author maintains and refines the library and is always happy to receive your comments and suggestions.

This project is fork of https://github.com/CottaCush/CurrencyEditText Also there was used ideas of another project: https://github.com/firmfreez/CurrencyEditText Thanks a lot to both authors.

Gradle Dependency

Add the dependency to your app's build.gradle:

implementation 'ru.pravbeseda:CurrencyEditText:<insert-latest-version-here>'

For versions, kindly head over to the releases page

Library content

There are 2 components in this library: CurrencyEditText and CurrencyMaterialEditText. The CurrencyMaterialEditText component is inherited from TextInputLayout and is a wrapper over CurrencyEditText.

Usage

You can add the CurrencyEditText to your layout.

<ru.pravbeseda.currencyedittext.CurrencyEditText 
    android:layout_width="wrap_content"
    android:layout_height="60dp" 
    android:ems="10" 
    android:id="@+id/editText"
    android:text="1234.67"
    app:negativeValueAllow="true"
    app:maxNumberOfDecimalPlaces="2"
    app:decimalZerosPadding="false"
/>

Or you can use the CurrencyMaterialEditText component.

<ru.pravbeseda.currencyedittext.CurrencyMaterialEditText 
    android:layout_width="wrap_content"
    android:layout_height="60dp" 
    android:ems="10" 
    android:id="@+id/editText"
    app:text="1234.67"
    app:negativeValueAllow="true"
    app:maxNumberOfDecimalPlaces="2"
    app:decimalZerosPadding="false"
/>

That's all for basic setup. Your editText should automatically format currency inputs.

After that, you can configure the View parameters separately in the code:

edittext.setNegativeValueAllow(true)
edittext.setMaxNumberOfDecimalPlaces(2)
edittext.setDecimalZerosPadding(true)

You can set the value via setValue method:

edittext.setValue(BigDecimal(4321.76))
val value = edittext.getValue()

Or you can set the text value directly:

edittext.setText("4321.76")

But in the last case the value is needed to be formatted according to CurrencyEditText localization settings.

You can set value validation:

edittext.setValidator { value ->
    var error = ""
    if (value < BigDecimal(1000)) {
        error = "Value is less than 1000"
    }
    error
}

You can check the current state of the field via isValid property or isValidState() method

if (edittext.isValid) {
    // do something
}

If you need to revalidate an unchanged field, call the validate() method:

edittext.validate()

You can subscribe to a field value change event:

edittext.onValueChanged { bigDecimal, state: State, textError: String ->
    if (state !== State.ERROR) {
        textView.text = bigDecimal.toString()
    } else {
        textView.text = textError
    }
}

In the CurrencyMaterialEditText component, the validation error text is shown automatically.

Localization

The library supports localization. You can set the locale in the layout file:

app:localeTag="da-DK"

Or in the code:

edittext.setLocale(Locale("da", "DK"))
// or
edittext.setLocale(Locale.GERMAN)
// or
edittext.setLocale("da-DK")

You can just set the decimal and grouping separators:

app:decimalSeparator=","
app:groupingSeparator=" "

Or in the code:

edittext.setSeparators(' ', ',')

CurrencyMaterialEditText Features

Since CurrencyMaterialEditText is not a descendant of EditText, some EditText properties are passed with the prefix 'app'. For example:

app:text="1234.67"
app:selectAllOnFocus="true"

Some properties are only available for the CurrencyMaterialEditText component.

You can set hint (label):

android:hint="Account amount"

Or in the code:

currencyMaterialEditText.hint = "Account amount"

As mentioned above, the validation error text in the CurrencyMaterialEditText component is shown automatically.

Usage of the library

The library is used in applications:

1. How much can I spend?
2. How much can I spend? Premium

If you have used the library in your project, please send me a link to the project. I will be happy to include it in this list.

License

Copyright (c) 2022-2023 Alexander Ivanov

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.