程序包 ohos.agp.text

类 CharInputFilter

java.lang.Object

ohos.agp.text.InputFilter

ohos.agp.text.CharInputFilter

public final class CharInputFilter
extends InputFilter

Implements a character filter, which supports filtering of plain text and RichText. This API can filter characters that are not in the valid character set you specified. To specify a valid character set, you are advised to use a regular expression, for example, [\\+-\\.\\d], for its powerful functions. In a simplest case, if you want to explicitly state which characters are valid, for example, abcde, then you need to set the regular expression to [abcde]. For ease of use and understanding, the following two use cases are provided: CharInputFilter#NUMBER and CharInputFilter#ALPHABET. The specified regular expression is used to ensure that each character in the input text, other than the entire input text, meets the rules of the regular expression.

从以下版本开始:

7

嵌套类概要

从类继承的嵌套类/接口 ohos.agp.text.InputFilter

InputFilter.Range

字段概要

字段

限定符和类型	字段	说明
static CharInputFilter	ALPHABET	Indicates the alphabet filter, which can filter any characters excluding "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ".
static CharInputFilter	NUMBER	Indicates the number filter, which can filter any characters excluding "+-.0123456789".

构造器概要

构造器

构造器	说明
CharInputFilter(String inRegexPattern)	Creates a character filter using a specified regular expression.

方法概要

限定符和类型	方法	说明
CharSequence	filter(CharSequence source, InputFilter.Range sourceRange, CharSequence dest, InputFilter.Range destRange)	Filters the input text, which can be plain text or RichText.

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

ALPHABET

public static final CharInputFilter ALPHABET

Indicates the alphabet filter, which can filter any characters excluding "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ".

从以下版本开始:

7

NUMBER

public static final CharInputFilter NUMBER

Indicates the number filter, which can filter any characters excluding "+-.0123456789".

从以下版本开始:

7

构造器详细资料

CharInputFilter

public CharInputFilter(String inRegexPattern)

Creates a character filter using a specified regular expression. Characters that do not comply with the rules of the regular expression are filtered.

参数:

inRegexPattern - Indicates the regular expression to use.

从以下版本开始:

7

方法详细资料

filter

public CharSequence filter(CharSequence source,
                           InputFilter.Range sourceRange,
                           CharSequence dest,
                           InputFilter.Range destRange)

Filters the input text, which can be plain text or RichText. If the source is rich text, the text itself will change. In other cases, the text will not change. Depending on the derived class of InputFilter, determine whether to pass null to dest and destRange. For example, pass null if the derived class is CharInputFilter or UpperCaseFilter. For LengthFilter, do not pass null to dest and destRange, because these two parameters restrict the source text together with sourceRange.

指定者:

filter 在类中 InputFilter

参数:

source - Indicates that source strings to be filtered.

sourceRange - Indicates the filtering range of the source text. Only text in this range is filtered.

dest - Indicates the destination text.

destRange - Indicates the filtering range of the destination text.

返回:

Returns text after filtering; returns null if the input source text is null or the specified Range is invalid.