Titanium Mobile

# Titanium.UI.OptionDialog

An option dialog is a modal view that includes a message and one or more option items positioned in the middle of the display on Android and at the bottom edge on iOS. On Android, buttons may be added below the options.

Availability
0.8
0.8
9.2.0
Extends
Titanium.UI.View

# Overview

Android iPhone iPad
Android iPhone iPad

An option dialog is created using Titanium.UI.createOptionDialog or Alloy <OptionDialog> element. See Examples below for usage.

This dialog is presented differently on each platform, as described below.

# Android

On Android, the dialog is shown in the middle of the display (not touching the edges), with the option items represented in a picker. The previously-selected, or default, item can be set on creation.

You can assign a Titanium.UI.View to the Titanium.UI.OptionDialog.androidView property to define a custom dialog UI and layout, or you can assign a set of options to the Titanium.UI.OptionDialog.options property, but not both. If both of these properties are set, the custom view will appear but the options will be hidden.

Buttons below the picker may be optionally defined using the buttonNames property. The click event returns a Boolean value to indicate whether either an option item or a button was clicked.

# iOS

The destructive property may be set for an item, to give a visual cue that selecting it results in an irreversible action. Option dialogs are automatically cancelled when the application is paused/suspended.

# iPhone

On iPhone, this dialog is shown at the bottom edge of the display, with the option items represented as vertical buttons.

# iPad

On iPad, this dialog is shown in the middle of the display, or as a popover-like dialog if another view or control is specified via an argument passed to the open() method.

Note that on iPad, the cancel button is not displayed -- users can cancel the dialog by clicking outside of the dialog.

# Caveats

Care should be taken not to define any properties that are not documented, as this may produce unexpected results. For example, setting a message property will prevent the picker of option items from being displayed on Android.

# Examples

# Dialog with 3 Options

Ti.UI.setBackgroundColor('white');
var win = Ti.UI.createWindow({
  title: 'Click window to test',
  backgroundColor: 'white'
});

var opts = {
  cancel: 2,
  options: ['Confirm', 'Help', 'Cancel'],
  selectedIndex: 2,
  destructive: 0,
  title: 'Delete File?'
};

win.addEventListener('click', function(e){
  var dialog = Ti.UI.createOptionDialog(opts).show();
});
win.open();

# Dialog with 2 Options and 1 Button on Android and 3 Options on iOS

var win = Ti.UI.createWindow({
  title: 'Click window to test OptionDialog',
  backgroundColor: 'white'
});

var opts = {
  title: 'Delete File?'
};

var isAndroid = Ti.Platform.osname === 'android';

if (isAndroid) {
  opts.options = ['Confirm', 'Cancel'];
  opts.buttonNames = ['Help'];
} else {
  opts.options = ['Confirm', 'Help', 'Cancel'];
}

var dialog;
win.addEventListener('click', function() {
  dialog = Ti.UI.createOptionDialog(opts);

  dialog.addEventListener('click', onSelectDialog);
  dialog.addEventListener('cancel', function(e) {
    alert('Dialog canceled! e.cancel = ' + e.cancel + ', e.index = ' + e.index);
  })

   dialog.show();
});

function onSelectDialog(e) {
  if (isAndroid) {
    if (e.button === false && e.index === 0) {
      alert('Confirm option selected! e.index = ' + e.index);
    }
    if (e.button === false && eventeindex === 1) {
      alert('Cancel option selected! e.index = ' + e.index);
    }
    if (e.button === true && e.index === 0) {
      alert('Help Button clicked! e.index = ' + e.index);
    }
  }
}

win.open();

# Alloy XML Markup

Previous example as an Alloy view. You can set Titanium.UI.OptionDialog.cancel and Titanium.UI.OptionDialog.destructive on a <Option/> tag.

optiondialog.xml:

<Alloy>
    <Window id="win" onClick="showOptions" title="Click window to test"
        fullscreen="false" onExit="true" backgroundColor="white">

        <!--
            The OptionDialog tag declares an option dialog,
            which will need to be opened by the controller.
        -->
        <OptionDialog id="dialog" title="Delete File?">

            <!-- The Options tag sets the options property. -->
            <Options>
                <Option destructive="true">Confirm</Option>
                <Option platform="ios">Help</Option>
                <Option cancel="true">Cancel</Option>
            </Options>

            <!-- The ButtonNames tag sets the Android-only buttonNames property. -->
            <ButtonNames>
                <ButtonName>Help</ButtonName>
            </ButtonNames>

            <!-- Add a View for the androidView property here. -->

        </OptionDialog>

        <!-- Add views here -->

    </Window>
</Alloy>

optiondialog.js:

function showOptions(){
    $.dialog.show();
}

# Properties

# androidView

