| com.sun.midp.chameleon.input.TextInputSession
All known Subclasses: com.sun.midp.chameleon.input.BasicTextInputSession,
| TextInputSession | | public interface TextInputSession (Code) | | The TextInputSession interface represents the relationship between the
system's key input, the TextInputComponent, the available InputModes,
and the graphical display.
|
| Method Summary | |
| public void | beginSession(TextInputComponent component)
Start a text input session for the given TextInputComponent. | | public void | endSession()
End the current text input session and do not commit any pending
input to the buffer. | | public InputMode[] | getAvailableModes()
List the appropriate InputModes available for the current input
session. | | public InputMode | getCurrentInputMode()
Retrieve the InputMode which is the current "active" mode
for this TextInputSession. | | public String[] | getMatchList()
| | public String | getNextMatch()
An iterative method to return the next available match given
the key processing thus far. | | public char | getPendingChar()
return the pending char
used to bypass the asynchronous commit mechanism
e.g. | | public boolean | hasMoreMatches()
If the InputMode supports multiple matches and more matches are
available this method will return true, false otherwise. | | public boolean | isSymbol(char c)
Check if the given char is symbol
Parameters:
c - char true if the char is symbol otherwise false. | | public int | processKey(int keyCode, boolean longPress)
This method abstracts key processing to a single call (from
the assorted key press, release, repeat events). | | public void | setCurrentInputMode(InputMode mode)
Set this TextInputSession's current "active" InputMode to the
given mode. |
| INPUT_SUBSETS | | final public static String[] INPUT_SUBSETS(Code) | | The names of the currently defined input subsets
|
| MAX_CONSTRAINTS | | final public static int MAX_CONSTRAINTS(Code) | | max number of constraints
|
| beginSession | | public void beginSession(TextInputComponent component)(Code) | | Start a text input session for the given TextInputComponent.
The TextInputComponent can be used to determine the initial
input mode, constraints, etc.
Parameters:
component - the TextInputComponent which is receiving text input |
| endSession | | public void endSession()(Code) | | End the current text input session and do not commit any pending
input to the buffer.
|
| getAvailableModes | | public InputMode[] getAvailableModes()(Code) | | List the appropriate InputModes available for the current input
session. This method may be used by UI components in order to make
certain input mode choices available to the user for selection.
If this handler is not currently in an active text input session,
this method returns null.
an array of InputModes which are available to use given thecurrent TextInputComponent and its input constraints |
| getCurrentInputMode | | public InputMode getCurrentInputMode()(Code) | | Retrieve the InputMode which is the current "active" mode
for this TextInputSession. This does not necessarily mean there is
any pending input with the InputMode itself, it means that if this
TextInputSession receives key input, the returned InputMode will be
the mode which processes that input.
the currently "active" InputMode |
| getMatchList | | public String[] getMatchList()(Code) | | Gets the possible string matches
returns the set of options. |
| getNextMatch | | public String getNextMatch()(Code) | | An iterative method to return the next available match given
the key processing thus far. If the return value of hasMoreMatches()
is true, this method will return a non-null String and will iterate
through the entire set of available matches until the set is exhausted.
Each subsequent call to processKey() will reset the iterator over
the set of available matches regardless if the key resulted in a change
to the set.
The two methods, hasMoreMatches() and getNextMatch(), can be used by
the User Interface system to retrieve the current set of pending inputs
and possibly present a chooser option to the user.
a String representing the best possible pendinginput, or null, if there is no pending input |
| 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 |
| hasMoreMatches | | public boolean hasMoreMatches()(Code) | | If the InputMode supports multiple matches and more matches are
available this method will return true, false otherwise.
true if the current InputMode supports multiple matches andthere are currently more matches available |
| isSymbol | | public boolean isSymbol(char c)(Code) | | Check if the given char is symbol
Parameters:
c - char true if the char is symbol otherwise false. |
| processKey | | public int processKey(int keyCode, boolean longPress)(Code) | | This method abstracts key processing to a single call (from
the assorted key press, release, repeat events). This method
should be called from the TextInputComponent to pass along
key input from the user. The TextInputComponent is responsible
for determining what key events should be processed (ie,
key events trigger processing on press or on release).
Parameters:
keyCode - the numeric code representing the key which waspressed
Parameters:
longPress - return true if it's long key press otherwise false true if the current InputMode processed the key event,false if the key was not processed at all by the currentInputMode (not all keys apply to input) |
| setCurrentInputMode | | public void setCurrentInputMode(InputMode mode)(Code) | | Set this TextInputSession's current "active" InputMode to the
given mode. The given mode must be one of the InputModes listed
in the array of InputModes returned from the getAvailableModes()
method of this TextInputSession. Calling this method will terminate
any existing input session with the current InputMode and will
result in any subsequent key input being processed by the given
InputMode. If the given mode is already the current "active"
InputMode, this method has no effect. If this TextInputSession
is not currently in an input session (ie, there is no active
TextInputComponent), this method has no effect.
Parameters:
mode - the InputMode to switch key processing to |
|
|