de.enough.polish.ui
Class FakeTextFieldCustomItem

java.lang.Object
  javax.microedition.lcdui.Item
      javax.microedition.lcdui.CustomItem
          de.enough.polish.ui.FakeCustomItem
              de.enough.polish.ui.FakeStringCustomItem
                  de.enough.polish.ui.FakeTextFieldCustomItem

All Implemented Interfaces:

ItemCommandListener, javax.microedition.lcdui.CommandListener

Direct Known Subclasses:

ChoiceTextField

public class FakeTextFieldCustomItem
extends FakeStringCustomItem
implements javax.microedition.lcdui.CommandListener, ItemCommandListener

Meant for classes that want to be compatible with javax.microedition.lcdui.CustomItem for IDEs only while extending de.enough.polish.ui.StringItem in reality.

Subclasses can change the hierarchy with preprocessing like this:

 public class MyCustomItem
 //#if polish.LibraryBuild
                 extends FakeStringCustomItem
 //#else
                //# extends StringItem
 //#endif        
 

This allows subclasses to access all fields and methods of the J2ME Polish item class.

Note that this class can never be used in reality. Ever.

Since:

J2ME Polish 1.3

Author:

Robert Virkus, robert@enough.de

Field Summary

static int	ANY The user is allowed to enter any text.
protected char	caretChar
protected static javax.microedition.lcdui.Command	CLEAR_CMD
static int	CONSTRAINT_MASK The mask value for determining the constraint mode.
static int	DECIMAL The user is allowed to enter numeric values with optional decimal fractions, for example "-123", "0.123", or ".5".
protected static javax.microedition.lcdui.Command	DELETE_CMD
static int	EMAILADDR The user is allowed to enter an e-mail address.
protected char	emailSeparatorChar
protected boolean	flashCaret
static int	INITIAL_CAPS_SENTENCE This flag is a hint to the implementation that during text editing, the initial letter of each sentence should be capitalized.
static int	INITIAL_CAPS_WORD This flag is a hint to the implementation that during text editing, the initial letter of each word should be capitalized.
protected boolean	isUneditable
protected java.lang.Object	lock
static int	NON_PREDICTIVE Indicates that the text entered does not consist of words that are likely to be found in dictionaries typically used by predictive input schemes.
static int	NUMERIC The user is allowed to enter only an integer value.
static int	PASSWORD Indicates that the text entered is confidential data that should be obscured whenever possible.
static int	PHONENUMBER The user is allowed to enter a phone number.
static int	SENSITIVE Indicates that the text entered is sensitive data that the implementation must never store into a dictionary or table for use in predictive, auto-completing, or other accelerated input schemes.
protected boolean	showCaret
protected java.lang.String	title
static int	UNEDITABLE Indicates that editing is currently disallowed.
static int	URL The user is allowed to enter a URL.

Fields inherited from class de.enough.polish.ui.FakeStringCustomItem

bitMapFont, bitMapFontViewer, clipText, font, text, textColor, textEffect, textHorizontalAdjustment, textLines, textVerticalAdjustment, useSingleLine, xOffset

Fields inherited from class de.enough.polish.ui.FakeCustomItem

_bbField, _bbFieldAdded, appearanceMode, background, backgroundHeight, backgroundWidth, backgroundYOffset, border, borderWidth, BUTTON, colSpan, commands, contentHeight, contentWidth, contentX, contentY, cssSelector, defaultCommand, focusedStyle, HORIZONTAL, HYPERLINK, includeLabel, INTERACTIVE, internalHeight, internalWidth, internalX, internalY, isFocused, isInitialized, isInvisible, isLayoutCenter, isLayoutExpand, isLayoutRight, isPressed, isShown, isStyleInitialised, itemCommandListener, itemHeight, itemWidth, label, labelStyle, layout, LAYOUT_2, LAYOUT_BOTTOM, LAYOUT_CENTER, LAYOUT_DEFAULT, LAYOUT_EXPAND, LAYOUT_LEFT, LAYOUT_NEWLINE_AFTER, LAYOUT_NEWLINE_BEFORE, LAYOUT_RIGHT, LAYOUT_SHRINK, LAYOUT_TOP, LAYOUT_VCENTER, LAYOUT_VEXPAND, LAYOUT_VSHRINK, marginBottom, marginLeft, marginRight, marginTop, maximumHeight, maximumWidth, minimumHeight, minimumWidth, NO_POSITION_SET, paddingBottom, paddingHorizontal, paddingLeft, paddingRight, paddingTop, paddingVertical, parent, PLAIN, preferredHeight, preferredWidth, preserveViewType, relativeX, relativeY, rowSpan, screen, style, TRANSPARENT, VERTICAL, view

