| Platform | Since |
|---|---|
| Android | 0.8 |
| iPhone | 0.8 |
| iPad | 0.8 |
| Mobile Web | 1.8 |
A multiline text field that supports editing and scrolling.
Use the Titanium.UI.createTextArea method to create a text area.
On iOS, the color property is required for the text area to work
properly. This is a known issue.
This example creates a highly customized text area.
var ta1 = Titanium.UI.createTextArea({ value : 'I am a textarea', height : 70, width : 300, top : 60, font : {fontSize:20,fontFamily:'Marker Felt', fontWeight:'bold'}, color : '#888', textAlign : 'left', appearance : Titanium.UI.KEYBOARD_APPEARANCE_ALERT, keyboardType : Titanium.UI.KEYBOARD_NUMBERS_PUNCTUATION, returnKeyType : Titanium.UI.RETURNKEY_EMERGENCY_CALL, borderWidth : 2, borderColor : '#bbb', borderRadius : 5 });
On iOS, a configurable toolbar can be displayed above the virtual keyboard.
Toolbars can be used with both text areas and text fields. See Titanium.UI.iOS.Toolbar
for more information.
This code excerpt creates a text area with a toolbar:
Example using a custom keyboard toolbar:
var send = Titanium.UI.createButton({ title : 'Send', style : Titanium.UI.iPhone.SystemButtonStyle.DONE, }); var camera = Titanium.UI.createButton({ systemButton : Titanium.UI.iPhone.SystemButton.CAMERA, }); var cancel = Titanium.UI.createButton({ systemButton : Titanium.UI.iPhone.SystemButton.CANCEL }); var flexSpace = Titanium.UI.createButton({ systemButton : Titanium.UI.iPhone.SystemButton.FLEXIBLE_SPACE }); var textarea = Titanium.UI.createTextArea({ color : '#000', value : 'Focus to see keyboard with toolbar', height : 120, width : 300, top : 10, borderColor : '#000', keyboardToolbar : [cancel, flexSpace, camera, flexSpace, send], keyboardToolbarColor : '#999', keyboardToolbarHeight : 40, });
| Name | Summary |
|---|---|
| add |
Adds a child to this view's hierarchy. |
| addEventListener |
Adds the specified callback as an event listener for the named event. |
| animate |
Animates this view. |
| blur |
Forces the text area to lose focus. |
| convertPointToView |
Translates a point from this view's coordinate system to another view's coordinate system. (Android, iPhone, iPad only.) |
| fireEvent |
Fires a synthesized event to any registered listeners. |
| focus |
Forces the text area to gain focus. |
| getAnchorPoint |
Gets the value of the anchorPoint property. (iPhone, iPad only.) |
| getAnimatedCenterPoint |
Gets the value of the animatedCenterPoint property. (Android, iPhone, iPad only.) |
| getAppearance |
Gets the value of the appearance property. (iPhone, iPad only.) |
| getAutoLink |
Gets the value of the autoLink property. (iPhone, iPad only.) |
| getAutocapitalization |
Gets the value of the autocapitalization property. (Android, iPhone, iPad only.) |
| getBackgroundColor |
Gets the value of the backgroundColor property. |
| getBackgroundDisabledColor |
Gets the value of the backgroundDisabledColor property. (Android only.) |
| getBackgroundDisabledImage |
Gets the value of the backgroundDisabledImage property. (Android only.) |
| getBackgroundFocusedColor |
Gets the value of the backgroundFocusedColor property. (Android only.) |
| getBackgroundFocusedImage |
Gets the value of the backgroundFocusedImage property. (Android only.) |
| getBackgroundGradient |
Gets the value of the backgroundGradient property. (iPhone, iPad, Mobile Web only.) |
| getBackgroundImage |
Gets the value of the backgroundImage property. |
| getBackgroundLeftCap |
Gets the value of the backgroundLeftCap property. (iPhone, iPad only.) |
| getBackgroundRepeat |
Gets the value of the backgroundRepeat property. (iPhone, iPad only.) |
| getBackgroundSelectedColor |
Gets the value of the backgroundSelectedColor property. (Android, Mobile Web only.) |
| getBackgroundSelectedImage |
Gets the value of the backgroundSelectedImage property. (Android, Mobile Web only.) |
| getBackgroundTopCap |
Gets the value of the backgroundTopCap property. (iPhone, iPad only.) |
| getBorderColor |
Gets the value of the borderColor property. |
| getBorderRadius |
Gets the value of the borderRadius property. |
| getBorderWidth |
Gets the value of the borderWidth property. |
| getBottom |
Gets the value of the bottom property. |
| getCenter |
Gets the value of the center property. |
| getChildren |
Gets the value of the children property. |
| getEditable |
Gets the value of the editable property. |
| getEnabled |
Gets the value of the enabled property. |
| getFocusable |
Gets the value of the focusable property. (Android only.) |
| getFont |
Gets the value of the font property. |
| getHeight |
Gets the value of the height property. |
| getKeepScreenOn |
Gets the value of the keepScreenOn property. (Android only.) |
| getKeyboardToolbar |
Gets the value of the keyboardToolbar property. (iPhone, iPad only.) |
| getKeyboardToolbarColor |
Gets the value of the keyboardToolbarColor property. (iPhone, iPad only.) |
| getKeyboardToolbarHeight |
Gets the value of the keyboardToolbarHeight property. (iPhone, iPad only.) |
| getKeyboardType |
Gets the value of the keyboardType property. (Android, iPhone, iPad only.) |
| getLayout |
Gets the value of the layout property. |
| getLeft |
Gets the value of the left property. |
| getOpacity |
Gets the value of the opacity property. |
| getReturnKeyType |
Gets the value of the returnKeyType property. (Android, iPhone, iPad only.) |
| getRight |
Gets the value of the right property. |
| getScrollable |
Gets the value of the scrollable property. (iPhone, iPad only.) |
| getSize |
Gets the value of the size property. |
| getSoftKeyboardOnFocus |
Gets the value of the softKeyboardOnFocus property. (Android only.) |
| getSuppressReturn |
Gets the value of the suppressReturn property. (iPhone, iPad, Mobile Web only.) |
| getTextAlign |
Gets the value of the textAlign property. |
| getTop |
Gets the value of the top property. |
| getTouchEnabled |
Gets the value of the touchEnabled property. |
| getTransform |
Gets the value of the transform property. |
| getValue |
Gets the value of the value property. |
| getVisible |
Gets the value of the visible property. |
| getWidth |
Gets the value of the width property. |
| getZIndex |
Gets the value of the zIndex property. |
| hasText |
Returns |
| hide |
Hides this view. |
| remove |
Removes a child view from this view's hierarchy. |
| removeEventListener |
Removes the specified callback as an event listener for the named event. |
| setAnchorPoint |
Sets the value of the anchorPoint property. (iPhone, iPad only.) |
| setAppearance |
Sets the value of the appearance property. (iPhone, iPad only.) |
| setAutoLink |
Sets the value of the autoLink property. (iPhone, iPad only.) |
| setAutocapitalization |
Sets the value of the autocapitalization property. (Android, iPhone, iPad only.) |
| setBackgroundColor |
Sets the value of the backgroundColor property. |
| setBackgroundDisabledColor |
Sets the value of the backgroundDisabledColor property. (Android only.) |
| setBackgroundDisabledImage |
Sets the value of the backgroundDisabledImage property. (Android only.) |
| setBackgroundFocusedColor |
Sets the value of the backgroundFocusedColor property. (Android only.) |
| setBackgroundFocusedImage |
Sets the value of the backgroundFocusedImage property. (Android only.) |
| setBackgroundGradient |
Sets the value of the backgroundGradient property. (iPhone, iPad, Mobile Web only.) |
| setBackgroundImage |
Sets the value of the backgroundImage property. |
| setBackgroundLeftCap |
Sets the value of the backgroundLeftCap property. (iPhone, iPad only.) |
| setBackgroundRepeat |
Sets the value of the backgroundRepeat property. (iPhone, iPad only.) |
| setBackgroundSelectedColor |
Sets the value of the backgroundSelectedColor property. (Android, Mobile Web only.) |
| setBackgroundSelectedImage |
Sets the value of the backgroundSelectedImage property. (Android, Mobile Web only.) |
| setBackgroundTopCap |
Sets the value of the backgroundTopCap property. (iPhone, iPad only.) |
| setBorderColor |
Sets the value of the borderColor property. |
| setBorderRadius |
Sets the value of the borderRadius property. |
| setBorderWidth |
Sets the value of the borderWidth property. |
| setBottom |
Sets the value of the bottom property. |
| setCenter |
Sets the value of the center property. |
| setEditable |
Sets the value of the editable property. |
| setEnabled |
Sets the value of the enabled property. |
| setFocusable |
Sets the value of the focusable property. (Android only.) |
| setFont |
Sets the value of the font property. |
| setHeight |
Sets the value of the height property. |
| setKeepScreenOn |
Sets the value of the keepScreenOn property. (Android only.) |
| setKeyboardToolbar |
Sets the value of the keyboardToolbar property. (iPhone, iPad only.) |
| setKeyboardToolbarColor |
Sets the value of the keyboardToolbarColor property. (iPhone, iPad only.) |
| setKeyboardToolbarHeight |
Sets the value of the keyboardToolbarHeight property. (iPhone, iPad only.) |
| setKeyboardType |
Sets the value of the keyboardType property. (Android, iPhone, iPad only.) |
| setLayout |
Sets the value of the layout property. |
| setLeft |
Sets the value of the left property. |
| setOpacity |
Sets the value of the opacity property. |
| setReturnKeyType |
Sets the value of the returnKeyType property. (Android, iPhone, iPad only.) |
| setRight |
Sets the value of the right property. |
| setScrollable |
Sets the value of the scrollable property. (iPhone, iPad only.) |
| setSoftKeyboardOnFocus |
Sets the value of the softKeyboardOnFocus property. (Android only.) |
| setSuppressReturn |
Sets the value of the suppressReturn property. (iPhone, iPad, Mobile Web only.) |
| setTextAlign |
Sets the value of the textAlign property. |
| setTop |
Sets the value of the top property. |
| setTouchEnabled |
Sets the value of the touchEnabled property. |
| setTransform |
Sets the value of the transform property. |
| setValue |
Sets the value of the value property. |
| setVisible |
Sets the value of the visible property. |
| setWidth |
Sets the value of the width property. |
| setZIndex |
Sets the value of the zIndex property. |
| show |
Makes this view visible. |
| toImage |
Returns an image of the rendered view, as a Blob. (Android, iPhone, iPad only.) |
| Name | Type | Summary |
|---|---|---|
| anchorPoint | Point |
Anchor point where animation should occur, relative to the view's boundaries. (iPhone, iPad only.) |
| animatedCenterPoint | Point |
Current position of the view during an animation. (Android, iPhone, iPad only.) read-only |
| appearance | Number |
Determines the appearance of the keyboard displayed when this text area is focused. (iPhone, iPad only.) |
| autoLink | Number |
Automatically convert text within this area to clickable links. (iPhone, iPad only.) |
| autocapitalization | Number |
Specifies how text should be capitalized during typing. (Android, iPhone, iPad only.) |
| backgroundColor | String |
Background color of the view. |
| backgroundDisabledColor | String |
Disabled background color of the view. (Android only.) |
| backgroundDisabledImage | String |
Disabled background image for the view, specified as a local file path or URL. (Android only.) |
| backgroundFocusedColor | String |
Focused background color of the view. (Android only.) |
| backgroundFocusedImage | String |
Focused background image for the view, specified as a local file path or URL. (Android only.) |
| backgroundGradient | Gradient |
A background gradient for the view. (iPhone, iPad, Mobile Web only.) |
| backgroundImage | String |
Background image for the view, specified as a local file path or URL. |
| backgroundLeftCap | Number |
Size of the left end cap. (iPhone, iPad only.) |
| backgroundRepeat | Boolean |
Toggle for whether or not to tile a background across a view. (iPhone, iPad only.) |
| backgroundSelectedColor | String |
Selected background color of the view. (Android, Mobile Web only.) |
| backgroundSelectedImage | String |
Selected background image url for the view, specified as a local file path or URL. (Android, Mobile Web only.) |
| backgroundTopCap | Number |
Size of the top end cap. (iPhone, iPad only.) |
| borderColor | String |
Border color of the view. |
| borderRadius | Number |
Border radius of the view. |
| borderWidth | Number |
Border width of the view. |
| bottom | Number or String |
View's bottom position, in platform-specific units. |
| center | Point |
View's center position, in the parent view's coordinates. |
| children | Array<Titanium.UI.View> |
Array of this view's child views. read-only |
| editable | Boolean |
Is the text area editable? |
| enabled | Boolean |
Is the text area enabled? |
| focusable | Boolean |
Whether view should be focusable while navigating with the trackball. (Android only.) |
| font | Font |
Font to use for text. |
| height | Number or String |
View height, in platform-specific units. |
| keepScreenOn | Boolean |
Whether to keep the device screen on. (Android only.) |
| keyboardToolbar | Array<Object> |
Array of toolbar button objects to be used when the keyboard is displayed. (iPhone, iPad only.) |
| keyboardToolbarColor | String |
Color of the keyboard toolbar. (iPhone, iPad only.) |
| keyboardToolbarHeight | Number |
Height of the keyboard toolbar. (iPhone, iPad only.) |
| keyboardType | Number |
Specifies the keyboard type to display when this text area is focused, such as KEYBOARD_EMAIL or KEYBOARD_NUMBER_PAD. (Android, iPhone, iPad only.) |
| layout | String |
Specifies how the view positions its children. One of: 'absolute', 'vertical', or 'horizontal'. |
| left | Number or String |
View's left position, in platform-specific units. |
| opacity | Number |
Opacity of this view, from 0.0 (transparent) to 1.0 (opaque). |
| returnKeyType | Number |
Specifies the text to display on the keyboard Return key when this text area is focused. (Android, iPhone, iPad only.) |
| right | Number or String |
View's right position, in platform-specific units. |
| scrollable | Boolean |
Can the text area be scrolled? (iPhone, iPad only.) |
| size | Object |
Rendered size of the view as a dictionary of width and height properties. read-only |
| softKeyboardOnFocus | Number |
Determines keyboard behavior when this view is focused. (Android only.) |
| suppressReturn | Boolean |
Should the return key be suppressed during entry? (iPhone, iPad, Mobile Web only.) |
| textAlign | String or Number |
Text alignment, specified using one of the |
| top | Number or String |
The view's top position. |
| touchEnabled | Boolean |
Whether view should receive touch events. |
| transform | Titanium.UI.2DMatrix or Titanium.UI.iOS.3DMatrix |
Transformation matrix to apply to the view. |
| value | String |
Value of the text area. |
| visible | Boolean |
Boolean value indicating whether the view is visible. |
| width | Number or String |
View's width, in platform-specific units. |
| zIndex | Number |
Z index position relative to other sibling views. |
| Name | Summary |
|---|---|
| blur |
Fired when the text area loses focus. |
| change |
Fired when the text area value changes. |
| click |
Fired when the device detects a click against the view. |
| dblclick |
Fired when the device detects a double click against the view. |
| doubletap |
Fired when the device detects a double tap against the view. (Android, iPhone, iPad only.) |
| focus |
Fired when the text area gains focus. |
| longclick |
Fired when the device detects a long click. (Android only.) |
| longpress |
Fired when the device detects a long press. (Android, iPhone, iPad only.) |
| pinch |
Fired when the device detects a pinch gesture. (iPhone, iPad only.) |
| return |
Fired when the return key is pressed on the keyboard. |
| selected |
Fired when text in the text area is selected. (iPhone, iPad only.) |
| singletap |
Fired when the device detects a single tap against the view. |
| swipe |
Fired when the device detects a swipe gesture (left or right) against the view. (iPhone, iPad, Mobile Web only.) |
| touchcancel |
Fired when a touch event is interrupted by the device. |
| touchend |
Fired when a touch event is completed. |
| touchmove |
Fired as soon as the device detects movement of a touch. |
| touchstart |
Fired as soon as the device detects a touch gesture. |
| twofingertap |
Fired when the device detects a two-finger tap against the view. |
