| java.lang.Object
 com.sun.midp.chameleon.input.PredictiveTextInputMode
| PredictiveTextInputMode | | public class PredictiveTextInputMode implements InputMode(Code) | | An InputMode instance which processes the numeric 0-9 keys
as their literal numeric values.
|
| Method Summary | |
| public void | beginInput(InputModeMediator mediator, 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. | | public void | clear()
| | public void | endInput()
Mark the end of this InputMode's processing. | | public String | getCommandName()
| | public Displayable | getDisplayable()
By default the regular input method has no specific displayable
representation so it returns null. | | public boolean[][] | getIsConstraintsMap()
Returns the map specifying this input mode is proper one for the
particular pair of input subset and constraint. | | public String[] | getMatchList()
| | public String | getName()
Returns the display name which will represent this InputMode to
the user, such as in a selection list or the softbutton bar. | | public String | getNextMatch()
Return the next possible match for the key input processed thus
far by this InputMode. | | public char | getPendingChar()
return the pending char
used to bypass the asynchronous commit mechanism
e.g. | | public String | getPrevMatch()
Return the previous possible match for the key input processed thus
far by this InputMode. | | 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. | | public boolean | hasMoreMatches()
True, if after processing a key, there is more than one possible
match to the 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.
Parameters:
keyCode - the keycode of the key which was input
Parameters:
longPress - true if long key press happens, otherwise false. | | void | processKeyCode(int keyCode)
Process a new key in range '2'-'9'. | | public boolean | supportsConstraints(int constraints)
This method is called to determine if this InputMode supports
the given text input constraints. | | protected void | validateState(boolean activeOperation)
This method will validate the state of this InputMode. |
| beginInput | | public void beginInput(InputModeMediator mediator, String inputSubset, int constraints)(Code) | | 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.
Parameters:
constraints - text input constraints. The semantics of the constraints value are defined in the TextField API.
Parameters:
mediator - the InputModeMediator which is negotiating therelationship between this InputMode and the input session
Parameters:
inputSubset - current input subset |
| clear | | public void clear()(Code) | | Clear the iterator
|
| endInput | | public void endInput()(Code) | | 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.
|
| getCommandName | | public String getCommandName()(Code) | | Returns the command name which will represent this InputMode to
the user
the locale-appropriate command name to represent this InputModeto the user |
| getDisplayable | | public Displayable getDisplayable()(Code) | | By default the regular input method has no specific displayable
representation so it returns null.
null by default |
| getIsConstraintsMap | | public boolean[][] getIsConstraintsMap()(Code) | | 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 |
input subset x constraint map |
| getMatchList | | public String[] getMatchList()(Code) | | Gets the possible string matches
returns the set of options. |
| getName | | public String getName()(Code) | | Returns the display name which will represent this InputMode to
the user, such as in a selection list or the softbutton bar.
the locale-appropriate name to represent this InputModeto the user |
| getNextMatch | | public String getNextMatch()(Code) | | 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.
a String representing the next available match to the key input thus far, or 'null' if no pending input is available |
| getPendingChar | | public char getPendingChar()(Code) | | return the pending char
used to bypass the asynchronous commit mechanism
e.g. to immediately commit a char before moving the cursor
return the pending char |
| getPrevMatch | | public String getPrevMatch()(Code) | | Return the previous possible match for the key input processed thus
far by this InputMode.
a String representing the previous available match to the key input thus far, or 'null' if no pending input is available |
| hasDisplayable | | public boolean hasDisplayable()(Code) | | Returns true if input mode is using its own displayable, false ifinput
mode does not require the speial displayable for its representation.
By default returns false
true if input mode is using its own displayable, otherwise false |
| hasMoreMatches | | public boolean hasMoreMatches()(Code) | | 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.
true if after processing a key, there is more than the onepossible match to the given input |
| processKey | | public int processKey(int keyCode, boolean longPress)(Code) | | Process the given key code as input.
This method will return true if the key was processed successfully,
false otherwise.
Parameters:
keyCode - the keycode of the key which was input
Parameters:
longPress - true if long key press happens, otherwise false. the key code if the key has been committed for the input, orKEYCODE_NONE if the key has not been habdled by the input mode, orKEYCODE_INVISIBLE if the key has been handled by the input mode butthis key has not been displayed |
| processKeyCode | | void processKeyCode(int keyCode)(Code) | | Process a new key in range '2'-'9'.
Advnace the iterator and update the word part
Parameters:
keyCode - char in range '0'-'9','#', '*' |
| supportsConstraints | | public boolean supportsConstraints(int constraints)(Code) | | 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.
Parameters:
constraints - current constraints.The constraints format is defined in TextField. true if this InputMode supports the given text componentconstraints, as defined in the MIDP TextField API |
| validateState | | protected void validateState(boolean activeOperation)(Code) | | This method will validate the state of this InputMode. If this
is a check for an "active" operation, the TextInputMediator must
be non-null or else this method will throw an IllegalStateException.
If this is a check for an "inactive" operation, then the
TextInputMediator should be null.
Parameters:
activeOperation - true if any operation is active otherwise false. |
|
|