# Titanium.UI.iOS.SystemButtonStyle

A set of constants for the system button styles that can be used for the button style property.

Availability

5.4.0

9.2.0

Extends

Titanium.Proxy

DEPRECATED SINCE 10.0.0

Use the Titanium.UI module's BUTTON_STYLE_* constants instead.

# Overview

These constants represent standard iOS system button styles that affect the Titanium.UI.Button, Titanium.UI.ButtonBar, and Titanium.UI.iOS.TabbedBar UI elements.

The different styles are used in different places. For normal buttons which are not contained in a nav bar, toolbar, button bar or tabbed bar, the following styles apply:

BORDERED. Simple button style with a rounded border and a white background. The default style for normal buttons.
DONE. Like the bordered button, but with a blue background. Button style for a button that indicates completion, such as OK, Save, or Go.
PLAIN Button style for an undecorated button.

Note that if you specify the PLAIN style, you must style the button using the other button properties. For example, there is no indication that the button has been pressed unless you set other properties for the selected state, such as backgroundSelectedImage and selectedColor.

When you add a button to a Titanium.UI.iOS.Toolbar, the styles have a slightly different effect:

PLAIN Button style for an undecorated button with large text and a glow effect when the button is pressed. Default style for buttons in toolbars.
BORDERED. Simple button style with a rounded border and a light blue background.
DONE. Like the bordered button, but with a dark blue background.

For TabbedBar and ButtonBar controls, styles have the following meaning:

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

# Properties

# apiName READONLY

Availability

5.4.0

9.2.0

apiName :String

The name of the API that this proxy corresponds to.

The value of this property is the fully qualified name of the API. For example, Titanium.UI.Button returns Ti.UI.Button.

# bubbleParent

Availability

5.4.0

9.2.0

bubbleParent :Boolean

Indicates if the proxy will bubble an event to its parent.

Some proxies (most commonly views) have a relationship to other proxies, often established by the add() method. For example, for a button added to a window, a click event on the button would bubble up to the window. Other common parents are table sections to their rows, table views to their sections, and scrollable views to their views. Set this property to false to disable the bubbling to the proxy's parent.

Default: true

# Methods

# addEventListener

Availability

5.4.0

9.2.0

addEventListener(name, callback) → void

Adds the specified callback as an event listener for the named event.

Parameters

Name	Type	Description
`name`	String	Name of the event.
`callback`	Callback<Titanium.Event>	Callback function to invoke when the event is fired.

Returns

Type: void

# applyProperties

Availability

5.4.0

9.2.0

applyProperties(props) → void

Applies the properties to the proxy.

Properties are supplied as a dictionary. Each key-value pair in the object is applied to the proxy such that myproxy[key] = value.

Parameters

Name	Type	Description
`props`	Dictionary	A dictionary of properties to apply.

Returns

Type: void

# fireEvent

Availability

5.4.0

9.2.0

fireEvent(name[, event]) → void

Fires a synthesized event to any registered listeners.

Parameters

Name	Type	Description
`name`	String	Name of the event.
`event`	Dictionary	A dictionary of keys and values to add to the Titanium.Event object sent to the listeners.

Returns

Type: void

# removeEventListener

Availability

5.4.0

9.2.0

removeEventListener(name, callback) → void

Removes the specified callback as an event listener for the named event.

Multiple listeners can be registered for the same event, so the callback parameter is used to determine which listener to remove.

When adding a listener, you must save a reference to the callback function in order to remove the listener later:

var listener = function() { Ti.API.info("Event listener called."); }
window.addEventListener('click', listener);

To remove the listener, pass in a reference to the callback function:

window.removeEventListener('click', listener);

Parameters

Name	Type	Description
`name`	String	Name of the event.
`callback`	Callback<Titanium.Event>	Callback function to remove. Must be the same function passed to `addEventListener`.

Returns

Type: void

# Constants

# BORDERED DEPRECATED

Availability

5.4.0

9.2.0

BORDERED :Number

DEPRECATED SINCE 10.0.0

Use the BUTTON_STYLE_OPTION_NEUTRAL instead.

A simple button style with a border.

Default style for normal buttons. May also be used for toolbar buttons.

When used with Titanium.UI.ButtonBar or Titanium.UI.iOS.TabbedBar, specifies a standard bar with a heavier border.

# DONE DEPRECATED

Availability

5.4.0

9.2.0

DONE :Number

DEPRECATED SINCE 10.0.0

Use the BUTTON_STYLE_OPTION_POSITIVE instead.

The style for a Done button--for example, a button that completes some task and returns to the previous view.

Used in toolbars and navigation bars.

# PLAIN DEPRECATED

Availability

5.4.0

9.2.0

PLAIN :Number

DEPRECATED SINCE 10.0.0

Use the BUTTON_STYLE_OPTION_NEUTRAL instead.

Specifies a borderless button, the default style for toolbars, button bars, and tabbed bars.

In toolbars, this specifies an undecorated button with large text. A glow effect is used when tapped.

In button bars and tabbed bars, specifies a button with large text that is highlighted when tapped.

When used on a normal button (that is, outside of a navigation bar, toolbar, button bar or tabbed bar), PLAIN specifies a button with no built-in decoration except its title text. This is the style you should choose if you want to supply your own background images, background gradient, and so on.