public abstract class

TextEdit

extends View

java.lang.Object
↳	com.neomades.ui.View
	↳	com.neomades.ui.TextEdit

Known Direct Subclasses

TextArea, TextField

Known Indirect Subclasses

AutoCompleteTextField<T>

Summary

XML Attributes
Attribute Name	Related Method	Description
autoCorrect	setAutoCorrect(boolean)	Auto-correct mode
capitalizeMode	setCapitalizeMode(CapitalizeMode)	Capitalize mode
contentAlignment	setContentAlignment(int)	A combination of alignment values (eg: TOP\|LEFT)
cursorPosition	setCursorPosition(int)	The caret position
defaultText	setDefaultText(int)	Res.string.XXXX or a text
font	setFont(Font)	Font resource id: Res.font.FONT_XXXX
maxLength	setMaxLength(int)	Max number of characters
passwordMode	setPasswordMode(boolean)	If the field hides characters
readOnly	setReadOnly(boolean)	If the text inside is not editable
text	setText(int)	Res.string.XXXX or a text
textColor	setTextColor(Color)	#AARRGGBB or a color
textMode	setTextMode(TextMode)	The text mode
textSize	setTextSize(int)	a size in dp

[Expand]

Inherited XML Attributes

From class com.neomades.ui.View

[Expand]

Inherited Constants

From interface com.neomades.ui.Alignment

From interface com.neomades.ui.StretchMode

Public Constructors
	TextEdit()

Public Methods
void	clear() Removes the text of this field
String	getDefaultText() Gets the default text of this text field.
String	getText() Returns the text of this text field.
boolean	isReadOnly() Returns if the the field is readonly or can be edited
int	length() Returns the length of the text of this field
void	setAutoCorrect(boolean autocorrect) Sets if auto-correct should be enabled.
void	setCapitalizeMode(CapitalizeMode mode) Changes the capitalize mode.
void	setContentAlignment(int alignment) Sets the alignment of the text in this component.
void	setCursorPosition(int index) Moves the cursor position before the character at the given index.
void	setDefaultText(String defaultText) Sets the default text of this text field, it disappears when the first character is entered and reappears when all characters have been deleted.
void	setDefaultText(int resId) Sets the default text of this text field, it disappears when the first character is entered and reappears when all characters have been deleted.
void	setFont(Font font) Sets the font for this text field
void	setMaxLength(int maxLength) Sets the maximum number of authorized characters into this `TextField`.
void	setPasswordMode(boolean passwordMode) Sets the password mode.
void	setReadOnly(boolean readonly) Sets the state of this field to readonly or editable
void	setReturnKeyListener(ReturnKeyListener returnKeyListener) Associates a `ReturnKeyListener` to this `TextField`.
void	setReturnKeyType(int returnKeyType) Changes the content of the return key.
void	setText(String text) Sets the text of this text field
void	setText(int resId) Sets the text of the text field
void	setTextChangedListener(TextChangedListener listener) Sets a text change listener (called when the text has been changed by the user)
void	setTextColor(Color color) Sets the text color of this textfield's text
void	setTextMode(TextMode mode) Changes the text mode.
void	setTextSize(int sizeInDp) Sets the text size to a given value (in dp).

[Expand]

Inherited Methods

From class com.neomades.ui.View

