File	Doc	Category	Size	Date	Package
TextBox.java	API Doc	phoneME MR2 API (J2ME)	17673	Wed May 02 18:00:24 BST 2007	javax.microedition.lcdui

TextBox

• java.lang.Object
  • Screen

Fields Summary
TextField	textField text field object to put on the form
FormLF	textBoxLF Look & feel object associated with this TextBox

Constructors Summary

public 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. If the text parameter is null, the TextBox is created empty. The maxSize parameter must be greater than zero. An IllegalArgumentException is thrown if the length of the initial contents string exceeds maxSize. However, the implementation may assign a maximum size smaller than the application had requested. If this occurs, and if the length of the contents exceeds the newly assigned maximum size, the contents are truncated from the end in order to fit, and no exception is thrown. param title the title text to be shown with the display param text the initial contents of the text editing area, null may be used to indicate no initial content param maxSize the maximum capacity in characters. The implementation may limit boundary maximum capacity and the actually assigned capacity may me smaller than requested. A defensive application will test the actually given capacity with {@link #getMaxSize()}. param constraints see input constraints throws IllegalArgumentException if maxSize is zero or less throws IllegalArgumentException if the constraints parameter is invalid throws IllegalArgumentException if text is illegal for the specified constraints throws IllegalArgumentException if the length of the string exceeds the requested maximum capacity super(title); synchronized (Display.LCDUILock) { textField = new TextField(null, text, maxSize, constraints, true); textField.lSetOwner(this); displayableLF = textBoxLF = LFFactory.getFactory().getTextBoxFormLF(this); }

Methods Summary
public void	delete(int offset, int length) Deletes characters from the TextBox. The offset and length parameters must specify a valid range of characters within the contents of the TextBox. The offset parameter must be within the range [0..(size())], inclusive. The length parameter must be a non-negative integer such that (offset + length) <= size(). param offset the beginning of the region to be deleted param length the number of characters to be deleted throws IllegalArgumentException if the resulting contents would be illegal for the current input constraints throws StringIndexOutOfBoundsException if offset and length do not specify a valid range within the contents of the TextBox textField.delete(offset, length);
public int	getCaretPosition() Gets the current input position. For some UIs this may block and ask the user for the intended caret position, and on other UIs this may simply return the current caret position. return the current caret position, 0 if at the beginning // returns a value relative to the flat input text return textField.getCaretPosition();
public int	getChars(char[] data) Copies the contents of the TextBox into a character array starting at index zero. Array elements beyond the characters copied are left unchanged. param data the character array to receive the value return the number of characters copied throws ArrayIndexOutOfBoundsException if the array is too short for the contents throws NullPointerException if data is null see #setChars return textField.getChars(data);
public int	getConstraints() Gets the current input constraints of the TextBox. return the current constraints value (see input constraints) see #setConstraints return textField.getConstraints();
public int	getMaxSize() Returns the maximum size (number of characters) that can be stored in this TextBox. return the maximum size in characters see #setMaxSize return textField.getMaxSize();
public java.lang.String	getString() Gets the contents of the TextBox as a string value. return the current contents see #setString return textField.getString();
public void	insert(java.lang.String src, int position) Inserts a string into the contents of the TextBox. The string is inserted just prior to the character indicated by the position parameter, where zero specifies the first character of the contents of the TextBox. If position is less than or equal to zero, the insertion occurs at the beginning of the contents, thus effecting a prepend operation. If position is greater than or equal to the current size of the contents, the insertion occurs immediately after the end of the contents, thus effecting an append operation. For example, text.insert(s, text.size()) always appends the string s to the current contents. The current size of the contents is increased by the number of inserted characters. The resulting string must fit within the current maximum capacity. If the application needs to simulate typing of characters it can determining the location of the current insertion point ("caret") using the with {@link #getCaretPosition() getCaretPosition()} method. For example, text.insert(s, text.getCaretPosition()) inserts the string s at the current caret position. param src the String to be inserted param position the position at which insertion is to occur throws IllegalArgumentException if the resulting contents would be illegal for the current input constraints throws IllegalArgumentException if the insertion would exceed the current maximum capacity throws NullPointerException if src is null textField.insert(src, position);
public void	insert(char[] data, int offset, int length, int position) Inserts a subrange of an array of characters into the contents of the TextBox. The offset and length parameters indicate the subrange of the data array to be used for insertion. Behavior is otherwise identical to {@link #insert(String, int) insert(String, int)}. The offset and length parameters must specify a valid range of characters within the character array data. The offset parameter must be within the range [0..(data.length)], inclusive. The length parameter must be a non-negative integer such that (offset + length) <= data.length. param data the source of the character data param offset the beginning of the region of characters to copy param length the number of characters to copy param position the position at which insertion is to occur throws ArrayIndexOutOfBoundsException if offset and length do not specify a valid range within the data array throws IllegalArgumentException if the resulting contents would be illegal for the current input constraints throws IllegalArgumentException if the insertion would exceed the current maximum capacity throws NullPointerException if data is null textField.insert(data, offset, length, position);
public void	setChars(char[] data, int offset, int length) Sets the contents of the TextBox from a character array, replacing the previous contents. Characters are copied from the region of the 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. The offset and length parameters must specify a valid range of characters within the character array data. The offset parameter must be within the range [0..(data.length)], inclusive. The length parameter must be a non-negative integer such that (offset + length) <= data.length. param data the source of the character data param offset the beginning of the region of characters to copy param length the number of characters to copy throws ArrayIndexOutOfBoundsException if offset and length do not specify a valid range within the data array throws IllegalArgumentException if data is illegal for the current input constraints throws IllegalArgumentException if the text would exceed the current maximum capacity see #getChars textField.setChars(data, offset, length);
public void	setConstraints(int constraints) Sets the input constraints of the TextBox. If the current contents of the TextBox do not match the new constraints, the contents are set to empty. param constraints see input constraints throws IllegalArgumentException if the value of the constraints parameter is invalid see #getConstraints textField.setConstraints(constraints);
public void	setInitialInputMode(java.lang.String characterSubset) Sets a hint to the implementation as to the input mode that should be used when the user initiates editing of this TextBox. The characterSubset parameter names a subset of Unicode characters that is used by the implementation to choose an initial input mode. If null is passed, the implementation should choose a default input mode. See Input Modes for a full explanation of input modes. param characterSubset a string naming a Unicode character subset, or null textField.setInitialInputMode(characterSubset);
public int	setMaxSize(int maxSize) Sets the maximum size (number of characters) that can be contained in this TextBox. If the current contents of the TextBox are larger than maxSize, the contents are truncated to fit. param maxSize the new maximum size return assigned maximum capacity - may be smaller than requested. throws IllegalArgumentException if maxSize is zero or less. throws IllegalArgumentException if the contents after truncation would be illegal for the current input constraints see #getMaxSize return textField.setMaxSize(maxSize);
public void	setString(java.lang.String text) Sets the contents of the TextBox as a string value, replacing the previous contents. param text the new value of the TextBox, or null if the TextBox is to be made empty throws IllegalArgumentException if text is illegal for the current input constraints throws IllegalArgumentException if the text would exceed the current maximum capacity see #getString textField.setString(text);
public int	size() Gets the number of characters that are currently stored in this TextBox. return the number of characters // returns a value relative to the display text including formatting return textField.size();