FileDocCategorySizeDatePackage
InputModeMediator.javaAPI DocphoneME MR2 API (J2ME)2894Wed May 02 18:00:20 BST 2007com.sun.midp.chameleon.input

InputModeMediator

public interface InputModeMediator
An interface which defines the protocol between TextInputComponent and InputMoode

Fields Summary
Constructors Summary
Methods Summary
public voidclear(int num)
Clear the particular number of symbols

param
num number of symbols

public voidcommit(java.lang.String input)
Called by an InputMode in order to automatically commit the given input to the Text component. For example, when the timer expires in an AlphaNumeric InputMode it will commit the current pending character.

param
input String needs to be commited

public intgetAvailableSize()
Returns the available size (number of characters) that can be stored in this TextInputComponent.

return
available size in characters

public voidinputModeCompleted()
Called by an InputMode in order to signal that the input process has been completed with respect to the InputMode. Subsequent key input should be handled in a new input session, possibly by the same InputMode or by a different InputMode alltogether. For example, when the timer expires in an AlphaNumeric InputMode, the character is committed and the AlphaNumeric InputMode signals its completion. Further key input may start a new session with the AlphaNumeric InputMode or possibly some other InputMode.

public booleanisClearKey(int keyCode)
Returns true if the keyCode is used as 'clear'

param
keyCode key code
return
true if keu code is Clear one, false otherwise

public voidsubInputModeChanged()
Called by an InputMode to inform a TextComponent of a sub-inputMode change.