View	findView(int viewId) Find view by Id.
int	getId() Returns the identifier of this element, by default all elements return "0".
Object	getTag() Returns this view's tag.
static View	inflateXML(int layoutResId) Inflate view from XMLLayout declared in the URS File.
static View	inflateXML(InputStream xmlStream) @return
boolean	isClickable() Returns if the view is clickable.
boolean	isEnabled() Return a boolean indicating if the view is enabled or not
boolean	isFocusable() Returns if the view is focusable (for the devices that have a keyboard Ui navigation).
boolean	isVisible() Returns if the view is visible
void	runOnUiThread(Runnable action) Calls `action.run()` asynchronously on the `UI-Thread`.
void	setBackground(Background background) Sets the background on this view.
void	setBackground(int backgroundResId) Sets the background on this view with a XML background definition.
void	setBackgroundColor(Color color) Sets the background color on this view.
void	setBackgroundImage(int imageID) Set the background image for this view.
void	setBackgroundImage(Image image) Set the background image for this view.
void	setBorderColor(Color borderColor) Sets the border color on this view.
void	setBorderWidth(int widthInDp) Set the border width (size) in DP units.
void	setClickListener(ClickListener clickListener) Sets a ClickListener to this view.
void	setClickable(boolean clickable) Sets this view clickable.
void	setCornerRadius(int radiusSize) Set the four corners radius, if the view has corners.
void	setDrawingCacheEnabled(boolean enabled) Enables or disables the drawing cache.
void	setEnabled(boolean enabled) Sets the state of this view to enabled or disabled.
void	setFocusable(boolean focusable) Sets the view focusable.
void	setGestureDetector(GestureDetector detector) Sets a `GestureDetector` on this view.
void	setHeight(int heightDp) Sets the height of the view, in dp units (density-independent pixels).
void	setId(int id) Sets a identifier/tag to this element
void	setInvalidateDisabled(boolean disabled) If set to true, force the layout that contains the view to not be draw again when its content changes.
void	setLayoutAlignment(int alignment) Sets the view alignment into its parent.
void	setMargin(int uniformMarginDp) Set the margin outside this view (used by `Layout`), by setting on each side the given value.
void	setMargin(int leftDp, int topDp, int rightDp, int bottomDp) Set the margin outside this view (used by `Layout`).
void	setMarginBottom(int marginBottomDp) Sets the bottom margin with the given value.
void	setMarginLeft(int marginLeftDp) Sets the left margin with the given value.
void	setMarginRight(int marginRightDp) Sets the right margin with the given value.
void	setMarginTop(int marginTopDp) Sets the top margin with the given value.
void	setPadding(int leftDp, int topDp, int rightDp, int bottomDp) Sets the view padding.
void	setPadding(int uniformPaddingDp) Sets the view padding, with for each side the value given in parameter.
void	setPaddingBottom(int paddingBottomDp) Sets the bottom padding with the given value.
void	setPaddingLeft(int paddingLeftDp) Sets the left padding with the given value.
void	setPaddingRight(int paddingRightDp) Sets the right padding with the given value.
void	setPaddingTop(int paddingTopDp) Sets the top padding with the given value.
void	setSize(int widthDp, int heightDp) Sets the size of the view, in dp units (density-independent pixels).
void	setStretchHorizontalMode(int widthMode) Sets the stretch horizontal mode.
void	setStretchMode(int horizontalMode, int verticalMode) Sets the view content stretch mode.
void	setStretchVerticalMode(int heightMode) Sets the stretch vertical mode.
void	setStyle(int styleResId)
void	setStyle(Style style)
void	setTag(Object tag) Sets the tag associated with this view.
void	setTouchListener(TouchListener touchListener) Register a listener to be invoked when a touch event is dispatched to this view.
void	setTransformOrigin(float xOrigin, float yOrigin) Sets the x and y location of the point around which the view will be scaled or rotated when an animation occurs.
void	setVisible(boolean visible) Sets the view's visibility : visible or invisible/hidden
void	setWidth(int widthDp) Sets the width of the view, in dp units (density-independent pixels).

From class java.lang.Object

boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
final Class<?>	getClass() Returns the runtime class of an object.
int	hashCode() Returns a hash code value for the object.
final void	notify() Wakes up a single thread that is waiting on this object's monitor.
final void	notifyAll() Wakes up all threads that are waiting on this object's monitor.
String	toString() Returns a string representation of the object.
final void	wait(long timeout, int nanos) Causes current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
final void	wait(long timeout) Causes current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.
final void	wait() Causes current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.

XML Attributes

autoCorrect

Auto-correct mode

Related Methods

setAutoCorrect(boolean)

capitalizeMode

Capitalize mode

Related Methods

setCapitalizeMode(CapitalizeMode)

contentAlignment

A combination of alignment values (eg: TOP|LEFT)

Related Methods

setContentAlignment(int)

cursorPosition

The caret position

Related Methods

setCursorPosition(int)