Availability
0.8
androidView :Titanium.UI.View

View to load inside the message area, to create a custom layout.

On Android you can either define a custom view with this property, or you can assign a set of options to the options property, but not both. If you do, the custom view will appear but not the options you defined.

In an Alloy application you can specify this property with either an <AndroidView/> or <View/> element inside the <OptionDialog/> element, for example:

<Alloy>
    <OptionDialog id="dialog" title="Delete File?" onClick="clickCB">

        <!-- Add View or AndroidView for the androidView property -->
        <AndroidView platform="android" layout="vertical">
            <Label color="red" text="Warning!  This change is permanent and you cannot undo it!" />
        </AndroidView>

        <ButtonNames>
            <ButtonName>Confirm</ButtonName>
            <ButtonName>Cancel</ButtonName>
        </ButtonNames>
    </OptionDialog>
</Alloy>

# buttonNames CREATION ONLY

Availability
0.8
buttonNames :Array<String>

List of button names.

This property creates buttons underneath the picker options. The dialog only supports up to three buttons.

# cancel

Availability
0.8
0.8
9.2.0
cancel :Number

Index to define the cancel option.

On iOS, set to -1 to disable the cancel option.

On iPad, the cancel option must be set to either -1 or the index of the last option. For example, if there are 3 options and one of them is a cancel button, the cancel button must be the last option (index 2). If cancel is set to a different value, the last entry in the options array is not displayed.

Note that the cancel button is never shown on iPad, since the user can cancel the dialog by clicking outside of the dialog.

Default: undefined (Android), -1 (iOS)

# destructive CREATION ONLY

Availability
0.8
9.2.0
destructive :Number

Index to define the destructive option, indicated by a visual cue when rendered.

Default: -1

# opaquebackground

Availability
3.2.0
9.2.0
opaquebackground :Boolean

Boolean value indicating if the option dialog should have an opaque background.

This property is useful to ensure that the option dialog will display contents properly on the iPAD idiom without ghosting when scrolling. This property is only respected on the iPAD idiom on iOS7 and above.

Default: false

# options CREATION ONLY

Availability
0.8
0.8
9.2.0
options :Array<String>

List of option names to display in the dialog.

On Android you can assign a set of options to the OptionDialog with this property, or assign a custom view to the androidView property, but not both. If you do, the custom view will appear but not the options you defined.

# persistent

Availability
3.0.0
3.0.0
9.2.0
persistent :Boolean

Boolean value indicating if the option dialog should only be cancelled by user gesture or by hide method.

This property is useful to ensure that the option dialog will not be ignored by the user when the application is paused/suspended.

Default: true

# selectedIndex CREATION ONLY

Availability
0.8
selectedIndex :Number

Defines the default selected option. Since 8.1.0, if not defined or -1 it will show a normal list instead of radio buttons.

# title

Availability
0.8
0.8
9.2.0
title :String

Title of the dialog.

# titleid

Availability
0.8
0.8
9.2.0
titleid :String

Key identifying a string in the locale file to use for the title text.

# Methods

# hide

Availability
0.9
0.9
9.2.0
hide([params]) → void

Hides this dialog.

This triggers a click event as if cancel was invoked.

Parameters

Name Type Description
params hideParams

Argument containing parameters for this method. Only used on iOS.

Returns

Type
void

# show

Availability
0.9
0.9
9.2.0
show([params]) → void

Shows this dialog.

On iPad, this dialog is shown in the middle of the display or, when specified via the params argument, as a popover-like dialog attached to another view or control.

Parameters

Name Type Description
params showParams

Argument containing parameters for this method. Only used on iPad.

Returns

Type
void

# Events

# click

Availability
0.9
0.9
9.2.0

Fired when an option of this dialog is clicked or, under certain circumstances, when this dialog is dismissed.

On iOS as of Release 2.0, when the dialog is dismissed without using an option, for example, using the hide method (iPhone, iPad) or a tap outside of the dialog (iPad), this event is fired as though the cancel option was selected. In these circumstances, the index property will be the cancel option index if defined or -1 otherwise.

Properties

Name Type Description
index Number

Index of the option that was pressed. See description for result of the dialog being dismissed in some other way.

button Boolean

Indicates whether the index returned by the index property relates to a button rather than an option item.

cancel Boolean | Number

Boolean type on Android; Number on iOS.

On Android, indicates whether the cancel button was clicked, in which case returns true.

On iOS, the value of the cancel property is returned, if defined, or -1 otherwise.

destructive Number

Index of the destructive option if defined or -1 otherwise.

source Object

Source object that fired the event.

type String

Name of the event fired.

bubbles Boolean

True if the event will try to bubble up if possible.

cancelBubble Boolean

Set to true to stop the event from bubbling.

Contents