com.google.appinventor.components.runtime.TextBox Class Reference

Inheritance diagram for com.google.appinventor.components.runtime.TextBox:

Public Member Functions
	TextBox (ComponentContainer container)
boolean	NumbersOnly ()
void	NumbersOnly (boolean acceptsNumbersOnly)
void	HideKeyboard ()
boolean	MultiLine ()
void	MultiLine (boolean multiLine)
boolean	ReadOnly ()
void	ReadOnly (boolean readOnly)
Public Member Functions inherited from com.google.appinventor.components.runtime.TextBoxBase
	TextBoxBase (ComponentContainer container, EditText textview)
View	getView ()
void	GotFocus ()
void	LostFocus ()
int	TextAlignment ()
void	TextAlignment (int alignment)
int	BackgroundColor ()
void	BackgroundColor (int argb)
boolean	Enabled ()
void	Enabled (boolean enabled)
boolean	FontBold ()
void	FontBold (boolean bold)
boolean	FontItalic ()
void	FontItalic (boolean italic)
float	FontSize ()
void	FontSize (float size)
int	FontTypeface ()
void	FontTypeface (int typeface)
String	Hint ()
void	Hint (String hint)
String	Text ()
void	Text (String text)
int	TextColor ()
void	TextColor (int argb)
void	RequestFocus ()
void	onFocusChange (View previouslyFocused, boolean gainFocus)
Public Member Functions inherited from com.google.appinventor.components.runtime.AndroidViewComponent
boolean	Visible ()
void	Visible (boolean visibility)
int	Width ()
void	Width (int width)
void	WidthPercent (int pCent)
void	setLastWidth (int width)
int	getSetWidth ()
void	setLastHeight (int height)
int	getSetHeight ()
void	CopyWidth (AndroidViewComponent sourceComponent)
int	Height ()
void	Height (int height)
void	HeightPercent (int pCent)
void	CopyHeight (AndroidViewComponent sourceComponent)
int	Column ()
void	Column (int column)
int	Row ()
void	Row (int row)
HandlesEventDispatching	getDispatchDelegate ()

Additional Inherited Members
Static Public Attributes inherited from com.google.appinventor.components.runtime.Component
static final String	ASSET_DIRECTORY = "component"
static final int	ALIGNMENT_NORMAL = 0
static final int	ALIGNMENT_CENTER = 1
static final int	ALIGNMENT_OPPOSITE = 2
static final int	ACCELEROMETER_SENSITIVITY_WEAK = 1
static final int	ACCELEROMETER_SENSITIVITY_MODERATE = 2
static final int	ACCELEROMETER_SENSITIVITY_STRONG = 3
static final int	BUTTON_SHAPE_DEFAULT = 0
static final int	BUTTON_SHAPE_ROUNDED = 1
static final int	BUTTON_SHAPE_RECT = 2
static final int	BUTTON_SHAPE_OVAL = 3
static final int	COLOR_NONE = 0x00FFFFFF
static final int	COLOR_BLACK = 0xFF000000
static final int	COLOR_BLUE = 0xFF0000FF
static final int	COLOR_CYAN = 0xFF00FFFF
static final int	COLOR_DKGRAY = 0xFF444444
static final int	COLOR_GRAY = 0xFF888888
static final int	COLOR_GREEN = 0xFF00FF00
static final int	COLOR_LTGRAY = 0xFFCCCCCC
static final int	COLOR_MAGENTA = 0xFFFF00FF
static final int	COLOR_ORANGE = 0xFFFFC800
static final int	COLOR_PINK = 0xFFFFAFAF
static final int	COLOR_RED = 0xFFFF0000
static final int	COLOR_WHITE = 0xFFFFFFFF
static final int	COLOR_YELLOW = 0xFFFFFF00
static final int	COLOR_DEFAULT = 0x00000000
static final String	DEFAULT_VALUE_COLOR_NONE = "&H00FFFFFF"
static final String	DEFAULT_VALUE_COLOR_BLACK = "&HFF000000"
static final String	DEFAULT_VALUE_COLOR_BLUE = "&HFF0000FF"
static final String	DEFAULT_VALUE_COLOR_CYAN = "&HFF00FFFF"
static final String	DEFAULT_VALUE_COLOR_DKGRAY = "&HFF444444"
static final String	DEFAULT_VALUE_COLOR_GRAY = "&HFF888888"
static final String	DEFAULT_VALUE_COLOR_GREEN = "&HFF00FF00"
static final String	DEFAULT_VALUE_COLOR_LTGRAY = "&HFFCCCCCC"
static final String	DEFAULT_VALUE_COLOR_MAGENTA = "&HFFFF00FF"
static final String	DEFAULT_VALUE_COLOR_ORANGE = "&HFFFFC800"
static final String	DEFAULT_VALUE_COLOR_PINK = "&HFFFFAFAF"
static final String	DEFAULT_VALUE_COLOR_RED = "&HFFFF0000"
static final String	DEFAULT_VALUE_COLOR_WHITE = "&HFFFFFFFF"
static final String	DEFAULT_VALUE_COLOR_YELLOW = "&HFFFFFF00"
static final String	DEFAULT_VALUE_COLOR_DEFAULT = "&H00000000"
static final float	FONT_DEFAULT_SIZE = 14
static final int	LAYOUT_ORIENTATION_HORIZONTAL = ComponentConstants.LAYOUT_ORIENTATION_HORIZONTAL
static final int	LAYOUT_ORIENTATION_VERTICAL = ComponentConstants.LAYOUT_ORIENTATION_VERTICAL
static final int	SCALING_SCALE_PROPORTIONALLY = 0
static final int	SCALING_SCALE_TO_FIT = 1
static final int	TYPEFACE_DEFAULT = 0
static final int	TYPEFACE_SANSSERIF = 1
static final int	TYPEFACE_SERIF = 2
static final int	TYPEFACE_MONOSPACE = 3
static final int	LENGTH_PREFERRED = -1
static final int	LENGTH_FILL_PARENT = -2
static final int	LENGTH_UNKNOWN = -3
static final int	LENGTH_PERCENT_TAG = -1000
static final int	TOAST_LENGTH_SHORT = 0
static final int	TOAST_LENGTH_LONG = 1
static final int	DIRECTION_NORTH = 1
static final int	DIRECTION_NORTHEAST = 2
static final int	DIRECTION_EAST = 3
static final int	DIRECTION_SOUTHEAST = 4
static final int	DIRECTION_SOUTH = -1
static final int	DIRECTION_SOUTHWEST = -2
static final int	DIRECTION_WEST = -3
static final int	DIRECTION_NORTHWEST = -4
static final int	DIRECTION_NONE = 0
static final int	DIRECTION_MIN = -4
static final int	DIRECTION_MAX = 4
static float	SLIDER_MIN_VALUE = 10
static float	SLIDER_MAX_VALUE = 50
static float	SLIDER_THUMB_VALUE = (SLIDER_MIN_VALUE + SLIDER_MAX_VALUE) / 2.0f
static final String	DEFAULT_VALUE_TEXT_TO_SPEECH_COUNTRY = ""
static final String	DEFAULT_VALUE_TEXT_TO_SPEECH_LANGUAGE = ""
Protected Member Functions inherited from com.google.appinventor.components.runtime.AndroidViewComponent
	AndroidViewComponent (ComponentContainer container)
