Picker.yml

---
name: Titanium.UI.Picker
summary: |
    A control used to select one or more fixed values.
description: |
    Use the <Titanium.UI.createPicker> method or Alloy **`<Picker>`** element to create a picker control.

    On Android, the `useSpinner` property must be enabled to support multiple columns.
    By default, the spinner is automatically sized to fit its content and can overflow
    to additional spinner rows. The size of the picker can be adjusted with the `width`
    and `height` properties, but may omit picker columns or cut off picker rows
    if the size is set too small.
    
    On iOS, by default, the size of the picker, including its background, is fixed at the
    same size as the iPhone keyboard to respect the
    [iOS Human Interface Guidelines](https://developer.apple.com/library/ios/documentation/UserExperience/Conceptual/MobileHIG/Controls.html#//apple_ref/doc/uid/TP40006556-CH15-SW3).
    The size of the picker should not be modified.
    The contents of the picker are sized to fit the picker, which may cut off text
    in the picker rows. Adding views to picker rows is also supported on iOS.

    On iPad, Apple recommends using a picker only in a popover.  Since the size of the picker
    cannot be adjusted, it is not suitable for the main screen.

    On Mobile Web and Tizen, by default, the picker fills the entire view it is contained in
    but is adjustable using the `width` and `height` properties.
extends: Titanium.UI.View
excludes: {
    properties: [
        anchorPoint,backgroundDisabledColor,backgroundDisabledImage,backgroundFocusedColor,
        backgroundFocusedImage,backgroundGradient,backgroundImage,backgroundLeftCap,backgroundRepeat,
        backgroundSelectedColor,backgroundSelectedImage,backgroundTopCap,center,enabled,layout,tintColor,zIndex
    ],
    methods: [ remove, removeAllChildren ]
}
since: "0.8"
platforms: [android, iphone, ipad, mobileweb, tizen]
methods:
  - name: add
    summary: Adds rows or columns to the picker.
    description: |
        Once you use this method to add rows and columns to a picker, you cannot remove or
        manipulate them.
    parameters:
      - name: data
        summary: |
            A row, set of rows, a column of rows or a set of columns of rows. When this method is 
            used to add a row or set of rows, a single-column picker is created.
        type: [Array<Titanium.UI.PickerRow>, Titanium.UI.PickerRow, Array<Titanium.UI.PickerColumn>, Titanium.UI.PickerColumn]

  - name: getSelectedRow
    summary: Gets the selected row for a column, or `null` if none exists.
    parameters:
      - name: index
        summary: A column index.
        type: Number
    returns: 
      - type: Titanium.UI.PickerRow
    
  - name: reloadColumn
    summary: Repopulates values for a column.
    parameters:
      - name: column
        summary: Column to repopulate.
        type: Titanium.UI.PickerColumn
    platforms: [iphone, ipad]
    
  - name: setSelectedRow
    summary: Selects a column's row.
    description: On iOS, this method must be called after the picker is rendered.
    parameters:
      - name: column
        summary: A column index.
        type: Number
        
      - name: row
        summary: A row index.
        type: Number
        
      - name: animated
        summary: |
            Determines whether the selection should be animated. (iPhone, iPad-only)
        type: Boolean
        default: true
        optional: true

  - name: setValue
    summary: Sets the date and time value property for Date pickers.
    description: |
        Applicable to the <Titanium.UI.PICKER_TYPE_DATE> and <Titanium.UI.PICKER_TYPE_DATE_AND_TIME> 
        picker types.
    platforms: [iphone, ipad]
    parameters:
      - name: date
        summary: A Javascript `Date` object.
        type: Object
        
      - name: suppressEvent
        summary: Determines whether a `change` event is fired.
        type: Boolean
        default: true

    returns: 
      - type: Titanium.UI.PickerRow
    
  - name: showDatePickerDialog
    summary: Shows Date picker as a modal dialog.
    description: |
        Applicable to the <Titanium.UI.PICKER_TYPE_DATE> picker type.
        
        See "Date Picker using showDatePickerDialog()" for an example.
    parameters:
      - name: dictObj
        summary: |
            Dictionary object with a subset of `Titanium.UI.Picker` properties 
            and a callback defined. Acceptable object properties are 
            `callback`, `okButtonTitle`, `title` and `value`.
        type: Object
    platforms: [android]

  - name: showTimePickerDialog
    summary: Shows Time picker as a modal dialog.
    description: |
        Applicable to the <Titanium.UI.PICKER_TYPE_TIME> picker type.  
        
        See "Date Picker using showDatePickerDialog()" for a similar example.
    parameters:
      - name: dictObj
        summary: |
            Dictionary object with a subset of `Titanium.UI.Picker` properties 
            and a callback defined. Acceptable object properties are 
            `callback`, `format24`, `okButtonTitle`, `title` and `value`.
        type: Object
    platforms: [android]

events:
  - name: change
    summary: Fired when the value of any column's row is changed.
    properties:
      - name: columnIndex
        summary: |
            Selected column index. On iOS, Tizen and Mobile Web, only applicable to <Titanium.UI.PICKER_TYPE_PLAIN> 
            picker types.
        type: Number
        
      - name: rowIndex
        summary: |
            Selected row index. On iOS, Tizen and Mobile Web, only applicable to <Titanium.UI.PICKER_TYPE_PLAIN> 
            picker types.
        type: Number
        
      - name: column
        summary: |
            The column object. On iOS, Tizen and Mobile Web, only applicable to <Titanium.UI.PICKER_TYPE_PLAIN> 
            picker types.
        type: Titanium.UI.PickerColumn
        
      - name: countDownDuration
        summary: |
            The selected duration in milliseconds. Applicable to <Titanium.UI.PICKER_TYPE_COUNT_DOWN_TIMER> picker types.
        type: Number

      - name: value
        summary: |
            The selected value. Applicable to date/time pickers only. This property is read-only 
            on Android.
        type: String
        
      - name: row
        summary: |
            The row object. On iOS, Tizen and Mobile Web, only applicable to <Titanium.UI.PICKER_TYPE_PLAIN> picker types.
        type: Titanium.UI.PickerRow
        
      - name: selectedValue
        summary: |
            Array of selected values, one element per column in the picker. Applicable to 
            <Titanium.UI.PICKER_TYPE_PLAIN> picker types.
        type: Array<String>
        
  - name: click
    summary: Fired when the device detects a click against the view.
    platforms: [android]
    since: "3.0.0"
    description: |
        This event is only available for non-spinner plain pickers. 
    properties:
      - name: x
        type: Number
        summary: X coordinate of the event from the `source` view's coordinate system.
    
      - name: y
        summary: Y coordinate of the event from the `source` view's coordinate system.
        type: Number
        
properties:
  - name: backgroundColor
    platforms: [android]

  - name: columns
    summary: Columns used for this picker, as an array of <Titanium.UI.PickerColumn> objects.
    description: |
        In an Alloy application you can specify this property with a `<PickerColumn>` (or `<Column>`)
        element that contains one or more `<PickerRow>` (or `<Row>`) elements, as shown below:

            <Alloy>
                <Window>
                    <Picker useSpinner="true">
                        <PickerColumn id="column1">
                            <PickerRow title="Bananas"/>
                            <PickerRow title="Strawberries"/>
                            <PickerRow title="Mangos"/>
                        </PickerColumn>
                        <!-- Picker shorthand notation -->
                        <Column id="column2">
                            <Row title="red"/>
                            <Row title="green"/>
                            <Row title="blue"/>
                        </Column>
                    </Picker>
                </Window>
            </Alloy>
    type: Array<Titanium.UI.PickerColumn>
    
  - name: countDownDuration
    summary: Duration in milliseconds used for a Countdown Timer picker.
    description: |
        Applicable to <Titanium.UI.PICKER_TYPE_COUNT_DOWN_TIMER> picker types.
    type: Number
    platforms: [iphone, ipad]
    
  - name: format24
    summary: |
        Determines whether the Time pickers display in 24-hour or 12-hour clock format.
    description: |
        Applicable to <Titanium.UI.PICKER_TYPE_TIME> and <Titanium.UI.PICKER_TYPE_DATE_AND_TIME> 
        picker types.
        
        When this property is enabled, a time picker is displayed with hours 0 through 23, 
        or with hours 1 through 12 and am/pm controls otherwise.
        
        For backward compatibility, the default value of this property depends on the style of 
        picker in use.  
        
        For a spinner picker (when `useSpinner` is `true`), this defaults to `true` (24-hour format.)  
        For a native picker (when `useSpinner` is either un-set or `false`), this defaults to `false` 
        (12-hour format.)
        
        The value of this property may be modified even after a picker is rendered and the UI will be 
        updated accordingly.
    type: Boolean
    default: true (spinner enabled), false (otherwise)
    platforms: [android]
    
  - name: locale
    summary: Locale used when displaying Date and Time picker values.
    description: |
        Applicable to <Titanium.UI.PICKER_TYPE_DATE>, <Titanium.UI.PICKER_TYPE_TIME> and 
        <Titanium.UI.PICKER_TYPE_DATE_AND_TIME> picker types.
        
        Locale must be represented as a combination of ISO 2-letter language and country codes. 
        For example, `en-US` or `en-GB`. See the 
        [ISO 639-1](http://en.wikipedia.org/wiki/ISO_639-1) and 
        [ISO 3166-1 alpha-2](http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) 
        sections of wikipedia for reference.
        
        On iOS, the system locale is always used.
    type: String
    default: System Settings
    platforms: [android]

  - name: maxDate
    summary: Maximum date displayed when a Date picker is in use.
    description: |
        Applicable to <Titanium.UI.PICKER_TYPE_DATE> and <Titanium.UI.PICKER_TYPE_DATE_AND_TIME> 
        picker types.

        For JavaScript files, use a JavaScript Date object.

        For Alloy XML and TSS files, use a date string that can be parsed by the
        [moment.js constructor](http://momentjs.com/docs/#/parsing/string/),
        which includes ISO-8601 and RFC2822 dates.

        This property is ignored when `maxDate` is less than `minDate`.
    type: Date

  - name: minDate
    summary: Minimum date displayed when a Date picker is in use.
    description: |
        Applicable to <Titanium.UI.PICKER_TYPE_DATE> and <Titanium.UI.PICKER_TYPE_DATE_AND_TIME> 
        picker types.

        For JavaScript files, use a JavaScript Date object.

        For Alloy XML and TSS files, use a date string that can be parsed by the
        [moment.js constructor](http://momentjs.com/docs/#/parsing/string/),
        which includes ISO-8601 and RFC2822 dates.

        This property is ignored when `maxDate` is less than `minDate`.
    type: Date
    
  - name: minuteInterval
    summary: |
        Interval in minutes displayed when one of the Time types of pickers is in use.
    description: |
        Applicable to <Titanium.UI.PICKER_TYPE_TIME> and <Titanium.UI.PICKER_TYPE_DATE_AND_TIME> 
        picker types.

        The minimum permitted value is 1 and maximum is 30. If the value cannot be evenly divided 
        into 60, the default value is used. 
    type: Number
    default: 1
    platforms: [iphone, ipad]
    
  - name: selectionIndicator
    summary: |
        Determines whether the visual selection indicator is shown.
    description: |
        If `true`, selection indicator is enabled.

        On iOS 7 and later, the picker indicator is always shown and you cannot control it.

        On iOS 6 and prior, if enabled, a blue bar is displayed to indicate the current selection.
    type: Boolean
    default: true (Android), false (iPhone, iPad)
    platforms: [android, iphone, ipad]
    
  - name: type
    summary: Determines the type of picker displayed
    description: |
        `PICKER_TYPE_DATE_AND_TIME` is only available for iOS and Mobile Web, Tizen.
        `PICKER_TYPE_COUNT_DOWN_TIMER` is only available for iOS.
        
        Mobile Web and Tizen rely on input types for date and time types, but as of Q1 2012 these input types 
        are not supported on most browsers, those that do support it support it poorly, and no fall-back
        exists. It is recommended not to use these types on Mobile Web and Tizen until browser support improves.
    type: Number
    constants: Titanium.UI.PICKER_TYPE_*
    default: <Titanium.UI.PICKER_TYPE_PLAIN>
    
  - name: useSpinner
    summary: |
        Determines whether the non-native Android control, with a spinning wheel that looks and 
        behaves like the iOS picker, is invoked rather than the default native "dropdown" style.
    description: |
        If `true`, the spinner is enabled.
        
        This property should be set either at picker creation, i.e. 
        `Titanium.UI.createPicker({ useSpinner:true });`, or before the picker is added to its parent.  
        
        This property must be enabled for multi-column pickers.
    type: Boolean
    default: false
    platforms: [android]
    
  - name: value
    summary: Date and time value for Date pickers.
    description: |
        Applicable to <Titanium.UI.PICKER_TYPE_DATE> and <Titanium.UI.PICKER_TYPE_DATE_AND_TIME> 
        picker types.

        For JavaScript files, use a JavaScript Date object.

        For Alloy XML and TSS files, use a date string that can be parsed by the
        [moment.js constructor](http://momentjs.com/docs/#/parsing/string/),
        which includes ISO-8601 and RFC2822 dates.
    type: Date
    
  - name: visibleItems
    summary: |
        Number of visible rows to display. This is only applicable to a plain picker and when the 
        `useSpinner` is `true`.
    description: |
        The spinner-style Android picker shows 5 rows by default; one selected in the middle and 2 
        above and below. Set to an odd number to ensure the selected row is in the middle.
    type: Number
    default: 5
    platforms: [android]
    
  - name: calendarViewShown
    summary: |
        Determines whether the calenderView is visible.
    description: |
         If 'calendarViewShown' is 'true', the calenderView is visible
    type: Boolean
    default: false
    platforms: [android]
    
  - name: font
    summary: Font to use for text.
    type: Font
    
examples:
  - title: Multi-Column Picker using Alloy XML Markup
    example: |
        Creates a picker with two columns.  You can optionally use `Column` and `Row` as shorthand
        notation for `PickerColumn` and `PickerRow`, respectively.

        `app/views/index.xml`:

            <Alloy>
                <Window id="win" backgroundColor="white" layout="vertical" exitOnClose="true">
                    <Picker id="picker" top="50" selectionIndicator="true" useSpinner="true">
                        <PickerColumn id="column1">
                            <PickerRow title="Bananas"/>
                            <PickerRow title="Strawberries"/>
                            <PickerRow title="Mangos"/>
                            <PickerRow title="Grapes"/>
                        </PickerColumn>
                        <!-- Picker shorthand notation -->
                        <Column id="column2">
                            <Row title="red"/>
                            <Row title="green"/>
                            <Row title="blue"/>
                            <Row title="orange"/>
                        </Column>
                    </Picker>
                </Window>
            </Alloy>

  - title: Date Picker using Alloy XML Markup
    example: |
        Creates a date picker, then monitors the `change` event to see when the user updates the picker.

        For the date string, use string values accepted by the moment.js constructor in the XML and TSS files.
        If you are defining dates in the controller code, use a JavaScript Date object.

        `app/views/index.xml`:

            <Alloy>
                <Window backgroundColor="blue">
                    <Picker id="picker"
                      onChange="report"
                      type="Ti.UI.PICKER_TYPE_DATE"
                      minDate="2014,4,1"
                      maxDate="May 1, 2014 12:00:00"
                      value="2014-04-15T12:00:00">
                    </Picker>
                </Window>
            </Alloy>

        `app/controllers/index.js`:

            function report(e) {
                Ti.API.info('User selected: ' + e.value);
            }

            $.index.open();

  - title: Basic Single Column Picker
    example: |
        Create a one-column, platform-specific style, picker and automatically select a row.
        
            Ti.UI.backgroundColor = 'white';
            var win = Ti.UI.createWindow({
              exitOnClose: true,
              layout: 'vertical'
            });

            var picker = Ti.UI.createPicker({
              top:50
            });
            
            var data = [];
            data[0]=Ti.UI.createPickerRow({title:'Bananas'});
            data[1]=Ti.UI.createPickerRow({title:'Strawberries'});
            data[2]=Ti.UI.createPickerRow({title:'Mangos'});
            data[3]=Ti.UI.createPickerRow({title:'Grapes'});
            
            picker.add(data);
            picker.selectionIndicator = true;
            
            win.add(picker);
            win.open();
            
            // must be after picker has been displayed
            picker.setSelectedRow(0, 2, false); // select Mangos
            
  - title: Multi-Column Picker
    example: |
        Create a two-column, platform-specific style, picker and automatically select a row in 
        each column.

            Ti.UI.backgroundColor = 'white';
            var win = Ti.UI.createWindow({
              exitOnClose: true,
              layout: 'vertical'
            });

            var picker = Ti.UI.createPicker({
              top:50,
              useSpinner: true
            });
            picker.selectionIndicator = true;

            var fruit = [ 'Bananas', 'Strawberries', 'Mangos', 'Grapes' ];
            var color = [ 'red', 'green', 'blue', 'orange' ];

            var column1 = Ti.UI.createPickerColumn();

            for(var i=0, ilen=fruit.length; i<ilen; i++){
              var row = Ti.UI.createPickerRow({
                title: fruit[i]
              });
              column1.addRow(row);
            }

            var column2 = Ti.UI.createPickerColumn();

            for(var i=0, ilen=color.length; i<ilen; i++){
              var row = Ti.UI.createPickerRow({ title: color[i] });
              column2.addRow(row);
            }

            picker.add([column1,column2]);

            win.add(picker);

            win.open();
            
            // must be after picker has been displayed
            picker.setSelectedRow(0, 2, false); // select Mangos
            picker.setSelectedRow(1, 3, false); // select Orange
            
  - title: Date Picker
    example: |
        Create a date picker and handle the subsequent user action.

            Ti.UI.backgroundColor = 'white';
            var win = Ti.UI.createWindow({
              exitOnClose: true,
              layout: 'vertical'
            });

            var picker = Ti.UI.createPicker({
              type:Ti.UI.PICKER_TYPE_DATE,
              minDate:new Date(2009,0,1),
              maxDate:new Date(2014,11,31),
              value:new Date(2014,3,12),
              top:50
            });

            win.add(picker);
            win.open();

            picker.addEventListener('change',function(e){
              Ti.API.info("User selected date: " + e.value.toLocaleString());
            });
            
  - title: Date Picker using showDatePickerDialog() (Android only)
    example: |
        Create a date picker that is automatically displayed as a modal dialog and handle the 
        subsequent user action.

            Ti.UI.backgroundColor = 'white';
            var win = Ti.UI.createWindow({
              exitOnClose: true,
              layout: 'vertical'
            });

            var picker = Ti.UI.createPicker({
              type:Ti.UI.PICKER_TYPE_DATE,
              minDate:new Date(2009,0,1),
              maxDate:new Date(2014,11,31),
              value:new Date(2014,3,12)
            });

            win.open();

            picker.showDatePickerDialog({
              value: new Date(2010,8,1),
              callback: function(e) {
                if (e.cancel) {
                  Ti.API.info('User canceled dialog');
                } else {
                  Ti.API.info('User selected date: ' + e.value);
                }
              }
            });