Merge pull request #4669 from vishalduggal/timob-15077-31X

[TIMOB-15077] (3_1_X) ios7 doc update + StatusBarStyle LIGHT_CONTENT

apidoc/Titanium/UI/Tab.yml

@@ -165,6 +165,27 @@ properties:
     platforms: [iphone, ipad]
     since: "3.1.0"
     osver: {ios: {min: "5.0"}}
+  - name: iconIsmask
+    summary: Defines if the icon property of the tab must be used as a mask. This property is applicable on iOS 7 and greater. 
+    description: |
+        When this property is true, the color data of the image specified as the icon is ignored and the image is used as an alpha mask. 
+        When this is false, the color data of the image is preserved.
+    type: [Boolean]
+    since: "3.1.3"
+    default: true
+    osver: {ios: {min: "7.0"}}
+    platforms: [iphone,ipad]
+  - name: activeIconIsMask
+    summary: Defines if the active icon property of the tab must be used as a mask. This property is applicable on iOS 7 and greater. 
+    description: |
+        This is the equivalent of the [iconIsMask](Titanium.UI.Tab.iconIsmask) property, but for the active icon. When this is true, the active icon is 
+        tinted with the color specified in [tabsTintColor](Titanium.UI.TabGroup.tabsTintColor). When this is false the image is rendered as is, though the 
+        title of the tab is still tinted. 
+    type: [Boolean]
+    since: "3.1.3"
+    default: true
+    osver: {ios: {min: "7.0"}}
+    platforms: [iphone,ipad]
   - name: title
     summary: Title for this tab.
     type: String

apidoc/Titanium/UI/TabGroup.yml

@@ -307,6 +307,18 @@ properties:
     osver: {ios: {min: "5.0"}}
     platforms: [android, iphone, ipad, mobileweb, tizen]
 
+  - name: tabsTintColor
+    summary: The tintColor to apply to the tabs. This property is applicable on iOS 7 and greater. 
+    description: |
+        This property is a direct correspondant of the tintColor property of UITabBar on iOS. This effects the
+        title and icons rendered in the active tab. When not specified the active icons are tinted with a bright
+        blue on iOS7.
+    type: [String]
+    since: "3.1.3"
+    default: null
+    osver: {ios: {min: "7.0"}}
+    platforms: [iphone,ipad]
+
   - name: tabsBackgroundImage
     summary: Default background image for tabs.
     description: |

apidoc/Titanium/UI/UI.yml

@@ -643,6 +643,60 @@ properties:
     permission: read-only
     platforms: [iphone, ipad]
 
+  - name: EXTEND_EDGE_TOP
+    summary: Specifies that the top edge of the window can extend.
+    description: |
+        One of the group of constants for the <Titanium.UI.Window.extendEdges> property.
+    type: Number
+    permission: read-only
+    platforms: [iphone, ipad]
+    since: "3.1.3"
+
+  - name: EXTEND_EDGE_BOTTOM
+    summary: Specifies that the bottom edge of the window can extend.
+    description: |
+        One of the group of constants for the <Titanium.UI.Window.extendEdges> property.
+    type: Number
+    permission: read-only
+    platforms: [iphone, ipad]
+    since: "3.1.3"
+
+  - name: EXTEND_EDGE_LEFT
+    summary: Specifies that the left edge of the window can extend.
+    description: |
+        One of the group of constants for the <Titanium.UI.Window.extendEdges> property.
+    type: Number
+    permission: read-only
+    platforms: [iphone, ipad]
+    since: "3.1.3"
+
+  - name: EXTEND_EDGE_RIGHT
+    summary: Specifies that the right edge of the window can extend.
+    description: |
+        One of the group of constants for the <Titanium.UI.Window.extendEdges> property.
+    type: Number
+    permission: read-only
+    platforms: [iphone, ipad]
+    since: "3.1.3"
+
+  - name: EXTEND_EDGE_NONE
+    summary: Specifies that none of the edges of the window can extend.
+    description: |
+        One of the group of constants for the <Titanium.UI.Window.extendEdges> property.
+    type: Number
+    permission: read-only
+    platforms: [iphone, ipad]
+    since: "3.1.3"
+
+  - name: EXTEND_EDGE_ALL
+    summary: Specifies that all the edges of the window can extend.
+    description: |
+        One of the group of constants for the <Titanium.UI.Window.extendEdges> property.
+    type: Number
+    permission: read-only
+    platforms: [iphone, ipad]
+    since: "3.1.3"
+
   - name: FACE_DOWN
     summary: Constant value for face-down orientation.
     description: |

apidoc/Titanium/UI/View.yml

@@ -1220,6 +1220,17 @@ properties:
     default: <Titanium.UI.Android.SOFT_KEYBOARD_DEFAULT_ON_FOCUS>
     platforms: [android]
 