Protected Member Functions inherited from com.google.appinventor.components.runtime.VisibleComponent
	VisibleComponent ()
Protected Attributes inherited from com.google.appinventor.components.runtime.TextBoxBase
final EditText	view
Protected Attributes inherited from com.google.appinventor.components.runtime.AndroidViewComponent
final ComponentContainer	container

Detailed Description

Users enter text in a text box component.

The initial or user-entered text value in a text box component is in the Text(String) property. If Text() is blank, you can use the Hint(String) property to provide the user with a suggestion of what to type. The Hint() appears as faint text in the box.

The MultiLine(boolean) property determines if the text can have more than one line. For a single line text box, the keyboard will close automatically when the user presses the Done key. To close the keyboard for multiline text boxes, the app should use the HideKeyboard() method or rely on the user to press the Back key.

The NumbersOnly(boolean) property restricts the keyboard to accept numeric input only.

Other properties affect the appearance of the text box (TextAlignment(int), BackgroundColor(int), etc.) and whether it can be used (Enabled(boolean)).

Text boxes are usually used with the Button component, with the user clicking on the Button when text entry is complete.

If the text entered by the user should not be displayed, use PasswordTextBox instead.

Author

sharo.nosp@m.n@go.nosp@m.ogle..nosp@m.com (Sharon Perl)

halab.nosp@m.elso.nosp@m.n@goo.nosp@m.gle..nosp@m.com (Hal Abelson)

Definition at line 75 of file TextBox.java.

Constructor & Destructor Documentation

TextBox()

com.google.appinventor.components.runtime.TextBox.TextBox

(

ComponentContainer

container

)

Creates a new TextBox component.

Parameters

container

container, component will be placed in

Definition at line 112 of file TextBox.java.

Member Function Documentation

HideKeyboard()

void com.google.appinventor.components.runtime.TextBox.HideKeyboard

(

)

Hide the keyboard. Only multiline text boxes need this. Single line text boxes close the keyboard when the users presses the Done key.

Definition at line 180 of file TextBox.java.

MultiLine() [1/2]

boolean com.google.appinventor.components.runtime.TextBox.MultiLine

(

)

Multi line property getter method.

Returns

true 

indicates that the textbox accepts multiple lines

false 

lines that the textbox accepts only a single line of input,

Definition at line 199 of file TextBox.java.

MultiLine() [2/2]

void com.google.appinventor.components.runtime.TextBox.MultiLine

(

boolean

multiLine

)

If true, then this type% accepts multiple lines of input, which are entered using the return key. For single line text boxes there is a Done key instead of a return key, and pressing Done hides the keyboard. The app should call the HideKeyboard method to hide the keyboard for a mutiline text box.

Parameters

multiLine

Definition at line 214 of file TextBox.java.

NumbersOnly() [1/2]

boolean com.google.appinventor.components.runtime.TextBox.NumbersOnly

(

)

NumbersOnly property getter method.

Returns

true 

indicates that the textbox accepts numbers only,

false 

indicates that it accepts any text

Definition at line 142 of file TextBox.java.

NumbersOnly() [2/2]

void com.google.appinventor.components.runtime.TextBox.NumbersOnly

(

boolean

acceptsNumbersOnly

)

If true, then this type%` accepts only numbers as keyboard input. Numbers can include a decimal point and an optional leading minus sign. This applies to keyboard input only. Even if NumbersOnly is true, you can set the text to anything at all using the Text(String) property.

Parameters

acceptsNumbersOnly

Definition at line 161 of file TextBox.java.

ReadOnly() [1/2]

boolean com.google.appinventor.components.runtime.TextBox.ReadOnly

(

)

Definition at line 223 of file TextBox.java.

ReadOnly() [2/2]

void com.google.appinventor.components.runtime.TextBox.ReadOnly

(

boolean

readOnly

)

Whether the type% is read-only. By default, this is true{:.logic.block}.

Parameters

readOnly

Definition at line 236 of file TextBox.java.

---

The documentation for this class was generated from the following file:

• C:/Users/Ulli/appinventor-sources/appinventor/components/src/com/google/appinventor/components/runtime/TextBox.java