|
|||||||||
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 maximum size, which is the 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 implementation may place a boundary on the maximum size, and the maximum
size actually assigned may be smaller than the application had requested.
The value actually assigned will be reflected in the value returned by getMaxSize()
. A defensively-written application should
compare this value to the maximum size requested and be prepared to handle
cases where they differ.
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 |
delete(int offset,
int length)
Deletes characters from the TextBox. |
int |
getCaretPosition()
Gets the current input position. |
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. |
String |
getString()
Gets the contents of the TextBox as a string value. |
void |
insert(char[] data,
int offset,
int length,
int position)
Inserts a subrange of an array of characters just prior to the given position. |
void |
insert(String src,
int position)
Inserts a string into the contents of the TextBox. |
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. |
int |
size()
Gets the number of characters that are currently stored in this TextBox. |
Methods inherited from class javax.microedition.lcdui.Screen |
getTicker,
getTitle,
setTicker,
setTitle |
Methods inherited from class javax.microedition.lcdui.Displayable |
addCommand,
isShown,
removeCommand,
setCommandListener |
Methods inherited from class java.lang.Object |
equals,
finalize,
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 characters. The implementation
may limit boundary maximum capacity and the actual assigned capacity
may be smaller than requested. A defensive application will test the
actually given capacity with getMaxSize()
.constraints
- see description of input constraints in
TextField
Method Detail |
public void delete(int offset, int length)
offset
- the beginning of the region to be deletedlength
- the number of characters to be deletedpublic int getCaretPosition()
public int getChars(char[] data)
data
- the character array to receive the valuepublic int getConstraints()
TextField
public int getMaxSize()
public String getString()
public void insert(char[] data, int offset, int length, int position)
insert(String)
.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 insert(String src, int position)
getCaretPosition()
method. For example,
text.insert(s, text.getCaretPosition()) inserts the string s at
the current caret position.src
- the String to be insertedposition
- the position at which insertion is to occurpublic 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 setConstraints(int constraints)
constraints
- see input constraints in TextField
public void setMaxSize(int maxSize)
maxSize
- the new maximum sizepublic void setString(String text)
text
- the new value of the TextBox public int size()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: INNER | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |