TextField

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

de.enough.polish.ui
Class TextField

java.lang.Object
  de.enough.polish.ui.Item
      de.enough.polish.ui.StringItem
          de.enough.polish.ui.TextField

All Implemented Interfaces:: ItemCommandListener, javax.microedition.lcdui.CommandListener

public class TextField
extends StringItem
implements javax.microedition.lcdui.CommandListener, ItemCommandListener
extends StringItem
implements javax.microedition.lcdui.CommandListener, ItemCommandListener

A TextField is an editable text component that may be placed into a Form. It can be given a piece of text that is used as the initial value.

A TextField 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 TextField instance is constructed, when the user is editing text within the TextField, as well as when the application program calls methods on the TextField 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.

Input Constraints

The TextField shares the concept of input constraints with the TextBox class. The different constraints allow the application to request that the user's input be restricted in a variety of ways. The implementation is required to restrict the user's input as requested by the application. For example, if the application requests the NUMERIC constraint on a TextField, the implementation must allow only numeric characters to be entered.

The actual contents of the text object are set and modified by and are reported to the application through the TextBox and TextField APIs. The displayed contents may differ from the actual contents if the implementation has chosen to provide special formatting suitable for the text object's constraint setting. For example, a PHONENUMBER field might be displayed with digit separators and punctuation as appropriate for the phone number conventions in use, grouping the digits into country code, area code, prefix, etc. Any spaces or punctuation provided are not considered part of the text object's actual contents. For example, a text object with the PHONENUMBER constraint might display as follows:


 (408) 555-1212

but the actual contents of the object visible to the application through the APIs would be the string "4085551212". The size method reflects the number of characters in the actual contents, not the number of characters that are displayed, so for this example the size method would return 10.

Some constraints, such as DECIMAL, require the implementation to perform syntactic validation of the contents of the text object. The syntax checking is performed on the actual contents of the text object, which may differ from the displayed contents as described above. Syntax checking is performed on the initial contents passed to the constructors, and it is also enforced for all method calls that affect the contents of the text object. The methods and constructors throw IllegalArgumentException if they would result in the contents of the text object not conforming to the required syntax.

The value passed to the setConstraints() method consists of a restrictive constraint setting described above, as well as a variety of flag bits that modify the behavior of text entry and display. The value of the restrictive constraint setting is in the low order 16 bits of the value, and it may be extracted by combining the constraint value with the CONSTRAINT_MASK constant using the bit-wise AND (&) operator. The restrictive constraint settings are as follows:

ANY EMAILADDR NUMERIC PHONENUMBER URL DECIMAL

The modifier flags reside in the high order 16 bits of the constraint value, that is, those in the complement of the CONSTRAINT_MASK constant. The modifier flags may be tested individually by combining the constraint value with a modifier flag using the bit-wise AND (&) operator. The modifier flags are as follows:

PASSWORD UNEDITABLE SENSITIVE NON_PREDICTIVE INITIAL_CAPS_WORD INITIAL_CAPS_SENTENCE

Input Modes

The TextField shares the concept of input modes with the TextBox class. The application can request that the implementation use a particular input mode when the user initiates editing of a TextField or TextBox. The input mode is a concept that exists within the user interface for text entry on a particular device. The application does not request an input mode directly, since the user interface for text entry is not standardized across devices. Instead, the application can request that the entry of certain characters be made convenient. It can do this by passing the name of a Unicode character subset to the setInitialInputMode() method. Calling this method requests that the implementation set the mode of the text entry user interface so that it is convenient for the user to enter characters in this subset. The application can also request that the input mode have certain behavioral characteristics by setting modifier flags in the constraints value.

The requested input mode should be used whenever the user initiates the editing of a TextBox or TextField object. If the user had changed input modes in a previous editing session, the application's requested input mode should take precedence over the previous input mode set by the user. However, the input mode is not restrictive, and the user is allowed to change the input mode at any time during editing. If editing is already in progress, calls to the setInitialInputMode method do not affect the current input mode, but instead take effect at the next time the user initiates editing of this text object.

The initial input mode is a hint to the implementation. If the implementation cannot provide an input mode that satisfies the application's request, it should use a default input mode.