Fields inherited from class javax.microedition.lcdui.CustomItem

KEY_PRESS, KEY_RELEASE, KEY_REPEAT, NONE, POINTER_DRAG, POINTER_PRESS, POINTER_RELEASE, TRAVERSE_HORIZONTAL, TRAVERSE_VERTICAL

Constructor Summary

FakeTextFieldCustomItem(java.lang.String label, java.lang.String text, int maxSize, int constraints)
Creates a new TextField object with the given label, initial contents, maximum size in characters, and constraints.

FakeTextFieldCustomItem(java.lang.String label, java.lang.String text, int maxSize, int constraints, Style style)
Creates a new TextField object with the given label, initial contents, maximum size in characters, and constraints.

Method Summary

boolean	animate() Animates this item.
void	commandAction(javax.microedition.lcdui.Command cmd, javax.microedition.lcdui.Displayable box)
void	commandAction(javax.microedition.lcdui.Command cmd, Item item) Called by the system to indicate that a command has been invoked on a particular item.
protected java.lang.String	createCssSelector() Retrieves the CSS selector for this item.
protected void	defocus(Style originalStyle) Removes the focus from this item.
void	delete(int offset, int length) Deletes characters from the TextField.
void	fieldChanged(Field field, int context)
protected Style	focus(Style focStyle, int direction) Focuses this item.
int	getCaretPosition() Gets the current input position.
int	getChars(char[] data) Copies the contents of the TextField into a character array starting at index zero.
int	getConstraints() Gets the current input constraints of the TextField.
java.lang.String	getDotSeparatedDecimalString() Retrieves the decimal value entered with a dot as the decimal mark.
int	getMaxSize() Returns the maximum size (number of characters) that can be stored in this TextField.
java.lang.String	getString() Gets the contents of the TextField as a string value.
protected boolean	handleKeyPressed(int keyCode, int gameAction) Handles the key-pressed event.
protected boolean	handleKeyReleased(int keyCode, int gameAction) Handles the key-released event.
protected boolean	handleKeyRepeated(int keyCode, int gameAction) Handles the key-repeated event.
protected boolean	handlePointerPressed(int x, int y) Handles the event when a pointer has been pressed at the specified position.
protected void	initContent(int firstLineWidth, int lineWidth) Initialises this item.
void	insert(char[] data, int offset, int length, int position) Inserts a subrange of an array of characters into the contents of the TextField.
void	insert(java.lang.String src, int position) Inserts a string into the contents of the TextField.
protected void	insertCharacter()
void	paintContent(int x, int y, int leftBorder, int rightBorder, javax.microedition.lcdui.Graphics g) Paints the content of this item.
void	setCaretPosition(int position) Sets the caret position.
void	setChars(char[] data, int offset, int length) Sets the contents of the TextField from a character array, replacing the previous contents.
void	setConstraints(int constraints) Sets the input constraints of the TextField.
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 TextField.
void	setInputMode(int inputMode) Sets the input mode for this TextField.
void	setItemCommandListener(ItemCommandListener l) Sets a listener for Commands to this Item, replacing any previous ItemCommandListener.
int	setMaxSize(int maxSize) Sets the maximum size (number of characters) that can be contained in this TextField.
void	setString(java.lang.String text) Sets the contents of the TextField as a string value, replacing the previous contents.
void	setStyle(Style style) Sets the style of this item.
int	size() Gets the number of characters that are currently stored in this TextField.

Methods inherited from class de.enough.polish.ui.FakeStringCustomItem

getFont, getText, hideNotify, releaseResources, setFont, setText, setText, showNotify, toString

Methods inherited from class de.enough.polish.ui.FakeCustomItem

addCommand, addCommand, addCommands, addRelativeToBackgroundRegion, addRelativeToContentRegion, animate, containsCommand, getAbsoluteX, getAbsoluteY, getAppearanceMode, getAttribute, getAttributes, getBackgroundHeight, getBackgroundWidth, getBackgroundX, getBackgroundY, getContentHeight, getContentWidth, getContentX, getContentY, getDefaultCommand, getFocusedStyle, getItemAt, getItemCommandListener, getItemHeight, getItemStateListener, getItemWidth, getLabel, getLabelItem, getLayout, getMinContentHeight, getMinContentWidth, getMinimumHeight, getMinimumWidth, getParent, getPrefContentHeight, getPrefContentWidth, getPreferredHeight, getPreferredWidth, getScreen, getStyle, handleCommand, handlePointerReleased, init, initStyle, isInContentArea, isInItemArea, isVisible, notifyItemPressedEnd, notifyItemPressedStart, notifyStateChanged, paint, paint, paintBackground, paintBackgroundAndBorder, paintBorder, removeCommand, repaintFully, requestInit, setAppearanceMode, setAttribute, setDefaultCommand, setItemCommandListener, setItemStateListener, setLabel, setLayout, setPreferredSize, setVisible, show, showCommands

Methods inherited from class javax.microedition.lcdui.CustomItem

getGameAction, getInteractionModes, invalidate, keyPressed, keyReleased, keyRepeated, pointerDragged, pointerPressed, pointerReleased, repaint, repaint, sizeChanged, traverse, traverseOut

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

ANY

public static final int ANY

The user is allowed to enter any text. Line breaks may be entered.

Constant 0 is assigned to ANY.

See Also:

Constant Field Values

EMAILADDR

public static final int EMAILADDR

The user is allowed to enter an e-mail address.

Constant 1 is assigned to EMAILADDR.

See Also:

Constant Field Values

NUMERIC

public static final int NUMERIC

The user is allowed to enter only an integer value. The implementation must restrict the contents either to be empty or to consist of an optional minus sign followed by a string of one or more decimal numerals. Unless the value is empty, it will be successfully parsable using Integer.parseInt(String).

The minus sign consumes space in the text object. It is thus impossible to enter negative numbers into a text object whose maximum size is 1.

Constant 2 is assigned to NUMERIC.

See Also:

Constant Field Values

PHONENUMBER

public static final int PHONENUMBER

The user is allowed to enter a phone number. The phone number is a special case, since a phone-based implementation may be linked to the native phone dialing application. The implementation may automatically start a phone dialer application that is initialized so that pressing a single key would be enough to make a call. The call must not made automatically without requiring user's confirmation. Implementations may also provide a feature to look up the phone number in the device's phone or address database.

The exact set of characters allowed is specific to the device and to the device's network and may include non-numeric characters, such as a "+" prefix character.

Some platforms may provide the capability to initiate voice calls using the MIDlet.platformRequest method.

Constant 3 is assigned to PHONENUMBER.

See Also:

Constant Field Values

URL

public static final int URL

The user is allowed to enter a URL.

Constant 4 is assigned to URL.

See Also:

Constant Field Values

DECIMAL

public static final int DECIMAL

The user is allowed to enter numeric values with optional decimal fractions, for example "-123", "0.123", or ".5".

The implementation may display a period "." or a comma "," for the decimal fraction separator, depending on the conventions in use on the device. Similarly, the implementation may display other device-specific characters as part of a decimal string, such as spaces or commas for digit separators. However, the only characters allowed in the actual contents of the text object are period ".", minus sign "-", and the decimal digits.

The actual contents of a DECIMAL text object may be empty. If the actual contents are not empty, they must conform to a subset of the syntax for a FloatingPointLiteral as defined by the Java Language Specification, section 3.10.2. This subset syntax is defined as follows: the actual contents must consist of an optional minus sign "-", followed by one or more whole-number decimal digits, followed by an optional fraction separator, followed by zero or more decimal fraction digits. The whole-number decimal digits may be omitted if the fraction separator and one or more decimal fraction digits are present.

The syntax defined above is also enforced whenever the application attempts to set or modify the contents of the text object by calling a constructor or a method.

Parsing this string value into a numeric value suitable for computation is the responsibility of the application. If the contents are not empty, the result can be parsed successfully by Double.valueOf and related methods if they are present in the runtime environment.

The sign and the fraction separator consume space in the text object. Applications should account for this when assigning a maximum size for the text object.

Constant 5 is assigned to DECIMAL.

Since:

MIDP 2.0

See Also:

Constant Field Values

PASSWORD

public static final int PASSWORD

Indicates that the text entered is confidential data that should be obscured whenever possible. The contents may be visible while the user is entering data. However, the contents must never be divulged to the user. In particular, the existing contents must not be shown when the user edits the contents. The means by which the contents are obscured is implementation-dependent. For example, each character of the data might be masked with a "*" character. The PASSWORD modifier is useful for entering confidential information such as passwords or personal identification numbers (PINs).

Data entered into a PASSWORD field is treated similarly to SENSITIVE in that the implementation must never store the contents into a dictionary or table for use in predictive, auto-completing, or other accelerated input schemes. If the PASSWORD bit is set in a constraint value, the SENSITIVE and NON_PREDICTIVE bits are also considered to be set, regardless of their actual values. In addition, the INITIAL_CAPS_WORD and INITIAL_CAPS_SENTENCE flag bits should be ignored even if they are set.

The PASSWORD modifier can be combined with other input constraints by using the bit-wise OR operator (|). The PASSWORD modifier is not useful with some constraint values such as EMAILADDR, PHONENUMBER, and URL. These combinations are legal, however, and no exception is thrown if such a constraint is specified.

Constant 0x10000 is assigned to PASSWORD.

See Also:

Constant Field Values

UNEDITABLE

public static final int UNEDITABLE

Indicates that editing is currently disallowed. When this flag is set, the implementation must prevent the user from changing the text contents of this object. The implementation should also provide a visual indication that the object's text cannot be edited. The intent of this flag is that this text object has the potential to be edited, and that there are circumstances where the application will clear this flag and allow the user to edit the contents.

The UNEDITABLE modifier can be combined with other input constraints by using the bit-wise OR operator (|).

Constant 0x20000 is assigned to UNEDITABLE.

Since:

MIDP 2.0

See Also:

Constant Field Values

SENSITIVE

public static final int SENSITIVE

Indicates that the text entered is sensitive data that the implementation must never store into a dictionary or table for use in predictive, auto-completing, or other accelerated input schemes. A credit card number is an example of sensitive data.

The SENSITIVE modifier can be combined with other input constraints by using the bit-wise OR operator (|).

Constant 0x40000 is assigned to SENSITIVE.

Since:

MIDP 2.0

See Also:

Constant Field Values

NON_PREDICTIVE

public static final int NON_PREDICTIVE

Indicates that the text entered does not consist of words that are likely to be found in dictionaries typically used by predictive input schemes. If this bit is clear, the implementation is allowed to (but is not required to) use predictive input facilities. If this bit is set, the implementation should not use any predictive input facilities, but it instead should allow character-by-character text entry.

The NON_PREDICTIVE modifier can be combined with other input constraints by using the bit-wise OR operator (|).

Constant 0x80000 is assigned to NON_PREDICTIVE.

Since:

MIDP 2.0

See Also:

Constant Field Values

INITIAL_CAPS_WORD

public static final int INITIAL_CAPS_WORD

This flag is a hint to the implementation that during text editing, the initial letter of each word should be capitalized. This hint should be honored only on devices for which automatic capitalization is appropriate and when the character set of the text being edited has the notion of upper case and lower case letters. The definition of word boundaries is implementation-specific.

If the application specifies both the INITIAL_CAPS_WORD and the INITIAL_CAPS_SENTENCE flags, INITIAL_CAPS_WORD behavior should be used.

The INITIAL_CAPS_WORD modifier can be combined with other input constraints by using the bit-wise OR operator (|).

Constant 0x100000 is assigned to INITIAL_CAPS_WORD.

Since:

MIDP 2.0

See Also:

Constant Field Values

INITIAL_CAPS_SENTENCE

public static final int INITIAL_CAPS_SENTENCE

This flag is a hint to the implementation that during text editing, the initial letter of each sentence should be capitalized. This hint should be honored only on devices for which automatic capitalization is appropriate and when the character set of the text being edited has the notion of upper case and lower case letters. The definition of sentence boundaries is implementation-specific.

If the application specifies both the INITIAL_CAPS_WORD and the INITIAL_CAPS_SENTENCE flags, INITIAL_CAPS_WORD behavior should be used.

The INITIAL_CAPS_SENTENCE modifier can be combined with other input constraints by using the bit-wise OR operator (|).

Constant 0x200000 is assigned to INITIAL_CAPS_SENTENCE.

Since:

MIDP 2.0

See Also:

Constant Field Values

CONSTRAINT_MASK

public static final int CONSTRAINT_MASK

The mask value for determining the constraint mode. The application should use the bit-wise AND operation with a value returned by getConstraints() and CONSTRAINT_MASK in order to retrieve the current constraint mode, in order to remove any modifier flags such as the PASSWORD flag.

Constant 0xFFFF is assigned to CONSTRAINT_MASK.

See Also:

Constant Field Values

DELETE_CMD

protected static javax.microedition.lcdui.Command DELETE_CMD

CLEAR_CMD

protected static javax.microedition.lcdui.Command CLEAR_CMD

caretChar

protected char caretChar

showCaret

protected boolean showCaret

title

protected java.lang.String title

emailSeparatorChar

protected char emailSeparatorChar

lock

protected final java.lang.Object lock

flashCaret

protected boolean flashCaret

isUneditable

protected boolean isUneditable

Constructor Detail

FakeTextFieldCustomItem

public FakeTextFieldCustomItem(java.lang.String label,
                               java.lang.String text,
                               int maxSize,
                               int constraints)

Creates a new TextField object with the given label, initial contents, maximum size in characters, and constraints. If the text parameter is null, the TextField 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.

Parameters:

label - item label

text - the initial contents, or null if the TextField is to be empty

maxSize - the maximum capacity in characters

constraints - see input constraints

Throws:

java.lang.IllegalArgumentException - if maxSize is zero or less or if the value of the constraints parameter is invalid or if text is illegal for the specified constraints or if the length of the string exceeds the requested maximum capacity

FakeTextFieldCustomItem

public FakeTextFieldCustomItem(java.lang.String label,
                               java.lang.String text,
                               int maxSize,
                               int constraints,
                               Style style)

Creates a new TextField object with the given label, initial contents, maximum size in characters, and constraints. If the text parameter is null, the TextField 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.

Parameters:

label - item label

text - the initial contents, or null if the TextField is to be empty

maxSize - the maximum capacity in characters

constraints - see input constraints

style - the CSS style for this field

Throws:

java.lang.IllegalArgumentException - if maxSize is zero or less or if the value of the constraints parameter is invalid or if text is illegal for the specified constraints or if the length of the string exceeds the requested maximum capacity

Method Detail

getString

public java.lang.String getString()

Gets the contents of the TextField as a string value.

Returns:

the current contents, an empty string when the current value is null.

See Also:

setString(java.lang.String)

getDotSeparatedDecimalString

public java.lang.String getDotSeparatedDecimalString()

Retrieves the decimal value entered with a dot as the decimal mark.

• When the value has no decimal places it will be returned as it is: 12
• When the value is null, null will be returned: null
• When the value has decimal places, a dot will be used: 12.3

