Titanium.UI.ButtonBar

Object of Titanium.UI.

Platform	Since
iPhone	0.8
iPad	0.8

Summary

An iOS button bar component.

Description

The button bar is a set of buttons joined into a single control. Each button in a button bar can have a text label or an icon, but not both.

The TabbedBar control is a button bar where the last selected button mantains a pressed or selected state. The following discussion applies to both button bar and tabbed bar.

The buttons share a common style, defined by the style property. This can be set to one of the constants defined in Titanium.UI.iPhone.SystemButtonStyle:

PLAIN. Default style for ButtonBar and TabbedBar.
BORDERED. Creates a bar like the PLAIN bar, but with a heavier border.
BAR. Creates a more compact bar with translucent buttons that allow the bar's background color to show through.

If you want the background color or background gradient of the button bar itself to show through, the style must be set to Titanium.UI.iPhone.SystemButtonStyle.BAR.

Note that you cannot style individual buttons in a button bar. If you want to give a distinct visual style to individual buttons, to use an icon and text on the same button, or to use a button-bar type component on a platform other than iOS, you can use a set of individual Button controls wrapped in a View to create the appearance of a button bar.

Use the Titanium.UI.createButtonBar method to create a button bar.

Code Examples

Simple 3 button button bar

var bb1 = Titanium.UI.createButtonBar({
    labels:['One', 'Two', 'Three'],
    backgroundColor:'#336699',
    top:50,
    style:Titanium.UI.iPhone.SystemButtonStyle.BAR,
    height:25,
    width:200
});
win.add(bb1);

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.
fireEvent	Fires a synthesized event to any registered listeners.
getAnchorPoint	Gets the value of the anchorPoint property.
getAnimatedCenterPoint	Gets the value of the animatedCenterPoint property.
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.
getBackgroundImage	Gets the value of the backgroundImage property.
getBackgroundLeftCap	Gets the value of the backgroundLeftCap property.
getBackgroundRepeat	Gets the value of the backgroundRepeat property.
getBackgroundSelectedColor	Gets the value of the backgroundSelectedColor property.
getBackgroundSelectedImage	Gets the value of the backgroundSelectedImage property.
getBackgroundTopCap	Gets the value of the backgroundTopCap property.
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.
getFocusable	Gets the value of the focusable property. (Android only.)
getHeight	Gets the value of the height property.
getIndex	Gets the value of the index property.
getKeepScreenOn	Gets the value of the keepScreenOn property. (Android only.)
getLabels	Gets the value of the labels property.
getLayout	Gets the value of the layout property.
getLeft	Gets the value of the left property.
getOpacity	Gets the value of the opacity property.
getRight	Gets the value of the right property.
getSize	Gets the value of the size property.
getSoftKeyboardOnFocus	Gets the value of the softKeyboardOnFocus property. (Android only.)
getStyle	Gets the value of the style 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.
getVisible	Gets the value of the visible property.
getWidth	Gets the value of the width property.
getZIndex	Gets the value of the zIndex property.
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.
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.
setBackgroundImage	Sets the value of the backgroundImage property.
setBackgroundLeftCap	Sets the value of the backgroundLeftCap property.
setBackgroundRepeat	Sets the value of the backgroundRepeat property.
setBackgroundSelectedColor	Sets the value of the backgroundSelectedColor property.
setBackgroundSelectedImage	Sets the value of the backgroundSelectedImage property.
setBackgroundTopCap	Sets the value of the backgroundTopCap property.
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.
setFocusable	Sets the value of the focusable property. (Android only.)
setHeight	Sets the value of the height property.
setIndex	Sets the value of the index property.
setKeepScreenOn	Sets the value of the keepScreenOn property. (Android only.)
setLabels	Sets the value of the labels property.
setLayout	Sets the value of the layout property.
setLeft	Sets the value of the left property.
setOpacity	Sets the value of the opacity property.
setRight	Sets the value of the right property.
setSoftKeyboardOnFocus	Sets the value of the softKeyboardOnFocus property. (Android only.)
setStyle	Sets the value of the style 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.
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.

Properties

Name	Type	Summary
anchorPoint	`Point`	Anchor point where animation should occur, relative to the view's boundaries.
animatedCenterPoint	`Point`	Current position of the view during an animation. read-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.
backgroundImage	String	Background image for the view, specified as a local file path or URL.
backgroundLeftCap	Number	Size of the left end cap.
backgroundRepeat	Boolean	Toggle for whether or not to tile a background across a view.
backgroundSelectedColor	String	Selected background color of the view.
backgroundSelectedImage	String	Selected background image url for the view, specified as a local file path or URL.
backgroundTopCap	Number	Size of the top end cap.
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
focusable	Boolean	Whether view should be focusable while navigating with the trackball. (Android only.)
height	Number or String	View height, in platform-specific units.
index	Number	Index of the currently selected button.
keepScreenOn	Boolean	Whether to keep the device screen on. (Android only.)
labels	Array<`String`> or Array<`BarItemType`>	Array of labels for the button bar.
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.
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.)
style	Number	Style of the button bar.
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.
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.

Events

Name	Summary
click	Fired when a button is clicked.
longpress	Fired when the device detects a long press.
pinch	Fired when the device detects a pinch gesture.