defaultText

Res.string.XXXX or a text

Related Methods

setDefaultText(int)

font

Font resource id: Res.font.FONT_XXXX

Related Methods

setFont(Font)

maxLength

Max number of characters

Related Methods

setMaxLength(int)

passwordMode

If the field hides characters

Related Methods

setPasswordMode(boolean)

readOnly

If the text inside is not editable

Related Methods

setReadOnly(boolean)

text

Res.string.XXXX or a text

Related Methods

setText(int)

textColor

#AARRGGBB or a color

Related Methods

setTextColor(Color)

textMode

The text mode

Related Methods

setTextMode(TextMode)

Public Constructors

public TextEdit ()

Public Methods

public void clear ()

Removes the text of this field

Throws

CrossThreadException	if the method is called from outside the UI-Thread

public String getDefaultText ()

Gets the default text of this text field. Returns an empty string ("") if there is no text.

Related XML Attributes

defaultText

Returns

the default text. Returns an empty string ("") if there is no text.

public String getText ()

Returns the text of this text field. Returns an empty string ("") if there is no text.

Returns

the current text. Returns an empty string ("") if there is no text.

public boolean isReadOnly ()

Returns if the the field is readonly or can be edited

Returns

true if the field is readonly, else false

public int length ()

Returns the length of the text of this field

Returns

the length of the current text

public void setAutoCorrect (boolean autocorrect)

Sets if auto-correct should be enabled. If enabled, text may be corrected automatically while the user is typing.
By default, the auto-correct option is activated.
With auto-correct mode often comes a suggestions list, that is displayed above the keyboard.
When the keyboard is opened, changing the auto-correct mode may not take effect immediately, but only after the keyboard is re-opened.

Cross Platform Considerations

Has effect only on Android and iOS. On some platforms, like Android, this option exists as a global setting at system level, and can be toggled by the user. In this case, this setter may have no effect.

Related XML Attributes

autoCorrect

Parameters

autocorrect	true to activate auto-correct, else false

public void setCapitalizeMode (CapitalizeMode mode)

Changes the capitalize mode. See CapitalizeMode for a list of possible values.
The capitalize mode does not enforce users to use the specified case, it is just a hint. The user can still change the mode explicitly on the keyboard.

Related XML Attributes

capitalizeMode

Parameters

mode	the capitalize mode to apply to this text edit

Throws

NullPointerException	if the parameter is null

public void setContentAlignment (int alignment)

Sets the alignment of the text in this component. The alignment will be used only if the text is smaller than the TextField size. (default : VCENTER|LEFT)

In MATCH_CONTENT mode, the TextField size is the same than the text size, then this alignment property will be inefficient.

The parameter is a combination of values from Alignment.

Related XML Attributes

contentAlignment

Parameters

alignment	The new alignment of the text

Throws

CrossThreadException	if the method is called from outside the UI-Thread

public void setCursorPosition (int index)

Moves the cursor position before the character at the given index. The field must have the focus: if the cursor is not already displayed, this method will have no effect.

Related XML Attributes

cursorPosition

Parameters

index	the new index

Throws

CrossThreadException	if the method is called from outside the UI-Thread
IndexOutOfBoundsException	if index is negative or larger than the text length

public void setDefaultText (String defaultText)

Sets the default text of this text field, it disappears when the first character is entered and reappears when all characters have been deleted.

Related XML Attributes

defaultText

Parameters

defaultText	the new default text

Throws

CrossThreadException	if the method is called from outside the UI-Thread

public void setDefaultText (int resId)

Sets the default text of this text field, it disappears when the first character is entered and reappears when all characters have been deleted.

Related XML Attributes

defaultText

Parameters

resId	the string id representing the default text of this field

Throws

CrossThreadException	if the method is called from outside the UI-Thread

public void setFont (Font font)

Sets the font for this text field

Related XML Attributes

font

Parameters

font	the new font to set

Throws

CrossThreadException	if the method is called from outside the UI-Thread
NullPointerException	if the font parameter is null

public void setMaxLength (int maxLength)

Sets the maximum number of authorized characters into this TextField.

