com.sun.lwuit
Class TextField

java.lang.Object
  com.sun.lwuit.Component
      com.sun.lwuit.TextArea
          com.sun.lwuit.TextField

All Implemented Interfaces:

Animated, StyleListener

public class TextField

extends TextArea

Allows in place editing using a lightweight API without necessarily moving to the external native text box. The main drawback in this approach is that editing can't support features such as T9 and might not have the same key mapping or behavior of the native text input.

Notice that due to limitations of text area and text field input modes in text area aren't properly supported since they won't work properly across devices. To limit input modes please use the setInputModeOrder method. All constants declared in TextArea are ignored with the exception of PASSWORD.

Field Summary

Fields inherited from class com.sun.lwuit.TextArea

ANY, DECIMAL, EMAILADDR, INITIAL_CAPS_SENTENCE, INITIAL_CAPS_WORD, NON_PREDICTIVE, NUMERIC, PASSWORD, PHONENUMBER, SENSITIVE, UNEDITABLE, URL

Fields inherited from class com.sun.lwuit.Component

BOTTOM, BRB_CENTER_OFFSET, BRB_CONSTANT_ASCENT, BRB_CONSTANT_DESCENT, BRB_OTHER, CENTER, LEFT, RIGHT, TOP

Fields inherited from interface com.sun.dtv.ui.Animated

ALTERNATING, LOOP, REPEATING

Constructor Summary

TextField()
Default constructor.

TextField(int columns)
Construct a text field with space reserved for columns.

TextField(String text)
Construct text field.

TextField(String text, int columns)
Construct text field.

Method Summary

void	addDataChangeListener(DataChangedListener d) Adds a listener for data change events it will be invoked for every change made to the text field.
static void	addInputMode(String name, Hashtable values, boolean firstUpcase) Adds a new input mode hashtable with the given name and set of values.
boolean	animate() Allows the animation to reduce "repaint" calls when it returns false.
protected Dimension	calcPreferredSize() Calculates the preferred size based on component content.
protected void	commitChange() Commit the changes made to the text field as a complete edit operation.
protected void	deleteChar() Performs a backspace operation.
protected char	getCharPerKeyCode(int pressCount, int keyCode, boolean longClick) Returns the character matching the given key code after the given amount of user presses.
int	getCommitTimeout() The amount of time in milliseconds it will take for a change to get committed into the field.
int	getCursorBlinkTimeOff() The amount of time in milliseconds in which the cursor is invisible.
int	getCursorBlinkTimeOn() The amount of time in milliseconds in which the cursor is visible.
int	getCursorPosition() Returns the position of the cursor.
static String[]	getDefaultInputModeOrder() Returns the order in which input modes are toggled by default.
String	getInputMode() Returns the currently selected input mode.
String[]	getInputModeOrder() Returns the order in which input modes are toggled.
protected int	getLongClickDuration() The amount of time considered as a "long click" causing the long click method to be invoked.
protected String	getLongClickInputMode() Returns the input mode for the ong click mode.
static char[]	getSymbolTable() Returns the symbol table for the device.
protected String	getUIID()
protected void	initComponent() Allows subclasses to bind functionality that relies on fully initialized and "ready for action" component state.
protected Command	installCommands(Command clear, Command t9) Installs the clear and t9 commands onto the parent form, this method can be overriden to provide device specific placement for these commands.
protected boolean	isChangeInputMode(int keyCode) Indicates whether the key changes the current input mode.
protected boolean	isClearKey(int keyCode) Returns true if this is the clear key on the device, many devices don't contain a clear key and even in those that contain it this might be an issue.
protected boolean	isCursorPositionCycle() Returns true if the cursor should cycle to the beginning of the text when the user navigates beyond the edge of the text and visa versa.
protected boolean	isEditingEndTrigger(int keyCode) Indicates whether the given key code should be ignored or should trigger cause editing to end.
protected boolean	isEditingTrigger(int keyCode) Indicates whether the given key code should be ignored or should trigger editing, by default fire or any numeric key should trigger editing implicitly.
boolean	isPendingCommit() Returns true if the text field is waiting for a commit on editing.
static boolean	isQwertyAutoDetect() Indicates whether the text field should try to auto detect qwerty and switch the qwerty device flag implicitly.
static boolean	isQwertyDevice() The default value for the qwerty flag so it doesn't need setting for every text field individually.
boolean	isQwertyInput() True is this is a qwerty device or a device that is currently in qwerty mode.
boolean	isReplaceMenu() Indicates whether the menu of the form should be replaced with the T9/Clear commands for the duration of interactivity with the text field.
static boolean	isReplaceMenuDefault() Indicates whether the menu of the form should be replaced with the T9/Clear commands for the duration of interactivity with the text field.
protected boolean	isSymbolDialogKey(int keyCode) Returns true if this keycode is the one mapping to the symbol dialog popup.
boolean	isUseSoftkeys() When set to true softkeys are used to enable delete functionality.
void	keyPressed(int keyCode) If this Component is focused, the key pressed event will call this method.
void	keyReleased(int keyCode) If this Component is focused, the key released event will call this method.
void	paint(Graphics g) This method paints the Component on the screen, it should be overriden by subclasses to perform custom drawing or invoke the UI API's to let the PLAF perform the rendering.
void	pointerReleased(int x, int y) If this Component is focused, the pointer released event will call this method.
protected void	removeCommands(Command clear, Command t9, Command originalClear) Removes the clear and t9 commands from the parent form, this method can be overriden to provide device specific placement for these commands.
void	removeDataChangeListener(DataChangedListener d) Removes the listener for data change events.
static void	setClearText(String text) Set the text that should appear on the clear soft key.
void	setCommitTimeout(int commitTimeout) The amount of time in milliseconds it will take for a change to get committed into the field.
void	setCursorBlinkTimeOff(int time) The amount of time in milliseconds in which the cursor is invisible.
void	setCursorBlinkTimeOn(int time) The amount of time in milliseconds in which the cursor is visible.
void	setCursorPosition(int pos) Set the position of the cursor.
static void	setDefaultInputModeOrder(String[] order) Sets the order in which input modes are toggled by default and allows disabling/hiding an input mode.
void	setEditable(boolean b) Sets this text area to be editable or readonly.
void	setInputMode(String mode) Sets the current selected input mode matching one of the existing input modes.
void	setInputModeOrder(String[] order) Sets the order in which input modes are toggled and allows disabling/hiding an input mode.
static void	setQwertyAutoDetect(boolean v) Indicates whether the text field should try to auto detect qwerty and switch the qwerty device flag implicitly.
static void	setQwertyDevice(boolean v) The default value for the qwerty flag so it doesn't need setting for every text field individually.
void	setQwertyInput(boolean qwerty) Set this device to operate in or no longer operate in qwerty mode.
void	setReplaceMenu(boolean replaceMenu) Indicates whether the menu of the form should be replaced with the T9/Clear commands for the duration of interactivity with the text field.
static void	setReplaceMenuDefault(boolean replaceMenu) Indicates whether the menu of the form should be replaced with the T9/Clear commands for the duration of interactivity with the text field.
static void	setSymbolTable(char[] table) Sets the symbol table to show when the user clicks the symbol table key.
static void	setT9Text(String text) Set the text that should appear on the T9 soft key.
void	setText(String text) Sets the text within this text area.
void	setUseSoftkeys(boolean useSoftkeys) When set to true softkeys are used to enable delete functionality.

Methods inherited from class com.sun.lwuit.TextArea

addActionListener, fireClicked, getColumns, getConstraint, getLines, getMaxSize, getRows, getRowsGap, getText, getTextAt, getUnsupportedChars, isAutoDegradeMaxSize, isEditable, isGrowByContent, isScrollableY, isSelectableInteraction, paintScrollbarY, removeActionListener, setAutoDegradeMaxSize, setColumns, setConstraint, setDefaultMaxSize, setGrowByContent, setMaxSize, setRows, setRowsGap, setUnsupportedChars

Methods inherited from class com.sun.lwuit.Component

addFocusListener, contains, deinitialize, getAbsoluteX, getAbsoluteY, getAnimationMode, getBaseline, getBaselineResizeBehavior, getBorder, getBottomGap, getBounds, getClientProperty, getComponentForm, getDelay, getHeight, getNextFocusDown, getNextFocusLeft, getNextFocusRight, getNextFocusUp, getParent, getPosition, getPreferredSize, getRepetitionMode, getScrollAnimationSpeed, getScrollX, getScrollY, getSideGap, getStyle, getWidth, getX, getY, handlesInput, hasFocus, isEnabled, isFocusable, isFocusPainted, isInitialized, isRunning, isScrollable, isScrollableX, isScrollVisible, isSmoothScrolling, isVisible, jumpTo, keyRepeated, longKeyPress, paintBackground, paintBackgrounds, paintBorder, paintComponent, paintComponent, paintScrollbars, paintScrollbarX, paramString, pointerDragged, pointerPressed, putClientProperty, refreshTheme, refreshTheme, removeFocusListener, repaint, repaint, requestFocus, scrollRectToVisible, setAnimationMode, setCellRenderer, setDelay, setEnabled, setFocus, setFocusable, setFocusPainted, setHandlesInput, setHeight, setInitialized, setIsScrollVisible, setNextFocusDown, setNextFocusLeft, setNextFocusRight, setNextFocusUp, setPreferredSize, setRepetitionMode, setScrollAnimationSpeed, setScrollX, setScrollY, setShouldCalcPreferredSize, setSize, setSmoothScrolling, setStyle, setVisible, setWidth, setX, setY, start, stop, styleChanged, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

TextField

public TextField()

Default constructor.

TextField

public TextField(int columns)

Construct a text field with space reserved for columns.

Parameters:

columns - number of columns

TextField

public TextField(String text)

Construct text field.

Parameters:

text - content of textfield

TextField

public TextField(String text,
                 int columns)

Construct text field.

Parameters:

text - content of text field

columns - number of columns

Method Detail

setClearText

public static void setClearText(String text)

Set the text that should appear on the clear soft key.

Parameters:

text - the text for clear soft key

setT9Text

public static void setT9Text(String text)

Set the text that should appear on the T9 soft key.

Parameters:

text - the text for T9 soft key

deleteChar

protected void deleteChar()

Performs a backspace operation.

getUIID

protected String getUIID()

Overrides:

getUIID in class TextArea

commitChange

protected void commitChange()

Commit the changes made to the text field as a complete edit operation. This is used in a numeric keypad to allow the user to repeatedly press a number to change values.

isPendingCommit

public boolean isPendingCommit()

Returns true if the text field is waiting for a commit on editing.

Returns:

true if there is a pending commit, false otherwise

setCommitTimeout

public void setCommitTimeout(int commitTimeout)

The amount of time in milliseconds it will take for a change to get committed into the field.

Parameters:

commitTimeout - indicates the amount of time that should elapse for a commit to automatically occur

See Also:

getCommitTimeout()

getCommitTimeout

public int getCommitTimeout()

The amount of time in milliseconds it will take for a change to get committed into the field.

Returns:

the amount of time that should elapse for a commit to automatically occur

See Also:

setCommitTimeout(int)

setInputMode

public void setInputMode(String mode)

Sets the current selected input mode matching one of the existing input modes.

Parameters:

mode - the display name of the input mode by default the following modes are supported: Abc, ABC, abc, 123

See Also:

getInputMode()

getInputMode

public String getInputMode()

Returns the currently selected input mode.

Returns:

the display name of the input mode by default the following modes are supported: Abc, ABC, abc, 123

See Also:

setInputMode(java.lang.String)

isChangeInputMode

protected boolean isChangeInputMode(int keyCode)

Indicates whether the key changes the current input mode.

Parameters:

keyCode - the key code to check against

Returns:

true for the hash (#) key code

addInputMode

public static void addInputMode(String name,
                                Hashtable values,
                                boolean firstUpcase)

Adds a new input mode hashtable with the given name and set of values.

Parameters:

name - a unique display name for the input mode e.g. ABC, 123 etc...

values - The key for the hashtable is an Integer keyCode and the value is a String containing the characters to toggle between for the given keycode

firstUpcase - indicates if this input mode in an input mode used for the special case where the first letter is an upper case letter

getInputModeOrder

public String[] getInputModeOrder()

Returns the order in which input modes are toggled.

Returns:

the order in which input modes are toggled

See Also:

setInputModeOrder(java.lang.String[])

setInputModeOrder

public void setInputModeOrder(String[] order)

Sets the order in which input modes are toggled and allows disabling/hiding an input mode.

Parameters:

order - the order for the input modes in this field

See Also:

getInputModeOrder()

getDefaultInputModeOrder

public static String[] getDefaultInputModeOrder()

Returns the order in which input modes are toggled by default.

Returns:

the default order for the input modes in this field

See Also:

setDefaultInputModeOrder(java.lang.String[])

setDefaultInputModeOrder

public static void setDefaultInputModeOrder(String[] order)

Sets the order in which input modes are toggled by default and allows disabling/hiding an input mode.

Parameters:

order - the order for the input modes in all future created fields

See Also:

getDefaultInputModeOrder()

getLongClickInputMode

protected String getLongClickInputMode()

Returns the input mode for the ong click mode.

Returns:

returns 123 by default

getCharPerKeyCode

protected char getCharPerKeyCode(int pressCount,
                                 int keyCode,
                                 boolean longClick)

Returns the character matching the given key code after the given amount of user presses.

Parameters:

pressCount - number of times this keycode was pressed

keyCode - the actual keycode input by the user

longClick - does this click constitute a long click

Returns:

the char mapping to this key or 0 if no appropriate char was found (navigation, input mode change etc...).

setCursorPosition

public void setCursorPosition(int pos)

Set the position of the cursor.

Parameters:

pos - the position of the cursor

See Also:

getCursorPosition()

getCursorPosition

public int getCursorPosition()

Returns the position of the cursor.

Returns:

the position of the cursor

See Also:

setCursorPosition(int)

setText

public void setText(String text)

Description copied from class: TextArea

Sets the text within this text area.

Overrides:

setText in class TextArea

Parameters:

text - new value for the text area

See Also:

TextArea.getText()

isClearKey

protected boolean isClearKey(int keyCode)

Returns true if this is the clear key on the device, many devices don't contain a clear key and even in those that contain it this might be an issue.

Parameters:

keyCode - the key code that might be the clear key

Returns:

true if this is the clear key.

isQwertyInput

public boolean isQwertyInput()

True is this is a qwerty device or a device that is currently in qwerty mode.

Returns:

currently defaults to false

setQwertyInput

public void setQwertyInput(boolean qwerty)

Set this device to operate in or no longer operate in qwerty mode.

Parameters:

qwerty - indicate whether device should be set to qwerty mode or not

keyReleased

public void keyReleased(int keyCode)

Description copied from class: Component

If this Component is focused, the key released event will call this method.

Overrides:

keyReleased in class TextArea

getLongClickDuration

protected int getLongClickDuration()

The amount of time considered as a "long click" causing the long click method to be invoked.

Returns:

currently defaults to 800

getSymbolTable

public static char[] getSymbolTable()

Returns the symbol table for the device.

Returns:

symbol table of the device

See Also:

setSymbolTable(char[])

setSymbolTable

public static void setSymbolTable(char[] table)

Sets the symbol table to show when the user clicks the symbol table key.

Parameters:

table - the symbol table

See Also:

getSymbolTable()

isCursorPositionCycle

protected boolean isCursorPositionCycle()

Returns true if the cursor should cycle to the beginning of the text when the user navigates beyond the edge of the text and visa versa.

Returns:

true by default

isSymbolDialogKey

protected boolean isSymbolDialogKey(int keyCode)

Returns true if this keycode is the one mapping to the symbol dialog popup.

Parameters:

keyCode - the keycode to check

Returns:

true if this is the star symbol *

setEditable

public void setEditable(boolean b)

Description copied from class: TextArea

Sets this text area to be editable or readonly.

Overrides:

setEditable in class TextArea

Parameters:

b - true is text are is editable; otherwise false

keyPressed

public void keyPressed(int keyCode)

Description copied from class: Component

If this Component is focused, the key pressed event will call this method.

Overrides:

keyPressed in class TextArea

installCommands

protected Command installCommands(Command clear,
                                  Command t9)

Installs the clear and t9 commands onto the parent form, this method can be overriden to provide device specific placement for these commands.

Parameters:

clear - the clear command

t9 - the t9 command

Returns:

clear command already installed in the form if applicable, none if no clear command was installed before or not applicable.

removeCommands

protected void removeCommands(Command clear,
                              Command t9,
                              Command originalClear)

Removes the clear and t9 commands from the parent form, this method can be overriden to provide device specific placement for these commands.

Parameters:

clear - the clear command

t9 - the t9 command

originalClear - the command originally assigned as the clear command (or null if no command was assigned before)

isEditingTrigger

protected boolean isEditingTrigger(int keyCode)

Indicates whether the given key code should be ignored or should trigger editing, by default fire or any numeric key should trigger editing implicitly. This method is only called when handles input is false.

Parameters:

keyCode - the keycode passed to the keyPressed method

Returns:

true if this key code should cause a switch to editing mode.

isEditingEndTrigger

protected boolean isEditingEndTrigger(int keyCode)

Indicates whether the given key code should be ignored or should trigger cause editing to end. By default the fire key, up or down will trigger the end of editing.

Parameters:

keyCode - the keycode passed to the keyPressed method

Returns:

true if this key code should cause a switch to editing mode.

paint

public void paint(Graphics g)

Description copied from class: Component

This method paints the Component on the screen, it should be overriden by subclasses to perform custom drawing or invoke the UI API's to let the PLAF perform the rendering.

Specified by:

paint in interface Animated

Overrides:

paint in class TextArea

calcPreferredSize

protected Dimension calcPreferredSize()

Description copied from class: Component

Calculates the preferred size based on component content. This method is invoked lazily by getPreferred size.

Overrides:

calcPreferredSize in class TextArea

initComponent

protected void initComponent()

Description copied from class: Component

Allows subclasses to bind functionality that relies on fully initialized and "ready for action" component state.

Overrides:

initComponent in class Component

setCursorBlinkTimeOn

public void setCursorBlinkTimeOn(int time)

The amount of time in milliseconds in which the cursor is visible.

Parameters:

time - time in milliseconds in which the cursor is visible

See Also:

getCursorBlinkTimeOn()

setCursorBlinkTimeOff

public void setCursorBlinkTimeOff(int time)

The amount of time in milliseconds in which the cursor is invisible.

Parameters:

time - time in milliseconds in which the cursor is invisible

See Also:

getCursorBlinkTimeOff()

getCursorBlinkTimeOn

public int getCursorBlinkTimeOn()

The amount of time in milliseconds in which the cursor is visible.

Returns:

time in milliseconds in which the cursor is visible

See Also:

setCursorBlinkTimeOn(int)

getCursorBlinkTimeOff

public int getCursorBlinkTimeOff()

The amount of time in milliseconds in which the cursor is invisible.

Returns:

time in milliseconds in which the cursor is invisible

See Also:

setCursorBlinkTimeOff(int)

animate

public boolean animate()

Description copied from interface: Animated

Allows the animation to reduce "repaint" calls when it returns false. It is called once for every frame.

Specified by:

animate in interface Animated

Overrides:

animate in class Component

pointerReleased

public void pointerReleased(int x,
                            int y)

Description copied from class: Component

If this Component is focused, the pointer released event will call this method.

Overrides:

pointerReleased in class TextArea

isUseSoftkeys

public boolean isUseSoftkeys()

When set to true softkeys are used to enable delete functionality.

Returns:

true if softkeys are used to enable delete functionality

setUseSoftkeys

public void setUseSoftkeys(boolean useSoftkeys)

When set to true softkeys are used to enable delete functionality.

Parameters:

useSoftkeys - value indicating whether softkeys are used to enable delete functionality

addDataChangeListener

public void addDataChangeListener(DataChangedListener d)

Adds a listener for data change events it will be invoked for every change made to the text field.

Parameters:

d - the DataChangedListener

See Also:

removeDataChangeListener(com.sun.lwuit.events.DataChangedListener)

removeDataChangeListener

public void removeDataChangeListener(DataChangedListener d)

Removes the listener for data change events.

Parameters:

d - the DataChangedListener

See Also:

addDataChangeListener(com.sun.lwuit.events.DataChangedListener)

isReplaceMenu

public boolean isReplaceMenu()

Indicates whether the menu of the form should be replaced with the T9/Clear commands for the duration of interactivity with the text field.

Returns:

true if the menu of the form should be replaced with the T9/Clear commands for the duration of interactivity with the text field

setReplaceMenu

public void setReplaceMenu(boolean replaceMenu)

Indicates whether the menu of the form should be replaced with the T9/Clear commands for the duration of interactivity with the text field.

Parameters:

replaceMenu - true if the menu of the form should be replaced with the T9/Clear commands for the duration of interactivity with the text field

isReplaceMenuDefault

public static boolean isReplaceMenuDefault()

Indicates whether the menu of the form should be replaced with the T9/Clear commands for the duration of interactivity with the text field.

Returns:

default value for isReplaceMenu() return value

See Also:

isReplaceMenu(), setReplaceMenuDefault(boolean)

setReplaceMenuDefault

public static void setReplaceMenuDefault(boolean replaceMenu)

Indicates whether the menu of the form should be replaced with the T9/Clear commands for the duration of interactivity with the text field.

Parameters:

replaceMenu - default value for isReplaceMenu() return value

See Also:

isReplaceMenu(), isReplaceMenuDefault()

setQwertyAutoDetect

public static void setQwertyAutoDetect(boolean v)

Indicates whether the text field should try to auto detect qwerty and switch the qwerty device flag implicitly.

Parameters:

v - value indicating whether the text field should try to auto detect qwerty and switch the qwerty device flag implicitly

setQwertyDevice

public static void setQwertyDevice(boolean v)

The default value for the qwerty flag so it doesn't need setting for every text field individually.

Parameters:

v - default value for the qwerty flag so it doesn't need setting for every text field individually

isQwertyAutoDetect

public static boolean isQwertyAutoDetect()

Indicates whether the text field should try to auto detect qwerty and switch the qwerty device flag implicitly.

Returns:

value indicating whether the text field should try to auto detect qwerty and switch the qwerty device flag implicitly

isQwertyDevice

public static boolean isQwertyDevice()

The default value for the qwerty flag so it doesn't need setting for every text field individually.

Returns:

default value for the qwerty flag so it doesn't need setting for every text field individually.