+  - name: tintColor
+    summary: The view's tintColor. This property is applicable on iOS 7 and greater. 
+    description: |
+        This property is a direct correspondant of the tintColor property of UIView on iOS. If no value is specified, 
+        the tintColor of the View is inherited from its superview. 
+    type: [String]
+    since: "3.1.3"
+    default: null
+    osver: {ios: {min: "7.0"}}
+    platforms: [iphone,ipad]
+
   - name: top
     summary: The view's top position.
     description: |

apidoc/Titanium/UI/Window.yml

@@ -33,6 +33,18 @@ methods:
         type: openWindowParams
         optional: true
 
+  - name: setToolbar
+    summary: Sets the array of items to show in the window's toolbar.
+    parameters:
+      - name: items
+        summary: Array of button objects to show in the window's toolbar.
+        type: Array<Object>
+      - name: params
+        summary: Parameters to control the toolbar appearance.
+        type: windowToolbarParam
+        optional: true
+    platforms: [iphone,ipad]
+
 events:
   - name: android:back
     deprecated:
@@ -262,13 +274,57 @@ properties:
     type: Boolean
     availability: creation
 
+  - name: extendEdges
+    summary: |
+        An array of supported values specified using the EXTEND_EDGE constants in <Titanium.UI>. Valid on iOS 7 and greater.
+    description:  |
+        This is only valid for windows hosted by navigation controllers or tab bar controllers. This property is used to
+        determine the layout of the window within its parent view controller. For example if the window is specified to extend its top edge
+        and it is hosted in a navigation controller, then the top edge of the window is extended underneath the navigation bar so that part
+        of the window is obscured. If the navigation bar is opaque (translucent property on window is false), then the top edge of the window
+        will only extend if <Titanium.UI.Window.includeOpaqueBars> is set to true. 
+
+        The default behavior is to assume that no edges are to be extended. Must be specified before **opening** the window.
+    platforms: [iphone,ipad]
+    type: Array<Number>
+    since: 3.1.3
+    osver: {ios: {min: "7.0"}}
+
+  - name: includeOpaqueBars
+    summary: |
+        Specifies if the edges should extend beyond opaque bars (navigation bar, tab bar, toolbar). Valid on iOS 7 and greater.
+    description:  |
+        By default edges are only extended to include translucent bars. However if this is set to true, then edges are extended beyond
+        opaque bars as well.
+
+        The default behavior assumes that this is false. Must be specified before **opening** the window.
+    platforms: [iphone,ipad]
+    type: Boolean
+    since: 3.1.3
+    osver: {ios: {min: "7.0"}}
+
+  - name: autoAdjustScrollViewInsets
+    summary: |
+        Specifies whether or not the view controller should automatically adjust its scroll view insets. Valid on iOS 7 and greater.
+    description:  |
+        When the value is true, it allows the view controller to adjust its scroll view insets in response to the screen areas consumed by the status bar, navigation bar, toolbar and tab bar.
+
+        The default behavior assumes that this is false. Must be specified before **opening** the window.
+    platforms: [iphone,ipad]
+    type: Boolean
+    since: 3.1.3
+    osver: {ios: {min: "7.0"}}
+
   - name: fullscreen
     summary: Boolean value indicating if the window is fullscreen.
     description: |
-        A fullscreen window occupies all of the screen space, hiding elements
-        such as the iOS nav bar or the Android status bar. Must be specified
-        at creation time or in the `options` dictionary passed to the 
-        [Window.open](Titanium.UI.Window.open) method.
+        A fullscreen window occupies all of the screen space, hiding the status bar. Must be specified
+        at creation time or in the `options` dictionary passed to the [Window.open](Titanium.UI.Window.open) method.
+
+        On iOS the behavior of this property has changed. Starting from 3.1.3, if this property is undefined
+        then the property is set to the value for UIStatusBarHidden defined in tiapp.xml.
+        If that is not defined it is treated as **explicit false**. On earlier versions, opening a window with this property
+        undefined would not effect the status bar appearance.
 
         On Android, setting this property forces the creation of a heavyweight window.
         See "Android Heavyweight and Lightweight Windows" in the main description of this class for more
@@ -312,7 +368,9 @@ properties:
         iOS note: modal windows should not support orientation modes that the
         window they are opened over do not support. Doing otherwise *may* cause
         bad visual/redraw behavior after the modal is dismissed, due to how
-        iOS manages modal transitions.
+        iOS manages modal transitions. Beginning with 3.1.3, if the orientationModes property of a 
+        modal window is undefined, then the orientations supported by this window would be the orientationModes
+        specified by tiapp.xml.
         
         Mobile Web and Tizen note: On Mobile Web and Tizen, windows are always modal, blocking input to underlying 
         windows. If the window does not occupy the full screen, setting `modal` to `true` provides 
@@ -328,18 +386,31 @@ properties:
     default: false
 
   - name: navBarHidden
