net.rim.device.api.ui.text
Class TextFilter

java.lang.Object
  |
  +--net.rim.device.api.ui.text.TextFilter

Direct Known Subclasses:

EmailAddressTextFilter, HexadecimalTextFilter, IPTextFilter, LowercaseTextFilter, NumericTextFilter, PhoneTextFilter, UppercaseTextFilter, URLTextFilter

public abstract class TextFilter

extends Object

Defines fundamental functionality for a text filtering object. Objects are cached upon creation.

A filter has two functions: first, it can validate whether a character or string is valid, and second it can map characters onto ones more likely to be valid.

Field Summary

static int	ADN_SIM_PHONE ADN stands for Abbreviated Dialing Number, the standard SIM phone book.
static int	DEFAULT Default filter type.
static int	DEFAULT_SMART_PHONE Default smart phone number edit field filter.
static int	EMAIL Email address filter.
static int	FDN_SIM_PHONE FDN stands for Fixed Dialing Number, the secure SIM phone book.
static int	HEXADECIMAL Hex character set filter.
static int	INTEGER Integer number filter
static int	LOWERCASE Lowercase alpha character filter
static int	NUMERIC Common Numeric filter.
static int	PHONE A generous phone number filter
static int	PIN_ADDRESS PIN address filter type.
static int	REAL_NUMERIC Numeric filter allows for negative sign and decimal point.
static int	SIM_PHONE Same as ADN_SIM_PHONE.
static int	SMS_PHONE SMS (Short Message Service) phone number filter
static byte	STYLE_SHIFT Direct Connect filter for iDEN SIM Phone
static int	UPPERCASE Uppercase alpha character filter
static int	URL URL (Universal Resource Locator) filter.
static int	VOICEMAIL_PHONE Default voicemail and call forwarding phone number edit field filter.

Constructor Summary

protected

TextFilter() Constructs a new TextFilter instance.

Method Summary

abstract char	convert(char character, int status) Retrieves filtered version of provided character.
static TextFilter	get(int type) Retrieve a filter of provided type.
boolean	validate(AbstractString text) Determines if provided string contains valid characters.
abstract boolean	validate(char character) Validates character for use with this filter.

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT

public static final int DEFAULT

Default filter type. Null returned

NUMERIC

public static final int NUMERIC

Common Numeric filter.

See Also:

NumericTextFilter()

UPPERCASE

public static final int UPPERCASE

Uppercase alpha character filter

See Also:

UppercaseTextFilter()

LOWERCASE

public static final int LOWERCASE

Lowercase alpha character filter

See Also:

LowercaseTextFilter()

HEXADECIMAL

public static final int HEXADECIMAL

Hex character set filter.

See Also:

HexadecimalTextFilter()

INTEGER

public static final int INTEGER

Integer number filter

See Also:

NumericTextFilter( NumericTextFilter.ALLOW_NEGATIVE )

PHONE

public static final int PHONE

A generous phone number filter

See Also:

PhoneTextFilter(PhoneTextFilter.ACCEPT_EVERYTHING_EXCEPT_WILD_CARD)

URL

public static final int URL

URL (Universal Resource Locator) filter.

See Also:

URLTextFilter()

EMAIL

public static final int EMAIL

Email address filter.

See Also:

EmailAddressTextFilter()

PIN_ADDRESS

public static final int PIN_ADDRESS

PIN address filter type.

See Also:

PINAddressTextFilter()

Since:

JDE 4.0.0

ADN_SIM_PHONE

public static final int ADN_SIM_PHONE

ADN stands for Abbreviated Dialing Number, the standard SIM phone book.

See Also:

PhoneTextFilter(PhoneTextFilter.ACCEPT_PAUSE PhoneTextFilter.ACCEPT_CONTROL PhoneTextFilter.ACCEPT_INTERNATIONAL)

Since:

JDE 4.0.0

SIM_PHONE

public static final int SIM_PHONE

Same as ADN_SIM_PHONE. This is kept for backwards compatibility

Since:

JDE 4.0.2

FDN_SIM_PHONE

public static final int FDN_SIM_PHONE

FDN stands for Fixed Dialing Number, the secure SIM phone book.

See Also:

PhoneTextFilter(PhoneTextFilter.ACCEPT_PAUSE PhoneTextFilter.ACCEPT_CONTROL PhoneTextFilter.ACCEPT_WILD_CARD PhoneTextFilter.ACCEPT_INTERNATIONAL)

Since:

JDE 4.0.2

SMS_PHONE

public static final int SMS_PHONE

SMS (Short Message Service) phone number filter

See Also:

PhoneTextFilter(PhoneTextFilter.ACCEPT_INTERNATIONAL PhoneTextFilter.INTERNATIONAL_MUST_BE_FIRST)

Since:

JDE 4.0.2

DEFAULT_SMART_PHONE

public static final int DEFAULT_SMART_PHONE

Default smart phone number edit field filter.

See Also:

PhoneTextFilter(PhoneTextFilter.ACCEPT_CONTROL PhoneTextFilter.ACCEPT_ALPHA PhoneTextFilter.ACCEPT_FORMATTING PhoneTextFilter.ACCEPT_INTERNATIONAL)

Since:

JDE 4.0.2

VOICEMAIL_PHONE

public static final int VOICEMAIL_PHONE

Default voicemail and call forwarding phone number edit field filter.

See Also:

PhoneTextFilter(PhoneTextFilter.ACCEPT_CONTROL PhoneTextFilter.ACCEPT_INTERNATIONAL PhoneTextFilter.INTERNATIONAL_MUST_BE_FIRST)

Since:

JDE 4.0.2

REAL_NUMERIC

public static final int REAL_NUMERIC

Numeric filter allows for negative sign and decimal point.

See Also:

NumericTextFilter(NumericTextFilter.ALLOW_DECIMAL NumericTextFilter.ALLOW_NEGATIVE)

Since:

JDE 4.0.2

STYLE_SHIFT

public static final byte STYLE_SHIFT

Direct Connect filter for iDEN SIM Phone

See Also:

PhoneTextFilter( PhoneTextFilter.ACCEPT_CONTROL )

Since:

JDE 4.0.0

Constructor Detail

TextFilter

protected TextFilter()

Constructs a new TextFilter instance.

Method Detail

convert

public abstract char convert(char character,
                             int status)

Retrieves filtered version of provided character.

This method may not return a character valid for this filter; however, it may return 0 to indicate that the provided character is not valid.

For example, an UppercaseTextFilter would convert any lower case character to its upper case equivalent. However, if passed a number it could either leave the number unchanged to be filtered by validate(char), or convert it to \u0000.

Parameters:

character - Character to convert.

status - Indicates how the character was generated: some filters use this to affect the conversion performed.

Returns:

Filtered version of provided character.

get

public static final TextFilter get(int type)

Retrieve a filter of provided type.

Factory method that produces a text filter of your specified type.

Parameters:

type - Type of filter you want.

Returns:

Text filter object of your specified type, or null if you specify either DEFAULT for type, or an invalid type.

validate

public abstract boolean validate(char character)

Validates character for use with this filter.

This only considers if it is in the correct set of characters.

Parameters:

character - Character to test.

Returns:

True if this character would pass through this filter unaltered; otherwise, false.

validate

public boolean validate(AbstractString text)

Determines if provided string contains valid characters.

The default implementation of this method returns true if each character is valid within the field (determined by invoking validate(char). This is useful for upper case or lower case filters, for example, but filters that rely on character position must override this method.

Parameters:

text - String to test.

Returns:

True if each character in the string passes a validity check; otherwise, false.