The input mode that results from the application's request is not a restriction on the set of characters the user is allowed to enter. The user MUST be allowed to switch input modes to enter any character that is allowed within the current constraint setting. The constraint setting takes precedence over an input mode request, and the implementation may refuse to supply a particular input mode if it is inconsistent with the current constraint setting.

For example, if the current constraint is ANY, the call


 setInitialInputMode("MIDP_UPPERCASE_LATIN");

should set the initial input mode to allow entry of uppercase Latin characters. This does not restrict input to these characters, and the user will be able to enter other characters by switching the input mode to allow entry of numerals or lowercase Latin letters. However, if the current constraint is NUMERIC, the implementation may ignore the request to set an initial input mode allowing MIDP_UPPERCASE_LATIN characters because these characters are not allowed in a TextField whose constraint is NUMERIC. In this case, the implementation may instead use an input mode that allows entry of numerals, since such an input mode is most appropriate for entry of data under the NUMERIC constraint.

A string is used to name the Unicode character subset passed as a parameter to the setInitialInputMode() method. String comparison is case sensitive.

Unicode character blocks can be named by adding the prefix "UCB_" to the the string names of fields representing Unicode character blocks as defined in the J2SE class java.lang.Character.UnicodeBlock. Any Unicode character block may be named in this fashion. For convenience, the most common Unicode character blocks are listed below.

UCB_BASIC_LATIN UCB_GREEK UCB_CYRILLIC UCB_ARMENIAN UCB_HEBREW UCB_ARABIC UCB_DEVANAGARI UCB_BENGALI UCB_THAI UCB_HIRAGANA UCB_KATAKANA UCB_HANGUL_SYLLABLES

"Input subsets" as defined by the J2SE class java.awt.im.InputSubset may be named by adding the prefix "IS_" to the string names of fields representing input subsets as defined in that class. Any defined input subset may be used. For convenience, the names of the currently defined input subsets are listed below.

IS_FULLWIDTH_DIGITS IS_FULLWIDTH_LATIN IS_HALFWIDTH_KATAKANA IS_HANJA IS_KANJI IS_LATIN IS_LATIN_DIGITS IS_SIMPLIFIED_HANZI IS_TRADITIONAL_HANZI

MIDP has also defined the following character subsets:

MIDP_UPPERCASE_LATIN - the subset of IS_LATIN that corresponds to uppercase Latin letters

MIDP_LOWERCASE_LATIN - the subset of IS_LATIN that corresponds to lowercase Latin letters

Finally, implementation-specific character subsets may be named with strings that have a prefix of "X_". In order to avoid namespace conflicts, it is recommended that implementation-specific names include the name of the defining company or organization after the initial "X_" prefix.

For example, a Japanese language application might have a particular TextField that the application intends to be used primarily for input of words that are "loaned" from languages other than Japanese. The application might request an input mode facilitating Hiragana input by issuing the following method call:


 textfield.setInitialInputMode("UCB_HIRAGANA");

Implementation Note

Implementations need not compile in all the strings listed above. Instead, they need only to compile in the strings that name Unicode character subsets that they support. If the subset name passed by the application does not match a known subset name, the request should simply be ignored without error, and a default input mode should be used. This lets implementations support this feature reasonably inexpensively. However, it has the consequence that the application cannot tell whether its request has been accepted, nor whether the Unicode character subset it has requested is actually a valid subset.

Since:: MIDP 1.0
Author:: Robert Virkus, robert@enough.de, Andrew Barnes, andy@geni.com.au basic implementation of direct input

Field Summary
`static int`	`ANY` The user is allowed to enter any text.
`protected char`	`caretChar`
`static java.lang.String[]`	`CHARACTERS` map of characters that can be triggered witht the 0..9 and #, * keys
`protected static java.lang.String`	`charactersKey0`
`protected static java.lang.String`	`charactersKeyPound`
`protected static java.lang.String`	`charactersKeyStar`
`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 java.lang.String[]`	`definedSymbols`
`static javax.microedition.lcdui.Command`	`DELETE_CMD`
`static int`	`EMAILADDR` The user is allowed to enter an e-mail address.
`protected char`	`emailSeparatorChar`
`static javax.microedition.lcdui.Command`	`ENTER_SYMBOL_CMD`
`protected boolean`	`flashCaret`
`protected StringItem`	`infoItem`
`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 int`	`inputMode`
`protected boolean`	`isUneditable`
`static int`	`KEY_CHANGE_MODE`
`static int`	`KEY_DELETE`
`protected java.lang.Object`	`lock`
`static int`	`MODE_FIRST_UPPERCASE` input mode for entering one uppercase followed by lowercase characters
`static int`	`MODE_LOWERCASE` input mode for lowercase characters
`static int`	`MODE_NATIVE` input mode for input using a separete native TextBox
`static int`	`MODE_NUMBERS` input mode for numeric characters
`static int`	`MODE_UPPERCASE` input mode for uppercase characters
`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`
`static int`	`SWITCH_DELAY`
`protected static List`	`symbolsList`
`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.StringItem
`animateTextWrap, bitMapFont, bitMapFontViewer, clipText, font, text, textColor, textEffect, textHorizontalAdjustment, textLines, textVerticalAdjustment, textWrapDirection, textWrapSpeed, useSingleLine, xOffset`

Fields inherited from class de.enough.polish.ui.Item
_bbField, _bbFieldAdded, appearanceMode, background, backgroundHeight, backgroundWidth, backgroundYOffset, border, borderWidth, BUTTON, colSpan, commands, completeBackground, completeBackgroundPadding, completeBorder, 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, opacity, opacityPaintNormally, opacityRgbData, paddingBottom, paddingHorizontal, paddingLeft, paddingRight, paddingTop, paddingVertical, parent, PLAIN, preferredHeight, preferredWidth, preserveViewType, relativeX, relativeY, rowSpan, screen, style, TRANSPARENT, useSingleRow, VERTICAL, view

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

_bbField, _bbFieldAdded, appearanceMode, background, backgroundHeight, backgroundWidth, backgroundYOffset, border, borderWidth, BUTTON, colSpan, commands, completeBackground, completeBackgroundPadding, completeBorder, 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, opacity, opacityPaintNormally, opacityRgbData, paddingBottom, paddingHorizontal, paddingLeft, paddingRight, paddingTop, paddingVertical, parent, PLAIN, preferredHeight, preferredWidth, preserveViewType, relativeX, relativeY, rowSpan, screen, style, TRANSPARENT, useSingleRow, VERTICAL, view

Constructor Summary
`TextField(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.
`TextField(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
`void`	`activate(boolean editable)` Sets a blackberry field to selectable.
`boolean`	`animate()` Animates this item.
`void`	`animate(long currentTime, ClippingRegion repaintRegion)` 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 void`	`commitCurrentCharacter()`
`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)` Notifies the TextField about changes in its native BlackBerry component.
`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`.
`static java.lang.String[]`	`getDefinedSymbols()` Returns the defined symbols as a String array
`java.lang.String`	`getDotSeparatedDecimalString()` Retrieves the decimal value entered with a dot as the decimal mark.
`StringItem`	`getInfoItem()`
`int`	`getInputMode()` Returns the current input mode.
`ItemCommandListener`	`getItemCommandListener()` Gets the listener for `Commands` to this `Item`.
`int`	`getMaxSize()` Returns the maximum size (number of characters) that can be stored in this `TextField`.
`PredictiveAccess`	`getPredictiveAccess()`
`java.lang.String`	`getString()` Gets the contents of the `TextField` as a string value.
`protected boolean`	`handleKeyClear(int keyCode, int gameAction)`
`protected boolean`	`handleKeyInsert(int keyCode, int gameAction)` Tries to interpret a key pressed event for inserting a character into this TextField.
`protected boolean`	`handleKeyMode(int keyCode, int gameAction)`
`protected boolean`	`handleKeyNavigation(int keyCode, int gameAction)`
`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 boolean`	`handlePointerReleased(int x, int y)` Handles the event when a pointer has been pressed at the specified position.
`protected void`	`hideNotify()` Called by the system to notify the item that it is now completely invisible, when it previously had been at least partially visible.
`protected void`	`initContent(int firstLineWidth, int lineWidth)` Initialises this item.
`static void`	`initSymbolsList()`
`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(char insertChar, boolean append, boolean commit)`
`boolean`	`isSuppressCommands()` Checks if commands are currently suppressed by this TextField.
`protected boolean`	`isValidInput(char insertChar, int position, java.lang.String myText)`
`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`	`setEditable(boolean editable)`
`void`	`setHelpStyle(Style style)`
`void`	`setHelpText(java.lang.String text)`
`void`	`setInfoItem(StringItem infoItem)`
`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`	`setPredictiveAccess(PredictiveAccess predictive)`
`void`	`setShowInputInfo(boolean show)` (De)activates the input info element for 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.
`void`	`setSuppressCommands(boolean suppressCommands)` Toggles the surpressing of commands for this TextField This has no effect when commands are globally suppressed by settting the preprocessing variable "polish.TextField.suppressCommands" to "true".
`protected void`	`showNotify()` Called by the system to notify the item that it is now at least partially visible, when it previously had been completely invisible.
`int`	`size()` Gets the number of characters that are currently stored in this `TextField`.
`protected void`	`updateDeleteCommand(java.lang.String newText)`
`void`	`updateInfo()` Updates the information text

Methods inherited from class de.enough.polish.ui.StringItem
`getFont, getFontHeight, getText, releaseResources, setFont, setText, setText, setTextColor, stringWidth, toString`

Methods inherited from class de.enough.polish.ui.Item
addCommand, addCommand, addCommands, addRelativeToBackgroundRegion, addRelativeToBackgroundRegion, addRelativeToContentRegion, containsCommand, getAbsoluteX, getAbsoluteY, getAppearanceMode, getAttribute, getAttributes, getBackgroundHeight, getBackgroundWidth, getBackgroundX, getBackgroundY, getContentHeight, getContentWidth, getContentX, getContentY, getDefaultCommand, getFocusedStyle, getItemAt, getItemCommands, getItemHeight, getItemStateListener, getItemWidth, getLabel, getLabelItem, getLayout, getMinimumHeight, getMinimumWidth, getParent, getPreferredHeight, getPreferredWidth, getScreen, getStyle, handleCommand, init, initStyle, isInContentArea, isInItemArea, isInItemArea, isInitialized, isVisible, notifyItemPressedEnd, notifyItemPressedStart, notifyStateChanged, paint, paintBackground, paintBackgroundAndBorder, paintBorder, removeCommand, repaint, repaint, repaintFully, requestInit, setAppearanceMode, setAttribute, setDefaultCommand, setItemCommandListener, setItemStateListener, setLabel, setLayout, setParent, setParent, setPreferredSize, setVisible, show, showCommands

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

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

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

CLEAR_CMD

public static javax.microedition.lcdui.Command CLEAR_CMD

DELETE_CMD

public static javax.microedition.lcdui.Command DELETE_CMD

caretChar

protected char caretChar

showCaret

protected boolean showCaret

title

protected java.lang.String title

inputMode

protected int inputMode

symbolsList

protected static List symbolsList

definedSymbols

protected static java.lang.String[] definedSymbols

ENTER_SYMBOL_CMD

public static javax.microedition.lcdui.Command ENTER_SYMBOL_CMD

MODE_LOWERCASE

public static final int MODE_LOWERCASE

input mode for lowercase characters

See Also:: Constant Field Values

MODE_FIRST_UPPERCASE

public static final int MODE_FIRST_UPPERCASE

input mode for entering one uppercase followed by lowercase characters

See Also:: Constant Field Values

MODE_UPPERCASE

public static final int MODE_UPPERCASE

input mode for uppercase characters

See Also:: Constant Field Values

MODE_NUMBERS

public static final int MODE_NUMBERS

input mode for numeric characters

See Also:: Constant Field Values

MODE_NATIVE

public static final int MODE_NATIVE

input mode for input using a separete native TextBox

See Also:: Constant Field Values

KEY_CHANGE_MODE

public static final int KEY_CHANGE_MODE

See Also:: Constant Field Values

KEY_DELETE

public static final int KEY_DELETE

See Also:: Constant Field Values

charactersKey0

protected static final java.lang.String charactersKey0

See Also:: Constant Field Values

charactersKeyStar

protected static final java.lang.String charactersKeyStar

See Also:: Constant Field Values

charactersKeyPound

protected static final java.lang.String charactersKeyPound

CHARACTERS

public static final java.lang.String[] CHARACTERS

map of characters that can be triggered witht the 0..9 and #, * keys

infoItem

protected StringItem infoItem

lock

protected final java.lang.Object lock

emailSeparatorChar

protected char emailSeparatorChar

SWITCH_DELAY

public static final int SWITCH_DELAY

See Also:: Constant Field Values

flashCaret

protected boolean flashCaret

isUneditable

protected boolean isUneditable

Constructor Detail

TextField

public TextField(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

TextField

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

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()

updateDeleteCommand

protected void updateDeleteCommand(java.lang.String newText)

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

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()

activate

public void activate(boolean editable)

Sets a blackberry field to selectable. Used to prevent fields to be selectable if they should not be shown.

Parameters:: editable - true, if the textfield should be selectable, otherwise false

setEditable

public void setEditable(boolean editable)

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: Item

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 StringItem

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: Item

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 StringItem

Parameters:: firstLineWidth - the maximum width of the first line; lineWidth - the maximum width of any following lines
See Also:: Item.contentWidth, Item.contentHeight, Item.preferredWidth, Item.preferredHeight

createCssSelector

protected java.lang.String createCssSelector()

Description copied from class: Item

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 StringItem

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: Item

Sets the style of this item.

Overrides:: setStyle in class StringItem

Parameters:: style - the new style for this item.

isValidInput

protected boolean isValidInput(char insertChar,
                               int position,
                               java.lang.String myText)

commitCurrentCharacter

protected void commitCurrentCharacter()

insertCharacter

protected void insertCharacter(char insertChar,
                               boolean append,
                               boolean commit)

updateInfo

public void updateInfo()

Updates the information text

animate

public void animate(long currentTime,
                    ClippingRegion repaintRegion)

Description copied from class: Item

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 StringItem

Parameters:: currentTime - the current time in milliseconds; repaintRegion - the repaint area that needs to be updated when this item is animated
See Also:: Item.addRelativeToContentRegion(ClippingRegion, int, int, int, int)

animate

public boolean animate()

Description copied from class: Item

Animates this item. Subclasses can override this method to create animations. The default implementation returns false

Overrides:: animate in class Item

Returns:: true when this item has been animated.
See Also:: Item.animate(long, ClippingRegion)

handleKeyPressed

protected boolean handleKeyPressed(int keyCode,
                                   int gameAction)

Description copied from class: Item

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 Item

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

handleKeyInsert

protected boolean handleKeyInsert(int keyCode,
                                  int gameAction)

Tries to interpret a key pressed event for inserting a character into this TextField.

Parameters:: keyCode - the key code of the event; gameAction - the associated game action
Returns:: true when the key could be interpreted as a character

handleKeyClear

protected boolean handleKeyClear(int keyCode,
                                 int gameAction)

handleKeyMode

protected boolean handleKeyMode(int keyCode,
                                int gameAction)

de.enough.polish.ui Class TextField

Input Constraints

Input Modes

Implementation Note

ANY

EMAILADDR

NUMERIC

PHONENUMBER

URL

DECIMAL

PASSWORD

UNEDITABLE

SENSITIVE

NON_PREDICTIVE

INITIAL_CAPS_WORD

INITIAL_CAPS_SENTENCE

CONSTRAINT_MASK

CLEAR_CMD

DELETE_CMD

caretChar

showCaret

title

inputMode

symbolsList

definedSymbols

ENTER_SYMBOL_CMD

MODE_LOWERCASE

MODE_FIRST_UPPERCASE

MODE_UPPERCASE

MODE_NUMBERS

MODE_NATIVE

KEY_CHANGE_MODE

KEY_DELETE

charactersKey0

charactersKeyStar

charactersKeyPound

CHARACTERS

infoItem

lock

emailSeparatorChar

SWITCH_DELAY

flashCaret

isUneditable

TextField

TextField

getString

getDotSeparatedDecimalString

setString

updateDeleteCommand

getChars

setChars

insert

insert

delete

getMaxSize

setMaxSize

size

getCaretPosition

setCaretPosition

setConstraints

activate

setEditable

getConstraints

setInitialInputMode

paintContent

initContent

createCssSelector

setStyle

isValidInput

commitCurrentCharacter

insertCharacter

updateInfo

animate

animate

handleKeyPressed

handleKeyInsert

handleKeyClear

handleKeyMode

de.enough.polish.ui
Class TextField