Returns:

either the formatted value or null, when there was no input.

Throws:

java.lang.IllegalStateException - when the TextField is not DECIMAL constrained

setString

public void setString(java.lang.String text)

Sets the contents of the TextField as a string value, replacing the previous contents.

Parameters:

text - the new value of the TextField, or null if the TextField is to be made empty

Throws:

java.lang.IllegalArgumentException - if text is illegal for the current input constraints or if the text would exceed the current maximum capacity

See Also:

getString()

getChars

public int getChars(char[] data)

Copies the contents of the TextField into a character array starting at index zero. Array elements beyond the characters copied are left unchanged.

Parameters:

data - the character array to receive the value

Returns:

the number of characters copied

Throws:

java.lang.ArrayIndexOutOfBoundsException - if the array is too short for the contents

java.lang.NullPointerException - if data is null

See Also:

setChars(char[], int, int)

setChars

public void setChars(char[] data,
                     int offset,
                     int length)

Sets the contents of the TextField 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 TextField 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.

Parameters:

data - the source of the character data

offset - the beginning of the region of characters to copy

length - the number of characters to copy

Throws:

java.lang.ArrayIndexOutOfBoundsException - - if offset and length do not specify a valid range within the data array

java.lang.IllegalArgumentException - - if data is illegal for the current input constraints or if the text would exceed the current maximum capacity

See Also:

getChars(char[])

insert

public void insert(java.lang.String src,
                   int position)

Inserts a string into the contents of the TextField. 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 TextField. 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 getCaretPosition() method. For example, text.insert(s, text.getCaretPosition()) inserts the string s at the current caret position.

Parameters:

src - the String to be inserted

position - the position at which insertion is to occur

Throws:

java.lang.IllegalArgumentException - if the resulting contents would be illegal for the current input constraints or if the insertion would exceed the current maximum capacity

java.lang.NullPointerException - if src is null

insert

public void insert(char[] data,
                   int offset,
                   int length,
                   int position)

Inserts a subrange of an array of characters into the contents of the TextField. The offset and length parameters indicate the subrange of the data array to be used for insertion. Behavior is otherwise identical to 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.

Parameters:

data - - the source of the character data

offset - - the beginning of the region of characters to copy

length - - the number of characters to copy

position - - the position at which insertion is to occur

Throws:

java.lang.ArrayIndexOutOfBoundsException - - if offset and length do not specify a valid range within the data array

java.lang.IllegalArgumentException - - if the resulting contents would be illegal for the current input constraints or if the insertion would exceed the current maximum capacity

java.lang.NullPointerException - - if data is null

delete

public void delete(int offset,
                   int length)

Deletes characters from the TextField.

The offset and length parameters must specify a valid range of characters within the contents of the TextField. 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().

Parameters:

offset - the beginning of the region to be deleted

length - the number of characters to be deleted

Throws:

java.lang.IllegalArgumentException - if the resulting contents would be illegal for the current input constraints

java.lang.StringIndexOutOfBoundsException - if offset and length do not specify a valid range within the contents of the TextField

getMaxSize

public int getMaxSize()

Returns the maximum size (number of characters) that can be stored in this TextField.

Returns:

the maximum size in characters

See Also:

setMaxSize(int)

setMaxSize

public int setMaxSize(int maxSize)

Sets the maximum size (number of characters) that can be contained in this TextField. If the current contents of the TextField are larger than maxSize, the contents are truncated to fit.

Parameters:

maxSize - the new maximum size

Returns:

assigned maximum capacity may be smaller than requested.

Throws:

java.lang.IllegalArgumentException - if maxSize is zero or less. or if the contents after truncation would be illegal for the current input constraints

See Also:

getMaxSize()

size

public int size()

Gets the number of characters that are currently stored in this TextField.

Returns:

number of characters in the TextField

getCaretPosition

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. When the direct input mode is used, this method simply returns the current cursor position (= non blocking).

Returns:

the current caret position, 0 if at the beginning

setCaretPosition

public void setCaretPosition(int position)

Sets the caret position. Please note that this operation requires the direct input mode to work.

Parameters:

position - the new caret position, 0 puts the caret at the start of the line, getString().length moves the caret to the end of the input.

setConstraints

public void setConstraints(int constraints)

Sets the input constraints of the TextField. If the the current contents of the TextField do not match the new constraints, the contents are set to empty.

Parameters:

constraints - see input constraints

Throws:

java.lang.IllegalArgumentException - if constraints is not any of the ones specified in input constraints

See Also:

getConstraints()

getConstraints

public int getConstraints()

Gets the current input constraints of the TextField.

Returns:

the current constraints value (see input constraints)

See Also:

setConstraints(int)

setInitialInputMode

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 TextField. 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.

When the direct input mode is used, J2ME Polish will ignore this call completely.

Parameters:

characterSubset - a string naming a Unicode character subset, or null

Since:

MIDP 2.0

paintContent

public void paintContent(int x,
                         int y,
                         int leftBorder,
                         int rightBorder,
                         javax.microedition.lcdui.Graphics g)

Description copied from class: FakeCustomItem

Paints the content of this item. The background has already been painted and the border will be added after this method returns.

Overrides:

paintContent in class FakeStringCustomItem

Parameters:

x - the left start position

y - the upper start position

leftBorder - the left border, nothing must be painted left of this position

rightBorder - the right border, nothing must be painted right of this position

g - the Graphics on which this item should be painted.

initContent

protected void initContent(int firstLineWidth,
                           int lineWidth)

Description copied from class: FakeCustomItem

Initialises this item. The implementation needs to calculate and set the contentWidth and contentHeight fields. The implementation should take the fields preferredWidth and preferredHeight into account.

Overrides:

initContent in class FakeStringCustomItem

Parameters:

firstLineWidth - the maximum width of the first line

lineWidth - the maximum width of any following lines

See Also:

FakeCustomItem.contentWidth, FakeCustomItem.contentHeight, FakeCustomItem.preferredWidth, FakeCustomItem.preferredHeight

createCssSelector

protected java.lang.String createCssSelector()

Description copied from class: FakeCustomItem

Retrieves the CSS selector for this item. The CSS selector is used for the dynamic assignment of styles - that is the styles are assigned by the usage of the item and not by a predefined style-name. With the #style preprocessing command styles are set fix, this method yields in a faster GUI and is recommended. When in a style-sheet dynamic styles are used, e.g. "Form>p", than the selector of the item is needed.
This abstract method needs only be implemented, when dynamic styles are used: #ifdef polish.useDynamicStyles
The returned selector needs to be in lower case.

Overrides:

createCssSelector in class FakeStringCustomItem

Returns:

the appropriate CSS selector for this item. The selector needs to be in lower case.

setStyle

public void setStyle(Style style)

Description copied from class: FakeCustomItem

Sets the style of this item.

Overrides:

setStyle in class FakeStringCustomItem

Parameters:

style - the new style for this item.

insertCharacter

protected void insertCharacter()

animate

public boolean animate()

Description copied from class: FakeCustomItem

Animates this item. Subclasses can override this method to create animations. The default implementation animates the background and the item view if present.

Overrides:

animate in class FakeStringCustomItem

Returns:

true when this item has been animated.

handleKeyPressed

protected boolean handleKeyPressed(int keyCode,
                                   int gameAction)

Description copied from class: FakeCustomItem

Handles the key-pressed event. Please note, that implementation should first try to handle the given key-code, before the game-action is processed. The default implementation just handles the FIRE game-action when a default-command and an item-command-listener have been registered.

Overrides:

handleKeyPressed in class FakeCustomItem

Parameters:

keyCode - the code of the pressed key, e.g. Canvas.KEY_NUM2

gameAction - the corresponding game-action, e.g. Canvas.UP

Returns:

true when the key has been handled / recognized

handleKeyRepeated

protected boolean handleKeyRepeated(int keyCode,
                                    int gameAction)

Description copied from class: FakeCustomItem

