Package de.lessvoid.nifty.controls.textfield.filter.input

Class FilterAcceptRegex

java.lang.Object

de.lessvoid.nifty.controls.textfield.filter.input.FilterAcceptRegex

All Implemented Interfaces:

TextFieldInputCharSequenceFilter

public class FilterAcceptRegex
extends java.lang.Object
implements TextFieldInputCharSequenceFilter

This filter applies a regular expression to the characters insert into the text field. Only if the characters meet the regular expression, they are accepted.

Author:

Martin Karing <nitram@illarion.org>

Constructor Summary

Constructors

Constructor	Description
FilterAcceptRegex(java.lang.String expression)	Create a new instance and set the regular expression used for the test.
FilterAcceptRegex(java.lang.String expression, int flags)	Create a new instance and set the regular expression that needs to be checked.
FilterAcceptRegex(java.util.regex.Pattern expression)	Create a new instance of this class and set the pattern that is used for the test.

Method Summary

Modifier and Type	Method	Description
boolean	acceptInput(int index, java.lang.CharSequence newChars)	Check if the input of a new set of characters is acceptable.

Methods inherited from class java.lang.Object

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

Constructor Detail

FilterAcceptRegex

public FilterAcceptRegex(@Nonnull
                         java.util.regex.Pattern expression)

Create a new instance of this class and set the pattern that is used for the test.

Parameters:

expression - the used pattern

FilterAcceptRegex

public FilterAcceptRegex(@Nonnull
                         java.lang.String expression)

Create a new instance and set the regular expression used for the test. The pattern is compiled without special flags.

Parameters:

expression - the regular expression

FilterAcceptRegex

public FilterAcceptRegex(@Nonnull
                         java.lang.String expression,
                         int flags)

Create a new instance and set the regular expression that needs to be checked.

Parameters:

expression - the regular expression

flags - Match flags, a bit mask that may include Pattern.CASE_INSENSITIVE, Pattern.MULTILINE, Pattern.DOTALL, Pattern.UNICODE_CASE, Pattern.CANON_EQ, Pattern.UNIX_LINES, Pattern.LITERAL and Pattern.COMMENTS

Method Detail

acceptInput

public boolean acceptInput(int index,
                           @Nonnull
                           java.lang.CharSequence newChars)

Description copied from interface: TextFieldInputCharSequenceFilter

Check if the input of a new set of characters is acceptable.

Specified by:

acceptInput in interface TextFieldInputCharSequenceFilter

Parameters:

index - the position within the text where the character is added

newChars - the characters that is now about to be added to the text

Returns:

true in case adding the character is allowed