|
MID Profile | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object | +--javax.microedition.lcdui.Displayable | +--javax.microedition.lcdui.Screen | +--javax.microedition.lcdui.TextBox
The TextBox class is a Screen that allows the user to enter and edit text. The TextBox has a title that is shown at the top of the display. It can be given a piece of text that is used as the initial value. The TextBox has a maximum capacity (in terms of the number of characters) that is set by the application. When the TextBox reaches this maximum capacity, the user is not allowed to enter additional characters unless some are deleted first.
A TextBox has a maximum size, which is the maximum number of characters that can be stored in the object at any time (its capacity). This limit is enforced when the user is editing text within the TextBox, as well as when the application program calls methods on the TextBox that modify its contents. The maximum size is the maximum stored capacity and is unrelated to the number of characters that may be displayed at any given time. The number of characters displayed and their arrangement into rows and columns are determined by the device.
The text contained within a TextBox may be more than can be displayed at one time. If this is the case, the implementation will let the user scroll to view and edit any part of the text. This scrolling occurs transparently to the application.
TextBox has the concept of input constraints that is identical to
TextField. The constraints
parameters of methods within the
TextBox class use constants defined in the TextField
class. See the description of
input constraints
in the TextField class for the definition of these constants.
Constructor Summary | |
TextBox(String title,
String text,
int maxSize,
int constraints)
Creates a new TextBox object with the given title string, initial contents, maximum size in characters, and constraints. |
Method Summary | |
void |
deleteChars(int offset,
int length)
Deletes characters from the TextBox. |
int |
getChars(char[] data)
Copies the contents of the TextBox into a character array starting at index zero. |
int |
getConstraints()
Get the current input constraints of the TextBox. |
int |
getMaxSize()
Returns the maximum size (number of characters) that can be stored in this TextBox. |
int |
getSize()
Gets the number of characters that are currently stored in this TextBox. |
String |
getString()
Gets the contents of the TextBox as a string value. |
void |
insertChars(char[] data,
int offset,
int length,
int position)
Inserts a subrange of an array of characters just prior to the given position. |
void |
insertString(String src,
int position)
Inserts a string into the contents just prior to the given position. |
void |
setChars(char[] data,
int offset,
int length)
Sets the contents of the TextBox from a character array, replacing the previous contents. |
void |
setConstraints(int constraints)
Sets the input constraints of the TextBox. |
void |
setMaxSize(int maxSize)
Sets the maximum size (number of characters) that can be contained in this TextBox. |
void |
setString(String text)
Sets the contents of the TextBox as a string value, replacing the previous contents. |
Methods inherited from class javax.microedition.lcdui.Screen |
getTicker,
getTitle,
setTicker,
setTitle |
Methods inherited from class javax.microedition.lcdui.Displayable |
addCommand,
isShown,
removeCommand,
setListener |
Methods inherited from class java.lang.Object |
equals,
getClass,
hashCode,
notify,
notifyAll,
toString,
wait,
wait,
wait |
Constructor Detail |
public TextBox(String title, String text, int maxSize, int constraints)
title
- the title text to be shown at the top of the displaytext
- the initial contents of the text editing area, null may be used to
indicate no initial content.maxSize
- the maximum capacity in charactersconstraints
- see input constraintsMethod Detail |
public String getString()
public void setString(String text)
text
- the new value of the TextBoxpublic int getChars(char[] data)
data
- the character array to receive the valuepublic void setChars(char[] data, int offset, int length)
data
array
starting at array index offset
and running for
length
characters.
If the data array is null, the TextBox
is set to be empty and the other parameters are ignored.data
- the source of the character dataoffset
- the beginning of the region of characters to copylength
- the number of characters to copypublic void insertString(String src, int position)
src
- the String to be insertedposition
- the position at which insertion is to occurpublic void insertChars(char[] data, int offset, int length, int position)
insertString()
. data
- the source of the character dataoffset
- the beginning of the region of characters to copylength
- the number of characters to copyposition
- the position at which insertion is to occurpublic void deleteChars(int offset, int length)
offset
- the beginning of the region to be deletedlength
- the number of characters to be deletedpublic int getMaxSize()
public void setMaxSize(int maxSize)
maxSize
- the new maximum sizepublic int getSize()
public void setConstraints(int constraints)
constraints
- see input constraintspublic int getConstraints()
|
MID Profile | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |