File	Doc	Category	Size	Date	Package
InputMode.java	API Doc	phoneME MR2 API (J2ME)	11881	Wed May 02 18:00:20 BST 2007	com.sun.midp.chameleon.input

InputMode

Fields Summary
public static final int	KEYCODE_INVISIBLE The key code does not mean to be displayed
public static final int	KEYCODE_NONE The key code is not handled by the input mode. Most likely it is handled by the text component
public static final int	CAPS_ON a sub-inputMode which may be supported by an InputMode. all letters are uppercase
public static final int	CAPS_OFF a sub-inputMode which may be supported by an InputMode. all letters are lowercase
public static final int	CAPS_SENTENCE a sub-inputMode which may be supported by an InputMode. the first letter is capitalized, the rest of the letters are lowercase
public static final int	MAX_MATCHES The limitation for the number of matches

Constructors Summary

Methods Summary
public void	beginInput(InputModeMediator mediator, java.lang.String inputSubset, int constraints) This method will be called before any input keys are passed to this InputMode to allow the InputMode to perform any needed initialization. A reference to the InputModeMediator which is currently managing the relationship between this InputMode and the input session is passed in. This reference can be used by this InputMode to commit text input as well as end the input session with this InputMode. The reference is only valid until this InputMode's endInput() method is called. param constraints text input constraints. The semantics of the constraints value are defined in the TextField API. param mediator the InputModeMediator which is negotiating the relationship between this InputMode and the input session param inputSubset current input subset
public void	endInput() Mark the end of this InputMode's processing. The only possible call to this InputMode after a call to endInput() is a call to beginInput() to begin a new input session.
public java.lang.String	getCommandName() Returns the command name which will represent this InputMode in the input menu return the locale-appropriate name to represent this InputMode to the user
public javax.microedition.lcdui.Displayable	getDisplayable() Gets displayable for particular input method. If the input method has no specific displayable representation returns null. return displayable
public boolean[][]	getIsConstraintsMap() Returns the map specifying this input mode is proper one for the particular pair of input subset and constraint. The form of the map is |ANY|EMAILADDR|NUMERIC|PHONENUMBER|URL|DECIMAL| --------------------------------------------------------------------- IS_FULLWIDTH_DIGITS |t|f| t|f | t|f | t|f |t|f| t|f | IS_FULLWIDTH_LATIN |t|f| t|f | t|f | t|f |t|f| t|f | IS_HALFWIDTH_KATAKANA |t|f| t|f | t|f | t|f |t|f| t|f | IS_HANJA |t|f| t|f | t|f | t|f |t|f| t|f | IS_KANJI |t|f| t|f | t|f | t|f |t|f| t|f | IS_LATIN |t|f| t|f | t|f | t|f |t|f| t|f | IS_LATIN_DIGITS |t|f| t|f | t|f | t|f |t|f| t|f | IS_SIMPLIFIED_HANZI |t|f| t|f | t|f | t|f |t|f| t|f | IS_TRADITIONAL_HANZI |t|f| t|f | t|f | t|f |t|f| t|f | MIDP_UPPERCASE_LATIN |t|f| t|f | t|f | t|f |t|f| t|f | MIDP_LOWERCASE_LATIN |t|f| t|f | t|f | t|f |t|f| t|f | NULL |t|f| t|f | t|f | t|f |t|f| t|f | return input subset x constraint map
public java.lang.String[]	getMatchList() Gets the possible string matches return returns the set of options.
public java.lang.String	getName() Returns the display name which will represent this InputMode to the user, such as in a selection list or the softbutton bar. return the locale-appropriate name to represent this InputMode to the user
public java.lang.String	getNextMatch() Return the next possible match for the key input processed thus far by this InputMode. A call to this method should be preceeded by a check of hasMoreMatches(). If the InputMode has more available matches for the given input, this method will return them one by one. return a String representing the next available match to the key input thus far, or 'null' if no pending input is available
public char	getPendingChar() return the pending char used to bypass the asynchronous commit mechanism e.g. to immediately commit a char before moving the cursor return return the pending char
public boolean	hasDisplayable() Returns true if input mode is using its own displayable, false ifinput mode does not require the speial displayable for its representation return true if input mode is using its own displayable, otherwise false
public boolean	hasMoreMatches() True, if after processing a key, there is more than one possible match to the input. If this method returns true, the getNextMatch() method can be called to return the value. return true if after processing a key, there is more than the one possible match to the given input
public int	processKey(int keyCode, boolean longPress) Process the given key code as input. This method will return true if the key was processed successfully, false otherwise. param keyCode the keycode of the key which was input param longPress return true if it's long key press otherwise false return the key code if the key has been committed for the input, or KEYCODE_NONE if the key has not been habdled by the input mode, or KEYCODE_INVISIBLE if the key has been handled by the input mode but this key has not been displayed
public boolean	supportsConstraints(int constraints) This method is called to determine if this InputMode supports the given text input constraints. The semantics of the constraints value are defined in the javax.microedition.lcdui.TextField API. If this InputMode returns false, this InputMode must not be used to process key input for the selected text component. param constraints text input constraints. The semantics of the constraints value are defined in the TextField API. return true if this InputMode supports the given text component constraints, as defined in the MIDP TextField API