Related XML Attributes

maxLength

Parameters

maxLength	a positive value for a limited number of characters or -1 for no limit.

public void setPasswordMode (boolean passwordMode)

Sets the password mode.

Cross Platform Considerations

In iOS the password mode has no visible effect for TextArea.

Related XML Attributes

passwordMode

Parameters

passwordMode	true to set password edition

Throws

CrossThreadException	if the method is called from outside the UI-Thread

public void setReadOnly (boolean readonly)

Sets the state of this field to readonly or editable

Related XML Attributes

readOnly

Parameters

readonly	true if the textfield could not be edited by the user

Throws

CrossThreadException	if the method is called from outside the UI-Thread

public void setReturnKeyListener (ReturnKeyListener returnKeyListener)

Associates a ReturnKeyListener to this TextField. Required to customize the behavior of the application when the user presses the "Return" key of the keyboard that was opened for this TextField.

Parameters

returnKeyListener	the callback used to listen press event on "Return" for the keyboard of the TextField

public void setReturnKeyType (int returnKeyType)

Changes the content of the return key. Depending on the platform it can be a text or in image. The default content is a "Done" button.

Limitations

In some Android device running a specific constructor layer, this method may have no effect (device running HTC Sense for example)

Parameters

returnKeyType	the `ReturnKeyType` of the keyboard for this TextField

public void setText (String text)

Sets the text of this text field

Related XML Attributes

text

Parameters

text	the new text

Throws

CrossThreadException	if the method is called from outside the UI-Thread

public void setText (int resId)

Sets the text of the text field

Related XML Attributes

text

Parameters

resId	the string id representing the text of this text field

Throws

CrossThreadException	if the method is called from outside the UI-Thread

public void setTextChangedListener (TextChangedListener listener)

Sets a text change listener (called when the text has been changed by the user)

Parameters

listener	the callback used to listen text changes

public void setTextColor (Color color)

Sets the text color of this textfield's text

Related XML Attributes

textColor

Parameters

color	The color to set (with the alpha channel)

Throws

CrossThreadException	if the method is called from outside the UI-Thread

public void setTextMode (TextMode mode)

Changes the text mode. See TextMode for a list of possible values.
The text mode does not enforce users to use the specified keyboard, it is just a hint. The user can still use characters that may differ from the specified text mode, for example alphabetic characters instead of digits.

Related XML Attributes

textMode

Parameters

mode	the text mode to apply to this text edit

Throws

NullPointerException	if the parameter is null

public void setTextSize (int sizeInDp)

Sets the text size to a given value (in dp).

Related XML Attributes

textSize

Parameters

sizeInDp	size to set to the text

Interfaces

Classes

Enums

Exceptions

TextEdit

Summary

XML Attributes

autoCorrect

Related Methods

capitalizeMode

Related Methods

contentAlignment

Related Methods

cursorPosition

Related Methods

defaultText

Related Methods

font

Related Methods

maxLength

Related Methods

passwordMode

Related Methods

readOnly

Related Methods

text

Related Methods

textColor

Related Methods

textMode

Related Methods

textSize

Related Methods

Public Constructors

public TextEdit ()

Public Methods

public void clear ()

Throws

public String getDefaultText ()

Related XML Attributes

Returns

public String getText ()

Returns

public boolean isReadOnly ()

Returns

public int length ()

Returns

public void setAutoCorrect (boolean autocorrect)

Cross Platform Considerations

Related XML Attributes

Parameters

public void setCapitalizeMode (CapitalizeMode mode)

Related XML Attributes

Parameters

Throws

public void setContentAlignment (int alignment)

Related XML Attributes

Parameters

Throws

public void setCursorPosition (int index)

Related XML Attributes

Parameters

Throws

public void setDefaultText (String defaultText)

Related XML Attributes

Parameters

Throws

public void setDefaultText (int resId)

Related XML Attributes

Parameters

Throws

public void setFont (Font font)

Related XML Attributes

Parameters

Throws

public void setMaxLength (int maxLength)

Related XML Attributes

Parameters

public void setPasswordMode (boolean passwordMode)

Cross Platform Considerations