# Titanium.UI.iOS.SystemButton

A set of constants for creating standard iOS system buttons.

Availability

5.4.0

9.2.0

Extends

Titanium.Proxy

# Overview

Most of these constants are used with the Titanium.UI.Button.systemButton property to define a standard iOS system buttons for use in navigation bars and toolbars.

See Titanium.UI.Button for more information on the systemButton property, including details on where system buttons can be used. In an Alloy application you can omit the Ti.UI.iOS.SystemButton namespace when assigning a value to the <Button> element's systemButton attribute, for example:

<Button systemButton="CAMERA"/>
<!-- Instead of -->
<Button systemButton="Titanium.UI.iOS.SystemButton.CAMERA"/>

A few of these constants are used with Titanium.UI.Button.style to create standard iOS buttons that can be used in other places, including table view rows. Note: Starting at Titanium SDK 5.0, all icons have are automatically sized in the native behavior and are not distorted any more. These standard button types are:

See Apple's iOS Human Interface Guidelines (opens new window) in the iOS Developer Library for details on the proper usage of iOS standard buttons and icons.

System Icons

# 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

# ACTION

Availability

5.4.0

9.2.0

ACTION :Number

Use with systemButton to specify an Action button.

The resulting button can only be used in navigation bars and toolbars.

# ACTIVITY

Availability

5.4.0

9.2.0

ACTIVITY :Number

Use with systemButton to create an activity indicator that can be used in navigation bars and toolbars.

When visible, the activity indicator is already started.

# ADD

Availability

5.4.0

9.2.0

ADD :Number

Use with systemButton to specify an Add button.

The resulting button can only be used in navigation bars and toolbars.

# BOOKMARKS

Availability

5.4.0

9.2.0

BOOKMARKS :Number

Use with systemButton to specify a Bookmarks button.

The resulting button can only be used in navigation bars and toolbars.

# CAMERA

Availability

5.4.0

9.2.0

CAMERA :Number

Use with systemButton to specify a Camera button.

The resulting button can only be used in navigation bars and toolbars.

# CANCEL

Availability

5.4.0

9.2.0

CANCEL :Number

Use with systemButton to specify a Cancel button.

This button is displayed as a bordered button with localized text.

The resulting button can only be used in navigation bars and toolbars.

# COMPOSE

Availability

5.4.0

9.2.0

COMPOSE :Number

Use with systemButton to specify a Compose button.

The resulting button can only be used in navigation bars and toolbars.

# CONTACT_ADD

Availability

5.4.0

9.2.0

CONTACT_ADD :Number

Use with style to specify a ContactAdd button.

The resulting button is not restricted to use in navigation bars and toolbars.

# DISCLOSURE

Availability

5.4.0

9.2.0

DISCLOSURE :Number

Use with style to specify a Disclosure button.

The resulting button is not restricted to use in navigation bars and toolbars.

# DONE

Availability

5.4.0

9.2.0

DONE :Number

Use with systemButton to specify a Done button.

This button is displayed as a bordered button with localized text.

The resulting button can only be used in navigation bars and toolbars.

# EDIT

Availability

5.4.0

9.2.0

EDIT :Number

Use with systemButton to specify an Edit button.

This button is displayed as a bordered button with localized text.

The resulting button can only be used in navigation bars and toolbars.

# FAST_FORWARD

Availability

5.4.0

9.2.0

FAST_FORWARD :Number

Use with systemButton to specify a Fast Forward button.

The resulting button can only be used in navigation bars and toolbars.

# FIXED_SPACE

Availability

5.4.0

9.2.0

FIXED_SPACE :Number

Use with systemButton to create a fixed-width blank space for spacing items in toolbars.

Only the width property is used when this value is set.

# FLEXIBLE_SPACE

Availability

5.4.0

9.2.0

FLEXIBLE_SPACE :Number

Use with systemButton to create a flexible blank space for spacing items in toolbars.

The space is distributed equally between the other items. Other item properties are ignored when this value is set.

# INFO_DARK

Availability

5.4.0

9.2.0

INFO_DARK :Number

Use with style to specify a dark-colored Info button.

The resulting button is not restricted to use in navigation bars and toolbars.

# INFO_LIGHT

Availability

5.4.0

9.2.0

INFO_LIGHT :Number

Use with style to specify a light-colored Info button.

The resulting button is not restricted to use in navigation bars and toolbars.

# ORGANIZE

Availability

5.4.0

9.2.0

ORGANIZE :Number

Use with systemButton to specify an Organize button.

The resulting button can only be used in navigation bars and toolbars.

# PAUSE

Availability

5.4.0

9.2.0

PAUSE :Number

Use with systemButton to specify a Pause button.

The resulting button can only be used in navigation bars and toolbars.

# PLAY

Availability

5.4.0

9.2.0

PLAY :Number

Use with systemButton to specify a Play button.

The resulting button can only be used in navigation bars and toolbars.

# REFRESH

Availability

5.4.0

9.2.0

REFRESH :Number

Use with systemButton to specify a Refresh button.

The resulting button can only be used in navigation bars and toolbars.

# REPLY

Availability

5.4.0

9.2.0

REPLY :Number

Use with systemButton to specify a Reply button.

The resulting button can only be used in navigation bars and toolbars.

# REWIND

Availability

5.4.0

9.2.0

REWIND :Number

Use with systemButton to specify a Rewind button.

The resulting button can only be used in navigation bars and toolbars.

# SAVE

Availability

5.4.0

9.2.0

SAVE :Number

Use with systemButton to specify a Save button.

This button is displayed as a bordered button with localized text.

The resulting button can only be used in navigation bars and toolbars.

# SPINNER

Availability

5.4.0

9.2.0

SPINNER :Number

Identical to ACTIVITY.

# STOP

Availability

5.4.0

9.2.0

STOP :Number

Use with systemButton to specify a Stop button.

The resulting button can only be used in navigation bars and toolbars.

# TRASH

Availability

5.4.0

9.2.0

TRASH :Number

Use with systemButton to specify a Trash button.

The resulting button can only be used in navigation bars and toolbars.