Handles the key-repeated event. Please note, that implementation should first try to handle the given key-code, before the game-action is processed. The default implementation forwards the event to the handleKeyPressed method.

Overrides:

handleKeyRepeated in class FakeCustomItem

Parameters:

keyCode - the code of the pressed key, e.g. Canvas.KEY_NUM2

gameAction - the corresponding game-action, e.g. Canvas.UP

Returns:

true when the key has been handled / recognized

See Also:

FakeCustomItem.handleKeyPressed(int, int)

handleKeyReleased

protected boolean handleKeyReleased(int keyCode,
                                    int gameAction)

Description copied from class: FakeCustomItem

Handles the key-released event. Please note, that implementation should first try to handle the given key-code, before the game-action is processed. The default does nothing.

Overrides:

handleKeyReleased in class FakeCustomItem

Parameters:

keyCode - the code of the pressed key, e.g. Canvas.KEY_NUM2

gameAction - the corresponding game-action, e.g. Canvas.UP

Returns:

true when the key has been handled / recognized

See Also:

FakeCustomItem.handleKeyPressed(int, int)

handlePointerPressed

protected boolean handlePointerPressed(int x,
                                       int y)

Handles the event when a pointer has been pressed at the specified position. The default method translates the pointer-event into an artificial pressing of the FIRE game-action, which is subsequently handled bu the handleKeyPressed(-1, Canvas.FIRE) method. This method needs should be overwritten only when the "polish.hasPointerEvents" preprocessing symbol is defined: "//#ifdef polish.hasPointerEvents".

Overrides:

handlePointerPressed in class FakeCustomItem

Parameters:

x - the x position of the pointer pressing

y - the y position of the pointer pressing

Returns:

true when the pressing of the pointer was actually handled by this item.

See Also:

this method is used for determining whether the event belongs to this item, for a helper method for determining whether the event took place into the actual content area, FakeCustomItem.handleKeyPressed(int, int), for calculating the horizontal position relative to the content (relX - contentX), for calculating the vertical position relative to the content (relY - contentY)

commandAction

public void commandAction(javax.microedition.lcdui.Command cmd,
                          javax.microedition.lcdui.Displayable box)

Specified by:

commandAction in interface javax.microedition.lcdui.CommandListener

setItemCommandListener

public void setItemCommandListener(ItemCommandListener l)

Description copied from class: FakeCustomItem

Sets a listener for Commands to this Item, replacing any previous ItemCommandListener. A null reference is allowed and has the effect of removing any existing listener. When no listener is registered, J2ME Polish notifies the command-listener of the current screen, when an item command has been selected.

It is illegal to call this method if this Item is contained within an Alert.

Overrides:

setItemCommandListener in class FakeCustomItem

Parameters:

l - the new listener, or null.

commandAction

public void commandAction(javax.microedition.lcdui.Command cmd,
                          Item item)

Description copied from interface: ItemCommandListener

Called by the system to indicate that a command has been invoked on a particular item.

Specified by:

commandAction in interface ItemCommandListener

Parameters:

cmd - the Command that was invoked

item - the Item on which the command was invoked

defocus

protected void defocus(Style originalStyle)

Description copied from class: FakeCustomItem

Removes the focus from this item.

Overrides:

defocus in class FakeStringCustomItem

Parameters:

originalStyle - the original style which will be restored.

focus

protected Style focus(Style focStyle,
                      int direction)

Description copied from class: FakeCustomItem

Focuses this item.

Overrides:

focus in class FakeCustomItem

Parameters:

focStyle - the style which is used to indicate the focused state

direction - the direction from which this item is focused, either Canvas.UP, Canvas.DOWN, Canvas.LEFT, Canvas.RIGHT or 0. When 0 is given, the direction is unknown.

Returns:

the current style of this item

fieldChanged

public void fieldChanged(Field field,
                         int context)

setInputMode

public void setInputMode(int inputMode)

Sets the input mode for this TextField. Is ignored when no direct input mode is used.

Parameters:

inputMode - the input mode