Titanium.UI.Button

Object of Titanium.UI.

Platform	Since
Android	0.8
iPhone	0.8
iPad	0.8
Mobile Web	0.8

Summary

A button widget.

Description

A button widget that has four states, normal, disabled, focused and selected. You can specify background images for each state, as well as button text and a button icon. Use the Titanium.UI.createButton method to create a button.

Code Examples

Simple Button Example

var button = Titanium.UI.createButton({
   title: 'Hello',
   top: 10,
   width: 100,
   height: 50
});
button.addEventListener('click',function(e)
{
   Titanium.API.info("You clicked the button");
});

Methods

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.
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.
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.
show	Makes this view visible.
toImage	Returns an image of the rendered view, as a Blob. (Android, iPhone, iPad only.)

Properties

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
backgroundColor	String	Background color of the view.
backgroundDisabledColor	String	Disabled background color of the view. (Android only.)
backgroundDisabledImage	String	Background image for the button in its disabled state, specified as a local file path or URL.
backgroundFocusedColor	String	Focused background color of the view. (Android only.)
backgroundFocusedImage	String	Background image for the button in its focused state, specified as a local file path or URL.
backgroundGradient	`Gradient`	A background gradient for the view. (iPhone, iPad, Mobile Web only.)
backgroundImage	String	Background image for the button in its normal state, specified as a local file path or URL.
backgroundLeftCap	Number	Size of the left end cap. (iPhone, iPad only.)
backgroundSelectedColor	String	Selected background color of the view. (Android, Mobile Web only.)
backgroundSelectedImage	String	Background image for the button in its selected state, specified as a local file path or URL.
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.
color	String	Default button text color.
enabled	Boolean	Set to `true` to enable the button, `false` to disable the button.
focusable	Boolean	Whether view should be focusable while navigating with the trackball. (Android only.)
font	`Font`	Font to use for the button text.
height	Number or String	View height, in platform-specific units.
image	String	Image to display on the button to the left of the title.
keepScreenOn	Boolean	Whether to keep the device screen on. (Android 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).
right	Number or String	View's right position, in platform-specific units.
selectedColor	String	Button text color used to indicate the selected state.
size	Object	Size of the view as a dictionary of width and height properties.
softKeyboardOnFocus	Number	Determines keyboard behavior when this view is focused. (Android only.)
style	Number	Style constant for the button.
title	String	Button title.
titleid	String	Key identifying a string from the locale file to use for the button title.
top	Number or String	The view's top position.
touchEnabled	Boolean	Whether view should receive touch events.
transform	Object	Transformation matrix to apply to the view. (Android, iPhone, iPad only.)
visible	Boolean	Boolean value indicating whether the view is visible.
width	Number or String	View's width, in platform-specific units.
zIndex	Number	the z index position relative to other sibling views

Events

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