-    summary: For modal windows, hide the nav bar (`true`) or show the nav bar (`false`).
+    summary: Hides the nav bar (`true`) or shows the nav bar (`false`).
     description: |
         Must be specified at creation time or in the `options` dictionary passed to the 
         [Window.open](Titanium.UI.Window.open) method.
 
+        **Beginning with 3.1.3**, this is no longer a valid parameter passed to the [Window.open](Titanium.UI.Window.open) method.
+        Modal windows on iOS no longer have a navigation controller and hence **do not** have a nav bar.
+
         On Android, setting this property forces the creation of a heavyweight window. See "Android
         Heavyweight and Lightweight Windows" in the main description of this class for more
         information.
     platforms: [android, iphone, ipad, mobileweb, tizen]
     default: false
     type: Boolean
 
+  - name: navTintColor
+    summary: The tintColor to apply to the navigation bar. This property is applicable on iOS 7 and greater. 
+    description: |
+        This property is a direct correspondant of the tintColor property of NavigationBar on iOS.
+    type: [String]
+    since: "3.1.3"
+    default: null
+    osver: {ios: {min: "7.0"}}
+    platforms: [iphone,ipad]
+
   - name: opacity
     summary: The opacity from 0.0-1.0.
     description: |
@@ -479,6 +550,18 @@ properties:
     platforms: [iphone, ipad, mobileweb, tizen]
     type: Titanium.UI.View
 
+  - name: statusBarStyle
+    summary: The status bar style associated with this window. 
+    description: |
+        Sets the status bar style when this window gains focus. This is now the recommended way to control the
+        status bar style on the application. Must be specified **before** the the window is opened.
+
+        If this value is undefined, the value is set to UIStatusBarStyle defined in tiapp.xml.
+        If that is not defined it defaults to <Titanium.UI.iPhone.StatusBar.DEFAULT>.
+    type: [Number]
+    since: "3.1.3"
+    platforms: [iphone,ipad]
+
   - name: tabBarHidden
     summary: |
         Boolean value indicating if the tab bar should be hidden. 
@@ -525,9 +608,10 @@ properties:
   - name: toolbar
     summary: |
         Array of button objects to show in the window's toolbar. This is only valid when
-        the window is the child of a tab.
+        the window has a navigation controller.
     platforms: [iphone, ipad]
     type: Array<Object>
+    permission: read-only
 
   - name: top
     summary: Window's top position, in platform-specific units.
@@ -541,7 +625,7 @@ properties:
   - name: translucent
     summary: Boolean value indicating if the nav bar is translucent.
     platforms: [iphone, ipad, mobileweb, tizen]
-    default: false
+    default: true on iOS7 and above, false otherwise.
     type: Boolean
 
   - name: url
@@ -647,9 +731,11 @@ description: |
     other views. There are a few specialized top-level views that manage windows,
     including:
     
-    * [NavigationGroup](Titanium.UI.iPhone.NavigationGroup)
+    * [NavigationWindow](Titanium.UI.iOS.NavigationWindow)
     * [SplitWindow](Titanium.UI.iPad.SplitWindow)
     * [TabGroup](Titanium.UI.TabGroup). 
+    * [Tab](Titanium.UI.Tab)
+    * [NavigationGroup](Titanium.UI.iPhone.NavigationGroup)
 
     By default, windows occupy the entire screen except for the navigation bar, 
     status bar, and in the case of windows contained in tab groups, the tab bar.
@@ -1007,6 +1093,8 @@ properties:
 
   - name: navBarHidden
     summary: For modal windows, hides the nav bar (`true`) or shows the nav bar (`false`).
+    description: |
+        On iOS, beginning with **Release 3.1.3**, this is no longer a valid parameter passed to the [Window.open](Titanium.UI.Window.open) method.
     type: Boolean
     default: false
 
@@ -1078,6 +1166,32 @@ properties:
     platforms: [android]
     since: "3.1.0"
 
+---
+name: windowToolbarParam
+summary: Dictionary of options for the <Titanium.UI.Window.setToolbar> method.
+since: 3.1.3
+platforms: [iphone,ipad]
+
+properties:
+
+  - name: translucent
+    summary: Defines if the toolbar is translucent.
+    type: Boolean
+    default: true on iOS 7 and above, false otherwise.
+
+  - name: animated
+    summary: Defines if the toolbar appearance is animated.
+    type: Boolean
+    default: true if the window has toolbar items, false otherwise.
+
+  - name: barColor
+    summary: Background color for the toolbar, as a color name or hex triplet.
+    type: String
+
+  - name: tintColor
+    summary: The tintColor to apply to the tool bar. Applicable on iOS 7 and above.
+    type: String
+
 ---
 name: closeWindowParams
 summary: Dictionary of options for the <Titanium.UI.Window.close> method.