Titanium.UI.SearchBar

Object of Titanium.UI.

Platform	Since
Android	0.8
iPhone	0.8
iPad	0.8
Mobile Web	0.8

Summary

A Search Bar is created by the method Titanium.UI.createSearchBar.

Code Examples

Simple Search Bar

var search = Titanium.UI.createSearchBar({
    barColor:'#000', 
    showCancel:true,
    height:43,
    top:0,
});

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.
blur	called to force the search bar 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	called to force the search bar to focus
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
autocapitalization	Number	One of `Titanium.UI.TEXT_AUTOCAPITALIZATION_NONE`, `Titanium.UI.TEXT_AUTOCAPITALIZATION_WORDS`, `Titanium.UI.TEXT_AUTOCAPITALIZATION_SENTENCES`, or `Titanium.UI.TEXT_AUTOCAPITALIZATION_ALL` to indicate how the field should be capitalized during typing.
autocorrect	Boolean	boolean to indicate if the text in the field should be autocorrected as typed
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.)
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.)
barColor	String	the bar color of the search bar view
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.
focusable	Boolean	Whether view should be focusable while navigating with the trackball. (Android only.)
height	Number or String	View height, in platform-specific units.
hintText	String	the text to show when the search bar field is not focused
hinttextid	String	the key in the locale file to use for the hintText property
keepScreenOn	Boolean	Whether to keep the device screen on. (Android only.)
keyboardType	Number	the keyboard type constant to use when the field is focused
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).
prompt	String	a single line of text displayed at the top of the search bar
promptid	String	the key in the locale file to use for the prompt property
right	Number or String	View's right position, in platform-specific units.
showCancel	Boolean	boolean indicates whether the cancel button is displayed
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.)
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.)
value	String	the value of the search bar
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
blur	fired when the search bar loses focus
cancel	fired when the cancel button is pressed
change	fired when the value of the search bar 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 search bar 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.
return	fired when keyboard search button is pressed
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.

Titanium.UI.SearchBar

Summary

Code Examples

Simple Search Bar

Methods

Properties

Events

Mobile API Reference