net.rim.device.api.im
Interface ITextInputStyle

All Known Implementing Classes:

AutoTextInputHelper, EmailAddressInputHelper, InputHelper, InputHelperBase, PasswordInputHelper, PhoneNumberInputHelper, ActiveAutoTextEditField, ActiveRichTextField, AutoTextEditField, BasicEditField, EditField, EmailAddressEditField, PasswordEditField, RichTextField, TextField, TextFieldBase, TextSpinBoxField

public interface ITextInputStyle

This interface abstracts fields' ability to state virtual keyboard layout and should be implemented by a Field subclass that wants InputContext and VirtualKeyboard frameworks to set an appropriate virtual keyboard layout when the field gets the focus. Currently, implemented by the TextField.

Since:

BlackBerry API 6.0.0

Method Summary
TextFilter	getFilter() Gets the text filter set for this field.
Locale	getPreferredInputLocale() Returns input locale the input must switch to while focus is in this component.
int	getTextInputStyle() Returns text related style bits (including filter styles)
boolean	isEditable() Determines if the field that implements this interface is editable.
boolean	isUnicodeInputAllowed() Determines if this field allows the Unicode input.
void	updateInputStyle() Updates text input style via input method control object.

Method Detail

getTextInputStyle

int getTextInputStyle()

Returns text related style bits (including filter styles)

Returns:

int the text input style

Since:

BlackBerry API 6.0.0

isUnicodeInputAllowed

boolean isUnicodeInputAllowed()

Determines if this field allows the Unicode input.

Returns:

True if this field allows the Unicode input.

Since:

BlackBerry API 6.0.0

updateInputStyle

void updateInputStyle()

Updates text input style via input method control object.

Can be used to update the input method with text component input preferences such as preferred repositories.

Present TextField's implementation resets value of input style.

Since:

BlackBerry API 6.0.0

getFilter

TextFilter getFilter()

Gets the text filter set for this field.

Returns:

the text filter set for this field if exist otherwise return null;

Since:

BlackBerry API 6.0.0

isEditable

boolean isEditable()

Determines if the field that implements this interface is editable. This method is implemented by Field class.

Returns:

True if the field can be edited; otherwise, false.

Since:

BlackBerry API 6.0.0

getPreferredInputLocale

Locale getPreferredInputLocale()

Returns input locale the input must switch to while focus is in this component. Should return null if no preferred locale exist. This method is specified by IComponent interface and implemented by Field class.

Returns:

preferred locale or null

Since:

BlackBerry API 6.0.0