Titanium.UI.iOS.NavigationWindow

> Titanium.UI.iOS.NavigationWindow

A NavigationWindow implements a specialized view that manages the navigation of hierarchical content.

You create a NavigationWindow with the Titanium.UI.iOS.createNavigationWindow factory method, or a <NavigationWindow> Alloy element.

All NavigationWindow objects must have at least one root window that cannot be removed. When creating a NavigationWindow with the factory method, you must set its window property to the root level window. Equivalently, in an Alloy application, insert a <Window> element as a child of the <NavigationWindow> element. See examples below.

This object is not meant to be added to other windows. However, it can be used within a Titanium.UI.iPad.SplitWindow.

Examples

Simple Navigation Group

Creates a navigation group with the first window colored red. Press the button to open the blue window. Use the back button to return to the red root window.

var win2 = Titanium.UI.createWindow({
    backgroundColor: 'red',
    title: 'Red Window'
});

var win1 = Titanium.UI.iOS.createNavigationWindow({
   window: win2
});

var win3 = Titanium.UI.createWindow({
    backgroundColor: 'blue',
    title: 'Blue Window'
});

var button = Titanium.UI.createButton({
    title: 'Open Blue Window'
});
button.addEventListener('click', function(){
    win1.openWindow(win3, {animated:true});
});

win2.add(button);
var button2 = Titanium.UI.createButton({
    title: 'Close Blue Window'
});
button2.addEventListener('click', function(){
    win1.closeWindow(win3, {animated:false}); //win3.close() will also work!!
});

win3.add(button2);
win1.open();

Alloy XML Markup

Previous example as two Alloy view-controllers. Requires Alloy 1.2.2 and later.

app/views/index.xml:

<Alloy>
    <NavigationWindow id="win1" platform="ios">
        <Window id="win2" title="Red Window" backgroundColor="red">
            <Button id="button" onClick="openBlueWindow">Open Blue Window</Button>
        </Window>
    </NavigationWindow>
</Alloy>

app/controllers/index.js:

function openBlueWindow(e) {
    var win3 = Alloy.createController('bluewin').getView();
    $.win1.openWindow(win3);
}

$.win1.open();

app/views/bluewin.xml:

<Alloy>
    <Window id="win3" title="Blue Window" backgroundColor="blue">
        <Button onClick="closeWindow">Close Window</Button>
    </Window>
</Alloy>

app/controllers/bluewin.js:

function closeWindow(){
    $.win3.close();
}

  • 3.1.3
  • 3.1.3
Defined By

Properties

Whether the view should be "hidden" from (i.e., ignored by) the accessibility service. ...

Whether the view should be "hidden" from (i.e., ignored by) the accessibility service.

On iOS this is a direct analog of the accessibilityElementsHidden property defined in the UIAccessibility Protocol. The native property is only available in iOS 5.0 and later; if accessibilityHidden is specified on earlier versions of iOS, it is ignored.

On Android, setting accessibilityHidden calls the native View.setImportantForAccessibility method. The native method is only available in Android 4.1 (API level 16/Jelly Bean) and later; if this property is specified on earlier versions of Android, it is ignored.

Default: false

  • 3.0
  • 3.0
  • 3.0

Briefly describes what performing an action (such as a click) on the view will do.

Briefly describes what performing an action (such as a click) on the view will do.

On iOS this is a direct analog of the accessibilityHint property defined in the UIAccessibility Protocol. On Android, it is concatenated together with accessibilityLabel and accessibilityValue in the order: accessibilityLabel, accessibilityValue, accessibilityHint. The concatenated value is then passed as the argument to the native View.setContentDescription method.

  • 3.0
  • 3.0
  • 3.0
A succint label identifying the view for the device's accessibility service. ...

A succint label identifying the view for the device's accessibility service.

On iOS this is a direct analog of the accessibilityLabel property defined in the UIAccessibility Protocol. On Android, it is concatenated together with accessibilityValue and accessibilityHint in the order: accessibilityLabel, accessibilityValue, accessibilityHint. The concatenated value is then passed as the argument to the native View.setContentDescription method.

Default: Title or label of the control.

  • 3.0
  • 3.0
  • 3.0
A string describing the value (if any) of the view for the device's accessibility service. ...

A string describing the value (if any) of the view for the device's accessibility service.

On iOS this is a direct analog of the accessibilityValue property defined in the UIAccessibility Protocol. On Android, it is concatenated together with accessibilityLabel and accessibilityHint in the order: accessibilityLabel, accessibilityValue, accessibilityHint. The concatenated value is then passed as the argument to the native View.setContentDescription method.

Default: State or value of the control.

  • 3.0
  • 3.0
  • 3.0
Coordinate of the view about which to pivot an animation. ...

Coordinate of the view about which to pivot an animation.

Used on iOS only. For Android, use Titanium.UI.Animation.anchorPoint.

Anchor point is specified as a fraction of the view's size. For example, {0, 0} is at the view's top-left corner, {0.5, 0.5} at its center and {1, 1} at its bottom-right corner.

See the "Using an anchorPoint" example in Titanium.UI.Animation for a demonstration.

Default: Center of this view.

  • 0.9
  • 0.9

Current position of the view during an animation.

Current position of the view during an animation.

  • 0.9
  • 0.9
apiName : Stringreadonly

The name of the API that this proxy corresponds to.

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, Button returns Ti.UI.Button.

  • 3.2
  • 3.2
  • 3.2
  • 3.2
  • 3.2
  • 3.2
Specifies whether or not the view controller should automatically adjust its scroll view insets. ...

Specifies whether or not the view controller should automatically adjust its scroll view insets. Valid on iOS 7 and greater.

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.

  • 3.1.3
  • 3.1.3
Background color of the window, as a color name or hex triplet. ...

Background color of the window, as a color name or hex triplet.

On Android, to specify a semi-transparent background, set the alpha value using the opacity property before opening the window.

For information about color values, see the "Colors" section of Titanium.UI.

Default: Transparent

Overrides: Titanium.UI.View.backgroundColor

A background gradient for the view. ...

A background gradient for the view.

A gradient can be defined as either linear or radial. A linear gradient varies continuously along a line between the startPoint and endPoint.

A radial gradient is interpolated between two circles, defined by startPoint and startRadius and endPoint and endRadius respectively.

The start and end points and radius values can be defined in device units, in the view's coordinates, or as percentages of the view's size. Thus, if a view is 60 x 60, the center point of the view can be specified as:

{ x: 30, y: 30 }

Or: { x: '50%', y: '50%' }

When specifying multiple colors, you can specify an offset value for each color, defining how far into the gradient it takes effect. For example, the following color array specifies a gradient that goes from red to blue back to red:

colors: [ { color: 'red', offset: 0.0}, { color: 'blue', offset: 0.25 }, { color: 'red', offset: 1.0 } ]

Mobile Web and Tizen have two limitations: backfillStart and backfillEnd are ignored and the system behaves as if they are true, and endPoint is not supported for radial gradients.

Android currently only supports linear gradients. It also ignores backfillStart and backfillEnd treating them as if they are true.

Example

Linear and Radial Gradients

The following code excerpt creates two views, one with a linear gradient and one with a radial gradient.

var win1 = Titanium.UI.createWindow({
    title:'Tab 1',
    backgroundColor:'#fff',
    layout: 'vertical'
});

var radialGradient = Ti.UI.createView({
    top: 10,
    width: 100,
    height: 100,
    backgroundGradient: {
        type: 'radial',
        startPoint: { x: 50, y: 50 },
        endPoint: { x: 50, y: 50 },
        colors: [ 'red', 'blue'],
        startRadius: '90%',
        endRadius: 0,
        backfillStart: true
    }
});
var linearGradient = Ti.UI.createView({
    top: 10,
    width: 100,
    height: 100,
    backgroundGradient: {
        type: 'linear',
        startPoint: { x: '0%', y: '50%' },
        endPoint: { x: '100%', y: '50%' },
        colors: [ { color: 'red', offset: 0.0}, { color: 'blue', offset: 0.25 }, { color: 'red', offset: 1.0 } ],
    }
});
win1.add(radialGradient);
win1.add(linearGradient);
win1.open();

Default: No gradient

  • 0.9
  • 0.9
  • 1.8
  • 3.1
  • 0.9
Background image for the view, specified as a local file path or URL. ...

Background image for the view, specified as a local file path or URL.

Default: Default behavior when backgroundImage is unspecified depends on the type of view and the platform. For generic views, no image is used. For most controls (buttons, text fields, and so on), platform-specific default images are used.

Size of the left end cap. ...

Size of the left end cap.

See the section on backgroundLeftCap and backgroundTopCap behavior on iOS in Titanium.UI.View.

Default: 0

  • 0.9
  • 0.9
Determines whether to tile a background across a view. ...

Determines whether to tile a background across a view.

Setting this to true makes the set backgroundImage repeat across the view as a series of tiles. The tiling begins in the upper-left corner, where the upper-left corner of the background image is rendered. The image is then tiled to fill the available space of the view.

Note that setting this to true may incur performance penalties for large views or background images, as the tiling must be redone whenever a view is resized.

On iOS, the following views do not currently support tiled backgrounds:

Default: false

  • 0.9
  • 0.9
  • 0.9
Size of the top end cap. ...

Size of the top end cap.

See the section on backgroundLeftCap and backgroundTopCap behavior on iOS in Titanium.UI.View.

Default: 0

  • 0.9
  • 0.9
Border color of the view, as a color name or hex triplet. ...

Border color of the view, as a color name or hex triplet.

For information about color values, see the "Colors" section of Titanium.UI.

Default: Same as the normal background color of this view (Android, Mobile Web, Tizen), black (iOS).

  • 0.9
  • 0.9
  • 0.9
  • 1.8
  • 3.1
Radius for the rounded corners of the view's border. ...

Radius for the rounded corners of the view's border.

Each corner is rounded using an arc of a circle.

Default: 0

  • 0.9
  • 0.9
  • 0.9
  • 1.8
  • 3.1
Border width of the view. ...

Border width of the view.

Default: 0

  • 0.9
  • 0.9
  • 0.9
  • 1.8
  • 3.1
: Number/String
Window's bottom position, in platform-specific units. ...

Window's bottom position, in platform-specific units.

On Android, this property only works with lightweight windows. See "Android Heavyweight and Lightweight Windows" in the main description of Titanium.UI.Window for more information.

Overrides: Titanium.UI.View.bottom

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

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

  • 3.0
  • 3.0
  • 3.0
View's center position, in the parent view's coordinates. ...

View's center position, in the parent view's coordinates.

This is an input property for specifying where the view should be positioned, and does not represent the view's calculated position.

  • 0.9
  • 0.9
  • 0.9
  • 1.8
  • 3.1

Array of this view's child views.

Array of this view's child views.

View's clipping behavior. ...

View's clipping behavior.

Setting this to Titanium.UI.iOS.CLIP_MODE_ENABLED enforces all child views to be clipped to this views bounds. Setting this to Titanium.UI.iOS.CLIP_MODE_DISABLED allows child views to be drawn outside the bounds of this view. When set to Titanium.UI.iOS.CLIP_MODE_DEFAULT or when this property is not set, clipping behavior is inferred. See section on iOS Clipping Behavior in Titanium.UI.View.

Default: Undefined. Behaves as if set to Titanium.UI.iOS.CLIP_MODE_DEFAULT.

  • 3.3
  • 3.3
An array of supported values specified using the EXTEND_EDGE constants in Titanium.UI. ...

An array of supported values specified using the EXTEND_EDGE constants in Titanium.UI. Valid on iOS 7 and greater.

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 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.

This property can be assigned the following constants:

  • 3.1.3
  • 3.1.3
Boolean value indicating if the window is fullscreen. ...

Boolean value indicating if the window is fullscreen.

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 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 before Titanium 3.2.0. See "Android Heavyweight and Lightweight Windows" in the main description of this class for more information.

Default: false

  • 0.9
  • 0.9
  • 0.9
height : Number/String

View height, in platform-specific units.

View height, in platform-specific units.

Defaults to: If undefined, defaults to either Titanium.UI.FILL or Titanium.UI.SIZE depending on the view. See "View Types and Default Layout Behavior" in Transitioning to the New UI Layout System.

Can be either a float value or a dimension string (for example, '50%' or '40dp'). Can also be one of the following special values:

  • Titanium.UI.SIZE. The view should size itself to fit its contents.
  • Titanium.UI.FILL. The view should size itself to fill its parent.
  • 'auto'. Represents the default sizing behavior for a given type of view. The use of 'auto' is deprecated, and should be replaced with the SIZE or FILL constants if it is necessary to set the view's behavior explicitly.

    On Mobile Web and Tizen, 'auto' always selects SIZE behavior.

This is an input property for specifying the view's height dimension. To determine the view's size once rendered, use the rect or size properties.

This property can be assigned the following constants:

Determines whether the layout has wrapping behavior. ...

Determines whether the layout has wrapping behavior.

For more information, see the discussion of horizontal layout mode in the description of the layout property.

Default: true

  • 2.1
  • 2.1
  • 2.1
  • 2.1
  • 3.1
Specifies if the edges should extend beyond opaque bars (navigation bar, tab bar, toolbar). ...

Specifies if the edges should extend beyond opaque bars (navigation bar, tab bar, toolbar). Valid on iOS 7 and greater.

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.

  • 3.1.3
  • 3.1.3
Specifies how the view positions its children. ...

Specifies how the view positions its children. One of: 'composite', 'vertical', or 'horizontal'.

There are three layout options:

  • composite (or absolute). Default layout. A child view is positioned based on its positioning properties or "pins" (top, bottom, left, right and center). If no positioning properties are specified, the child is centered.

    The child is always sized based on its width and height properties, if these are specified. If the child's height or width is not specified explicitly, it may be calculated implicitly from the positioning properties. For example, if both left and center.x are specified, they can be used to calculate the width of the child control.

    Because the size and position properties can conflict, there is a specific precedence order for the layout properties. For vertical positioning, the precedence order is: height, top, center.y, bottom.

    The following table summarizes the various combinations of properties that can be used for vertical positioning, in order from highest precedence to lowest. (For example, if height, center.y and bottom are all specified, the height and center.y values take precedence.)

    ScenarioBehavior
    height & top specifiedChild positioned top unit from parent's top, using specified height; any center.y and bottom values are ignored.
    height & center.y specifiedChild positioned with center at center.y, using specified height; any bottom value is ignored.
    height & bottom specifiedChild positioned bottom units from parent's bottom, using specified height.
    top & center.y specifiedChild positioned with top edge top units from parent's top and center at center.y. Height is determined implicitly; any bottom value is ignored.
    top & bottom specifiedChild positioned with top edge top units from parent's top and bottom edge bottom units from parent's bottom. Height is determined implicitly.
    Only top specifiedChild positioned top units from parent's top, and uses the default height calculation for the view type.
    center.y and bottom specifiedChild positioned with center at center.y and bottom edge bottom units from parent's bottom. Height is determined implicitly.
    Only center.y specifiedChild positioned with center at center.y, and uses the default height calculation for the view type.
    Only bottom specifiedChild positioned with bottom edge bottom units from parent's bottom, and uses the default height calculation for the view type.
    height, top, center.y, and bottom unspecifiedChild centered vertically in the parent and uses the default height calculation for the child view type.

    Horizontal positioning works like vertical positioning, except that the precedence is width, left, center.x, right.

    For complete details on composite layout rules, see Transitioning to the New UI Layout System in the Titanium Mobile Guides.

  • vertical. Children are laid out vertically from top to bottom. The first child is laid out top units from its parent's bounding box. Each subsequent child is laid out below the previous child. The space between children is equal to the upper child's bottom value plus the lower child's top value.

    Each child is positioned horizontally as in the composite layout mode.

  • horizontal. Horizontal layouts have different behavior depending on whether wrapping is enabled. Wrapping is enabled by default (the horizontalWrap property is true).

    With wrapping behavior, the children are laid out horizontally from left to right, in rows. If a child requires more horizontal space than exists in the current row, it is wrapped to a new row. The height of each row is equal to the maximum height of the children in that row.

    Wrapping behavior is available on iOS, Android, Tizen and Mobile Web (Release 2.1.0 and later). When the horizontalWrap property is set to true, the first row is placed at the top of the parent view, and successive rows are placed below the first row. Each child is positioned vertically within its row somewhat like composite layout mode. In particular:

    • If neither top or bottom is specified, the child is centered in the row.
    • If either top or bottom is specified, the child is aligned to either the top or bottom of the row, with the specified amount of padding.
    • If both top and bottom is specified for a given child, the properties are both treated as padding.

    If the horizontalWrap property is false, the behavior is more equivalent to a vertical layout. Children are laid or horizontally from left to right in a single row. The left and right properties are used as padding between the children, and the top and bottom properties are used to position the children vertically.

    On Mobile Web prior to Release 2.1.0, the horizontal layout does not wrap by default, and does not support the horizontalWrap property. On Android and iOS prior to Release 2.1.0, the horizontal layout always wraps and the horizontalWrap property is not supported.

Default: Composite layout

: Number/String
Window's left position, in platform-specific units. ...

Window's left position, in platform-specific units.

On Android, this property only works with lightweight windows. See "Android Heavyweight and Lightweight Windows" in the main description of Titanium.UI.Window for more information.

Overrides: Titanium.UI.View.left

An Array of views to show in the left nav bar area.

An Array of views to show in the left nav bar area.

  • 3.3
  • 3.3
Boolean to indicate if the window should be opened modal in front of other windows. ...

Boolean to indicate if the window should be opened modal in front of other windows.

Must be specified at creation time or in the options dictionary passed to the Window.open method.

Android note: Android modal windows are translucent. Before Android API 14, everything behind the modal window is blurred. On API 14 and above, blurring is no longer supported and will not work as expected because the flag FLAG_BLUR_BEHIND is deprecated. The combination of fullscreen:true and modal:true will not work as expected. In Android, the contents of a translucent window cannot appear above the status bar. I.e. even though you set fullscreen:true, the status bar will still be visible if it was visible in the previous window. navBarHidden and modal do work fine together, however.

On Android, setting this property forces the creation of a heavyweight window before Titanium 3.2.0. See "Android Heavyweight and Lightweight Windows" in the main description of this class for more information.

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. 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 a visual cue by dimming any background windows. If the window occupies the full screen, modal has no effect.

On the BlackBerry platform, the very first window in the application cannot be modal, therefore the modal flag will be ignored if set on the first window.

On Mobile Web, Tizen, iOS, and BlackBerry the modal property has no effect on whether the window is translucent or opaque.

Default: false

The opacity from 0.0-1.0. ...

The opacity from 0.0-1.0.

iOS Notes: For modal windows that cover the previous window, the previous window is removed from the render stack after the modal window finishes opening. If the modal window is semi-transparent, the underlying window will be visible during the transition animation, but disappear as soon as the animation is completed. (In general all modal windows cover the previous window, except for iPad modal windows using the Page sheet or Form sheet style.)

Android Notes: If you set any of windowSoftInputMode, fullscreen, or navBarHidden, and you wish to use the opacity property at any time during the window's lifetime, be sure to set an opacity value before opening the window. You can later change that value -- and you can set it to 1 for full opacity if you wish -- but the important thing is that you set it to a value before opening the window if you will want to set it at any time during the window's lifetime.

The technical reason for this is that if the opacity property is present (i.e., has been set to something) and a new Android Activity is created for the window, then a translucent theme will be used for the Activity. Window transparency (opacity values below 1) will only work in Android if the Activity's theme is translucent, and Titanium only uses a translucent theme for an Activity if you set an opacity property before opening the window. Additionally, do not use opacity and fullscreen: true together, because translucent themes in Android cannot hide the status bar. Finally, if you do set the opacity property, be sure to also set a backgroundImage or backgroundColor property as well, unless you want the window to be completely transparent.

Default: 1.0 (opaque)

Overrides: Titanium.UI.View.opacity

Current orientation of the window.

Current orientation of the window.

To determine the current orientation of the device, see Gesture.orientation, instead.

See the discussion of the orientationModes property for more information on how the screen orientation is determined.

This property can be assigned the following constants:

  • 0.9
  • 3.0
  • 3.0
Array of supported orientation modes, specified using the orientation constants defined in Titanium.UI. ...

Array of supported orientation modes, specified using the orientation constants defined in Titanium.UI.

Note: Using the orientationModes property to force the orientation of non-modal windows is considered a bad practice and will not be supported, including forcing the orientation of windows inside a NavigationWindow or TabGroup.

To restrict this window to a certain set of orientations, specify one or more of the orientation constants LANDSCAPE_LEFT, LANDSCAPE_RIGHT, PORTRAIT, UPSIDE_PORTRAIT.

orientationModes must be set before opening the window.

To determine the current orientation of the window, see Window.orientation. To determine the current orientation of the device, see Gesture.orientation. To be notified when the device's current orientation changes, add a listener for the Titanium.Gesture.orientationchange event.

Android Orientation Modes

On Android, orientationModes only takes effect when specified on a heavyweight window.

On Android, orientation behavior is dependent on the Android SDK level of the device itself. Devices running Android 2.3 and above support "sensor portait mode" and "sensor landscape mode," in these modes, the device is locked into either a portrait or landscape orientation, but can switch between the normal and reverse orientations (for example, between PORTRAIT and UPSIDE_PORTRAIT).

In addition, the definition of portrait or landscape mode can vary based on the physical design of the device. For example, on some devices Titanium.UI.LANDSCAPE_LEFT represents the top of the device being at the 270 degree position but other devices may (based on camera position for example) treat this position as Titanium.UI.LANDSCAPE_RIGHT. In general, applications for Android that need to be aware of orientation should try and limit their orientation logic to handling either portrait or landscape rather than worrying about the reverse modes. This approach will allow the orientation modes to adopt a more natural feel for the specific device.

The following list breaks down the orientation behavior on Android based on the contents of the orientationModes array:

  1. Empty array. Enables orientation to be fully controlled by the device sensor.

  2. Array includes one or both portrait modes and one or both landscape modes. Enables full sensor control (identical to an empty array).

  3. Array contains PORTRAIT and UPSIDE_PORTRAIT. On Android 2.3 and above, enables sensor portrait mode. This means the screen will shift between both portrait modes according to the sensor inside the device.

    On Android versions below 2.3, locks screen orientation in normal portrait mode.

  4. Array contains LANDSCAPE_LEFT and LANDSCAPE_RIGHT. On Android 2.3 and above, enables sensor landscape mode. This means the screen will shift between both landscape modes according to the sensor inside the device.

    On Android versions below 2.3, locks screen orientation in normal landscape mode.

  5. Array contains only PORTRAIT. Locks screen orientation to normal portrait mode.

  6. Array contains only LANDSCAPE_LEFT. Locks screen orientation to normal landscape mode.

  7. Array contains only UPSIDE_PORTRAIT. On Android 2.3 and above, locks screen in reverse portrait mode.

    On Android versions below 2.3, results are undefined.

  8. Array contains only LANDSCAPE_RIGHT. On Android 2.3 and above, locks screen in reverse landscape mode.

    On Android versions below 2.3, results are undefined.

This property can be assigned the following constants:

Default: empty array

  • 0.9
  • 0.9
  • 0.9
Background color of the wrapper view when this view is used as either Titanium.UI.ListView.pullView or Titanium.UI.Ta...

Background color of the wrapper view when this view is used as either Titanium.UI.ListView.pullView or Titanium.UI.TableView.headerPullView.

Default: Undefined. Results in a light grey background color on the wrapper view.

  • 3.3
  • 3.3

The bounding box of the view relative to its parent, in system units.

The bounding box of the view relative to its parent, in system units.

The view's bounding box is defined by its size and position.

The view's size is rect.width x rect.height. The view's top-left position relative to its parent is (rect.x , rect.y).

The correct values will only be available when layout is complete. To determine when layout is complete, add a listener for the postlayout event.

  • 2.0
  • 2.0
  • 2.0
  • 2.0
  • 3.1
: Number/String
Window's right position, in platform-specific units. ...

Window's right position, in platform-specific units.

On Android, this property only works with lightweight windows. See "Android Heavyweight and Lightweight Windows" in the main description of Titanium.UI.Window for more information.

Overrides: Titanium.UI.View.right

An Array of views to show in the right nav bar area.

An Array of views to show in the right nav bar area.

  • 3.3
  • 3.3

The size of the view in system units.

The size of the view in system units.

Although property returns a Dimension dictionary, only the width and height properties are valid. The position properties--x and y--are always 0.

To find the position and size of the view, use the rect property instead.

The correct values will only be available when layout is complete. To determine when layout is complete, add a listener for the postlayout event.

  • 0.9
  • 0.9
  • 0.9
  • 1.8
  • 3.1

The status bar style associated with this window.

The status bar style associated with this window.

Sets the status bar style when this window has focus. This is now the recommended way to control the status bar style on the application.

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.

This property can be assigned the following constants:

  • 3.1.3
  • 3.1.3
The view's tintColor. ...

The view's tintColor. This property is applicable on iOS 7 and greater.

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.

  • 3.1.3
  • 3.1.3

Title text attributes of the window.

Title text attributes of the window.

Use this property to specify the color, font and shadow attributes of the title.

  • 3.2
  • 3.2
: Number/String
Window's top position, in platform-specific units. ...

Window's top position, in platform-specific units.

On Android, this property only works with lightweight windows. See "Android Heavyweight and Lightweight Windows" in the main description of Titanium.UI.Window for more information.

Default: 0

Overrides: Titanium.UI.View.top

Determines whether view should receive touch events. ...

Determines whether view should receive touch events.

If false, will forward the events to peers.

Default: true

Transformation matrix to apply to the view. ...

Transformation matrix to apply to the view.

Android, Tizen and Mobile Web only support 2DMatrix transforms.

Default: Identity matrix

  • 0.9
  • 0.9
  • 0.9
  • 1.8
  • 3.1
Determines the color of the shadow. ...

Determines the color of the shadow.

Default: Undefined. Behaves as if transparent.

  • 3.3
  • 3.3
Determines the offset for the shadow of the view. ...

Determines the offset for the shadow of the view.

Default: Undefined. Behaves as if set to (0,-3)

  • 3.3
  • 3.3
Determines the blur radius used to create the shadow. ...

Determines the blur radius used to create the shadow.

Default: Undefined. Behaves as if set to 3.

  • 3.3
  • 3.3
Determines whether the view is visible. ...

Determines whether the view is visible.

Default: true

width : Number/String

View's width, in platform-specific units.

View's width, in platform-specific units.

Defaults to: If undefined, defaults to either Titanium.UI.FILL or Titanium.UI.SIZE depending on the view. See "View Types and Default Layout Behavior" in Transitioning to the New UI Layout System.

Can be either a float value or a dimension string (for example, '50%' or '40dp'). Can also be one of the following special values:

  • Titanium.UI.SIZE. The view should size itself to fit its contents.
  • Titanium.UI.FILL. The view should size itself to fill its parent.
  • 'auto'. Represents the default sizing behavior for a given type of view. The use of 'auto' is deprecated, and should be replaced with the SIZE or FILL constants if it is necessary to set the view's behavior explicitly.

On Mobile Web and Tizen, 'auto' always selects SIZE behavior.

This is an input property for specifying the view's width dimension. To determine the view's size once rendered, use the rect or size properties.

This property can be assigned the following constants:

Titanium.UI.iOS.NavigationWindow
window : Titanium.UI.WindowCreation-Only

Window to add to this navigation group.

Window to add to this navigation group.

Z-index stack order position, relative to other sibling views. ...

Z-index stack order position, relative to other sibling views.

A view does not have a default z-index value, meaning that it is undefined by default. When this property is explicitly set, regardless of its value, it causes the view to be positioned in front of any sibling that has an undefined z-index.

Defined By

Methods

( view ) : void
Adds a child to this view's hierarchy. ...

Adds a child to this view's hierarchy.

The child view is added as the last child in this view's hierarchy.

Although all views inherit from Titanium.UI.View, not all views are capable of containing other views. In particular:

  • Some views are not designed to be containers at all.
  • Some views are special-purpose containers that can only contain certain other views.
  • Some views are top-level containers that cannot (or should not) be added to other views.

Non-Container Views

The following views are not intended to act as containers that can hold other views:

Adding children to the these views may be supported on some platforms, but is not guaranteed to work across platforms. Where it is supported, it may not work as expected.

For maximum portability, these views should be treated as if they do not support children.
Instead of adding children to these views, applications can positon other views as siblings. For example, instead of adding a button as a child of a WebView, you can add the button to the web view's parent such that it appears on top of the web view.

Special-Purpose Containers

A few view objects act as special-purpose containers--that is, they only manage certain types of children, and many of them support a special means of adding these children, instead of the general add method. These containers include:

  • ButtonBar and TabbedBar are designed to hold their own internally-created buttons, assigned by adding strings to the "labels" array. Views added using the add method are displayed on top of these buttons.

  • Picker. Can only hold PickerRows and PickerColumns, which are added using the add method. Adding other types of views to a Picker is not supported.

  • TableView is a specialized container for TableViewSection and TableViewRow objects. These objects must be added using the properties and methods that TableView provides for adding and removing sectons and rows.

    On some platforms, it is possible to add arbitrary child views to a table view using the add method. However, this is not guaranteed to work on all platforms, and in general, should be avoided.

  • TableViewSection is a specialized container for TableViewRow objects, which are added using the add method. The add method on TableViewSection can only be used to add TableViewRow objects.

  • Toolbar is designed to hold buttons and certain other controls, added to its items array. Views added using the add method are displayed on top of the controls in the items array.

  • The Tab, TabGroup, NavigationGroup, NavigationWindow and SplitWindow objects are special containers that manage windows. These are discussed in the "Top-Level Containers" section.

Top-Level Containers

There are certain top-level containers that are not intended to be added as the children of other views. These top-level containers include Titanium.UI.Window, Titanium.UI.iPad.SplitWindow, Titanium.UI.iOS.NavigationWindow, and Titanium.UI.TabGroup. Other types of views must be added to a top-level container in order to be displayed on screen.

The special containers Titanium.UI.MobileWeb.NavigationGroup, Titanium.UI.iOS.NavigationWindow, Titanium.UI.iPad.SplitWindow, Titanium.UI.Tab, and Titanium.UI.TabGroup manage windows. These managed windows may be referred to as children of the container, but they are not added using the add method.

Note that although a NavigationGroup manages windows, it is not itself a top-level container. It must be added to a Window in order to be displayed.

Tab is another kind of special container: it is not itself a top-level container, but can only be used within a TabGroup. You cannot add a Tab to an arbitrary container.

Parameters

Returns

  • void
( name, callback ) : void
Adds the specified callback as an event listener for the named event. ...

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

Parameters

  • name : String

    Name of the event.

  • callback : Callback<Object>

    Callback function to invoke when the event is fired.

Returns

  • void
( animation, callback ) : void
Animates this view. ...

Animates this view.

The Animation object or dictionary passed to this method defines the end state for the animation, the duration of the animation, and other properties.

Note that if you use animate to move a view, the view's actual position is changed, but its layout properties, such as top, left, center and so on are not changed--these reflect the original values set by the user, not the actual position of the view.

The rect property can be used to determine the actual size and position of the view. Note that on Mobile Web and Tizen, the rect property is not updated after animation. This is a known issue TIMOB-8930.

Parameters

Returns

  • void
Applies the properties to the proxy. ...

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.

  • 3.0
  • 3.3
  • 3.0
  • 3.0
  • 3.0
  • 3.1

Parameters

  • props : Dictionary

    A dictionary of properties to apply.

Returns

  • void
( [params] ) : void
Closes the window. ...

Closes the window.

Android only supports the argument type closeWindowParams.

Parameters

Returns

  • void
Titanium.UI.iOS.NavigationWindow
( window, options ) : void
Closes a window and removes it from the navigation group. ...

Closes a window and removes it from the navigation group.

Parameters

  • window : Titanium.UI.Window

    Window to close.

  • options : Dictionary

    Options supporting a single animated boolean property to determine whether the window will be animated (default) while being closed.

Returns

  • void
( point, destinationView ) : Point
Translates a point from this view's coordinate system to another view's coordinate system. ...

Translates a point from this view's coordinate system to another view's coordinate system.

Returns null if either view is not in the view hierarchy.

Keep in mind that views may be removed from the view hierarchy if their window is blurred or if the view is offscreen (such as in some situations with Titanium.UI.ScrollableView).

If this view is a Titanium.UI.ScrollView, the view's x and y offsets are subtracted from the return value.

  • 1.8
  • 1.8
  • 1.8
  • 2.0
  • 3.1

Parameters

  • point : Point

    A point in this view's coordinate system.

    If this argument is missing an x or y property, or the properties can not be converted into numbers, an exception will be raised.

  • destinationView : Titanium.UI.View

    View that specifies the destination coordinate system to convert to. If this argument is not a view, an exception will be raised.

Returns

( ) : voiddeprecated
Finishes a batch update of the View's layout properties and schedules a layout pass of the view tree. ...

Finishes a batch update of the View's layout properties and schedules a layout pass of the view tree.

deprecated since 3.0.0

Use the applyProperties method to batch-update layout properties.

Since the layout pass scheduled is asynchronous, the rect and size values may not be available immediately after finishLayout is called.

To be notified when the layout pass completes, add a listener for the postlayout event.

On Mobile Web and Tizen, this method has no effect, but is included for parity.

  • 2.0
  • 3.1.2
  • 2.0
  • 2.0
  • 2.0
  • 3.1

Returns

  • void
( name, event ) : void
Fires a synthesized event to any registered listeners. ...

Fires a synthesized event to any registered listeners.

Parameters

  • 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

  • void
Gets the value of the accessibilityHidden property. ...

Gets the value of the accessibilityHidden property.

  • 3.0
  • 3.0
  • 3.0

Returns

  • Boolean
Gets the value of the accessibilityHint property. ...

Gets the value of the accessibilityHint property.

  • 3.0
  • 3.0
  • 3.0

Returns

  • String
Gets the value of the accessibilityLabel property. ...

Gets the value of the accessibilityLabel property.

  • 3.0
  • 3.0
  • 3.0

Returns

  • String
Gets the value of the accessibilityValue property. ...

Gets the value of the accessibilityValue property.

  • 3.0
  • 3.0
  • 3.0

Returns

  • String
Gets the value of the anchorPoint property. ...

Gets the value of the anchorPoint property.

  • 0.9
  • 0.9

Returns

Gets the value of the animatedCenter property. ...

Gets the value of the animatedCenter property.

  • 0.9
  • 0.9

Returns

Gets the value of the apiName property. ...

Gets the value of the apiName property.

  • 3.2
  • 3.2
  • 3.2
  • 3.2
  • 3.2
  • 3.2

Returns

  • String
Gets the value of the autoAdjustScrollViewInsets property. ...

Gets the value of the autoAdjustScrollViewInsets property.

  • 3.1.3
  • 3.1.3

Returns

  • Boolean
Gets the value of the backgroundColor property. ...

Gets the value of the backgroundColor property.

Returns

  • String

Overrides: Titanium.UI.View.getBackgroundColor

Gets the value of the backgroundGradient property. ...

Gets the value of the backgroundGradient property.

  • 0.9
  • 0.9
  • 1.8
  • 3.1
  • 0.9

Returns

Gets the value of the backgroundImage property. ...

Gets the value of the backgroundImage property.

Returns

  • String
Gets the value of the backgroundLeftCap property. ...

Gets the value of the backgroundLeftCap property.

  • 0.9
  • 0.9

Returns

  • Number
Gets the value of the backgroundRepeat property. ...

Gets the value of the backgroundRepeat property.

  • 0.9
  • 0.9
  • 0.9

Returns

  • Boolean
Gets the value of the backgroundTopCap property. ...

Gets the value of the backgroundTopCap property.

  • 0.9
  • 0.9

Returns

  • Number
Gets the value of the borderColor property. ...

Gets the value of the borderColor property.

  • 0.9
  • 0.9
  • 0.9
  • 1.8
  • 3.1

Returns

  • String
Gets the value of the borderRadius property. ...

Gets the value of the borderRadius property.

  • 0.9
  • 0.9
  • 0.9
  • 1.8
  • 3.1

Returns

  • Number
Gets the value of the borderWidth property. ...

Gets the value of the borderWidth property.

  • 0.9
  • 0.9
  • 0.9
  • 1.8
  • 3.1

Returns

  • Number
( ) : Number/String
Gets the value of the bottom property. ...

Gets the value of the bottom property.

Returns

  • Number/String

Overrides: Titanium.UI.View.getBottom

Gets the value of the bubbleParent property. ...

Gets the value of the bubbleParent property.

  • 3.0
  • 3.0
  • 3.0

Returns

  • Boolean
Gets the value of the center property. ...

Gets the value of the center property.

  • 0.9
  • 0.9
  • 0.9
  • 1.8
  • 3.1

Returns

Gets the value of the children property. ...

Gets the value of the children property.

Returns

Gets the value of the clipMode property. ...

Gets the value of the clipMode property.

  • 3.3
  • 3.3

Returns

  • Number
Gets the value of the extendEdges property. ...

Gets the value of the extendEdges property.

  • 3.1.3
  • 3.1.3

Returns

  • Number[]
Gets the value of the fullscreen property. ...

Gets the value of the fullscreen property.

  • 0.9
  • 0.9
  • 0.9

Returns

  • Boolean
( ) : Number/String
Gets the value of the height property. ...

Gets the value of the height property.

Returns

  • Number/String
Gets the value of the horizontalWrap property. ...

Gets the value of the horizontalWrap property.

  • 2.1
  • 2.1
  • 2.1
  • 2.1
  • 3.1

Returns

  • Boolean
Gets the value of the includeOpaqueBars property. ...

Gets the value of the includeOpaqueBars property.

  • 3.1.3
  • 3.1.3

Returns

  • Boolean
Gets the value of the layout property. ...

Gets the value of the layout property.

Returns

  • String
( ) : Number/String
Gets the value of the left property. ...

Gets the value of the left property.

Returns

  • Number/String

Overrides: Titanium.UI.View.getLeft

Gets the value of the leftNavButtons property. ...

Gets the value of the leftNavButtons property.

  • 3.3
  • 3.3

Returns

Gets the value of the modal property. ...

Gets the value of the modal property.

Returns

  • Boolean
Gets the value of the opacity property. ...

Gets the value of the opacity property.

Returns

  • Number

Overrides: Titanium.UI.View.getOpacity

Gets the value of the orientation property. ...

Gets the value of the orientation property.

  • 0.9
  • 0.9
  • 0.9

Returns

  • Number
Gets the value of the orientationModes property. ...

Gets the value of the orientationModes property.

  • 0.9
  • 0.9
  • 0.9

Returns

  • Number[]
Gets the value of the pullBackgroundColor property. ...

Gets the value of the pullBackgroundColor property.

  • 3.3
  • 3.3

Returns

  • String
Gets the value of the rect property. ...

Gets the value of the rect property.

  • 2.0
  • 2.0
  • 2.0
  • 2.0
  • 3.1

Returns

( ) : Number/String
Gets the value of the right property. ...

Gets the value of the right property.

Returns

  • Number/String

Overrides: Titanium.UI.View.getRight

Gets the value of the rightNavButtons property. ...

Gets the value of the rightNavButtons property.

  • 3.3
  • 3.3

Returns

Gets the value of the size property. ...

Gets the value of the size property.

  • 0.9
  • 0.9
  • 0.9
  • 1.8
  • 3.1

Returns

Gets the value of the statusBarStyle property. ...

Gets the value of the statusBarStyle property.

  • 3.1.3
  • 3.1.3

Returns

  • Number
Gets the value of the tintColor property. ...

Gets the value of the tintColor property.

  • 3.1.3
  • 3.1.3

Returns

  • String
Gets the value of the titleAttributes property. ...

Gets the value of the titleAttributes property.

  • 3.2
  • 3.2

Returns

( ) : Number/String
Gets the value of the top property. ...

Gets the value of the top property.

Returns

  • Number/String

Overrides: Titanium.UI.View.getTop

Gets the value of the touchEnabled property. ...

Gets the value of the touchEnabled property.

Returns

  • Boolean
Gets the value of the transform property. ...

Gets the value of the transform property.

  • 0.9
  • 0.9
  • 0.9
  • 1.8
  • 3.1

Returns

Gets the value of the viewShadowColor property. ...

Gets the value of the viewShadowColor property.

  • 3.3
  • 3.3

Returns

  • String
Gets the value of the viewShadowOffset property. ...

Gets the value of the viewShadowOffset property.

  • 3.3
  • 3.3

Returns

Gets the value of the viewShadowRadius property. ...

Gets the value of the viewShadowRadius property.

  • 3.3
  • 3.3

Returns

  • Number
Gets the value of the visible property. ...

Gets the value of the visible property.

Returns

  • Boolean
( ) : Number/String
Gets the value of the width property. ...

Gets the value of the width property.

Returns

  • Number/String
Titanium.UI.iOS.NavigationWindow
( ) : Titanium.UI.Window
Gets the value of the window property. ...

Gets the value of the window property.

Returns

Gets the value of the zIndex property. ...

Gets the value of the zIndex property.

Returns

  • Number
Hides this view. ...

Hides this view.

Returns

  • void
( [options] ) : void
Hides the navigation bar. ...

Hides the navigation bar.

If the window is not displayed in a Titanium.UI.iOS.NavigationWindow, this method has no effect.

  • 0.9
  • 0.9

Parameters

  • options : Dictionary (optional)

    Options dictionary supporting a single animated boolean property to determine whether the navigation bar will be animated (default) while being hidden.

Returns

  • void
( [params] ) : void
Opens the window. ...

Opens the window.

Parameters

  • params : openWindowParams (optional)

    Animation or display properties to use when opening the window.

Returns

  • void
Titanium.UI.iOS.NavigationWindow
( window, options ) : void
Opens a window within the navigation group. ...

Opens a window within the navigation group.

Parameters

  • window : Titanium.UI.Window

    Window to open.

  • options : Dictionary

    Options supporting a single animated boolean property to determine whether the window will be animated (default) while being opened.

Returns

  • void
( view ) : void
Removes a child view from this view's hierarchy. ...

Removes a child view from this view's hierarchy.

Parameters

Returns

  • void
( name, callback ) : void
Removes the specified callback as an event listener for the named event. ...

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 : String

    Name of the event.

  • callback : Callback<Object>

    Callback function to remove. Must be the same function passed to addEventListener.

Returns

  • void
( accessibilityHidden ) : void
Sets the value of the accessibilityHidden property. ...

Sets the value of the accessibilityHidden property.

  • 3.0
  • 3.0
  • 3.0

Parameters

  • accessibilityHidden : Boolean

    New value for the property.

Returns

  • void
( accessibilityHint ) : void
Sets the value of the accessibilityHint property. ...

Sets the value of the accessibilityHint property.

  • 3.0
  • 3.0
  • 3.0

Parameters

  • accessibilityHint : String

    New value for the property.

Returns

  • void
( accessibilityLabel ) : void
Sets the value of the accessibilityLabel property. ...

Sets the value of the accessibilityLabel property.

  • 3.0
  • 3.0
  • 3.0

Parameters

  • accessibilityLabel : String

    New value for the property.

Returns

  • void
( accessibilityValue ) : void
Sets the value of the accessibilityValue property. ...

Sets the value of the accessibilityValue property.

  • 3.0
  • 3.0
  • 3.0

Parameters

  • accessibilityValue : String

    New value for the property.

Returns

  • void
( anchorPoint ) : void
Sets the value of the anchorPoint property. ...

Sets the value of the anchorPoint property.

  • 0.9
  • 0.9

Parameters

  • anchorPoint : Point

    New value for the property.

Returns

  • void
( autoAdjustScrollViewInsets ) : void
Sets the value of the autoAdjustScrollViewInsets property. ...

Sets the value of the autoAdjustScrollViewInsets property.

  • 3.1.3
  • 3.1.3

Parameters

  • autoAdjustScrollViewInsets : Boolean

    New value for the property.

Returns

  • void
( backgroundColor ) : void
Sets the value of the backgroundColor property. ...

Sets the value of the backgroundColor property.

Parameters

  • backgroundColor : String

    New value for the property.

Returns

  • void

Overrides: Titanium.UI.View.setBackgroundColor

( backgroundGradient ) : void
Sets the value of the backgroundGradient property. ...

Sets the value of the backgroundGradient property.

  • 0.9
  • 0.9
  • 1.8
  • 3.1
  • 0.9

Parameters

  • backgroundGradient : Gradient

    New value for the property.

Returns

  • void
( backgroundImage ) : void
Sets the value of the backgroundImage property. ...

Sets the value of the backgroundImage property.

Parameters

  • backgroundImage : String

    New value for the property.

Returns

  • void
( backgroundLeftCap ) : void
Sets the value of the backgroundLeftCap property. ...

Sets the value of the backgroundLeftCap property.

  • 0.9
  • 0.9

Parameters

  • backgroundLeftCap : Number

    New value for the property.

Returns

  • void
( backgroundRepeat ) : void
Sets the value of the backgroundRepeat property. ...

Sets the value of the backgroundRepeat property.

  • 0.9
  • 0.9
  • 0.9

Parameters

  • backgroundRepeat : Boolean

    New value for the property.

Returns

  • void
( backgroundTopCap ) : void
Sets the value of the backgroundTopCap property. ...

Sets the value of the backgroundTopCap property.

  • 0.9
  • 0.9

Parameters

  • backgroundTopCap : Number

    New value for the property.

Returns

  • void
( borderColor ) : void
Sets the value of the borderColor property. ...

Sets the value of the borderColor property.

  • 0.9
  • 0.9
  • 0.9
  • 1.8
  • 3.1

Parameters

  • borderColor : String

    New value for the property.

Returns

  • void
( borderRadius ) : void
Sets the value of the borderRadius property. ...

Sets the value of the borderRadius property.

  • 0.9
  • 0.9
  • 0.9
  • 1.8
  • 3.1

Parameters

  • borderRadius : Number

    New value for the property.

Returns

  • void
( borderWidth ) : void
Sets the value of the borderWidth property. ...

Sets the value of the borderWidth property.

  • 0.9
  • 0.9
  • 0.9
  • 1.8
  • 3.1

Parameters

  • borderWidth : Number

    New value for the property.

Returns

  • void
Sets the value of the bottom property. ...

Sets the value of the bottom property.

Parameters

  • bottom : Number/String

    New value for the property.

Returns

  • void

Overrides: Titanium.UI.View.setBottom

( bubbleParent ) : void
Sets the value of the bubbleParent property. ...

Sets the value of the bubbleParent property.

  • 3.0
  • 3.0
  • 3.0

Parameters

  • bubbleParent : Boolean

    New value for the property.

Returns

  • void
( center ) : void
Sets the value of the center property. ...

Sets the value of the center property.

  • 0.9
  • 0.9
  • 0.9
  • 1.8
  • 3.1

Parameters

  • center : Point

    New value for the property.

Returns

  • void
( clipMode ) : void
Sets the value of the clipMode property. ...

Sets the value of the clipMode property.

  • 3.3
  • 3.3

Parameters

  • clipMode : Number

    New value for the property.

Returns

  • void
( extendEdges ) : void
Sets the value of the extendEdges property. ...

Sets the value of the extendEdges property.

  • 3.1.3
  • 3.1.3

Parameters

  • extendEdges : Number[]

    New value for the property.

Returns

  • void
( fullscreen ) : void
Sets the value of the fullscreen property. ...

Sets the value of the fullscreen property.

  • 0.9
  • 0.9
  • 0.9

Parameters

  • fullscreen : Boolean

    New value for the property.

Returns

  • void
( height ) : void
Sets the value of the height property. ...

Sets the value of the height property.

Parameters

  • height : Number/String

    New value for the property.

Returns

  • void
( horizontalWrap ) : void
Sets the value of the horizontalWrap property. ...

Sets the value of the horizontalWrap property.

  • 2.1
  • 2.1
  • 2.1
  • 2.1
  • 3.1

Parameters

  • horizontalWrap : Boolean

    New value for the property.

Returns

  • void
( includeOpaqueBars ) : void
Sets the value of the includeOpaqueBars property. ...

Sets the value of the includeOpaqueBars property.

  • 3.1.3
  • 3.1.3

Parameters

  • includeOpaqueBars : Boolean

    New value for the property.

Returns

  • void
( layout ) : void
Sets the value of the layout property. ...

Sets the value of the layout property.

Parameters

  • layout : String

    New value for the property.

Returns

  • void
Sets the value of the left property. ...

Sets the value of the left property.

Parameters

  • left : Number/String

    New value for the property.

Returns

  • void

Overrides: Titanium.UI.View.setLeft

( leftNavButtons ) : void
Sets the value of the leftNavButtons property. ...

Sets the value of the leftNavButtons property.

  • 3.3
  • 3.3

Parameters

Returns

  • void
Sets the value of the modal property. ...

Sets the value of the modal property.

Parameters

  • modal : Boolean

    New value for the property.

Returns

  • void
Sets the value of the opacity property. ...

Sets the value of the opacity property.

Parameters

  • opacity : Number

    New value for the property.

Returns

  • void

Overrides: Titanium.UI.View.setOpacity

( orientationModes ) : void
Sets the value of the orientationModes property. ...

Sets the value of the orientationModes property.

  • 0.9
  • 0.9
  • 0.9

Parameters

  • orientationModes : Number[]

    New value for the property.

Returns

  • void
( pullBackgroundColor ) : void
Sets the value of the pullBackgroundColor property. ...

Sets the value of the pullBackgroundColor property.

  • 3.3
  • 3.3

Parameters

  • pullBackgroundColor : String

    New value for the property.

Returns

  • void
Sets the value of the right property. ...

Sets the value of the right property.

Parameters

  • right : Number/String

    New value for the property.

Returns

  • void

Overrides: Titanium.UI.View.setRight

( rightNavButtons ) : void
Sets the value of the rightNavButtons property. ...

Sets the value of the rightNavButtons property.

  • 3.3
  • 3.3

Parameters

Returns

  • void
( statusBarStyle ) : void
Sets the value of the statusBarStyle property. ...

Sets the value of the statusBarStyle property.

  • 3.1.3
  • 3.1.3

Parameters

  • statusBarStyle : Number

    New value for the property.

Returns

  • void
( tintColor ) : void
Sets the value of the tintColor property. ...

Sets the value of the tintColor property.

  • 3.1.3
  • 3.1.3

Parameters

  • tintColor : String

    New value for the property.

Returns

  • void
( titleAttributes ) : void
Sets the value of the titleAttributes property. ...

Sets the value of the titleAttributes property.

  • 3.2
  • 3.2

Parameters

Returns

  • void
Sets the value of the top property. ...

Sets the value of the top property.

Parameters

  • top : Number/String

    New value for the property.

Returns

  • void

Overrides: Titanium.UI.View.setTop

( touchEnabled ) : void
Sets the value of the touchEnabled property. ...

Sets the value of the touchEnabled property.

Parameters

  • touchEnabled : Boolean

    New value for the property.

Returns

  • void
( transform ) : void
Sets the value of the transform property. ...

Sets the value of the transform property.

  • 0.9
  • 0.9
  • 0.9
  • 1.8
  • 3.1

Parameters

Returns

  • void
( viewShadowColor ) : void
Sets the value of the viewShadowColor property. ...

Sets the value of the viewShadowColor property.

  • 3.3
  • 3.3

Parameters

  • viewShadowColor : String

    New value for the property.

Returns

  • void
( viewShadowOffset ) : void
Sets the value of the viewShadowOffset property. ...

Sets the value of the viewShadowOffset property.

  • 3.3
  • 3.3

Parameters

  • viewShadowOffset : Point

    New value for the property.

Returns

  • void
( viewShadowRadius ) : void
Sets the value of the viewShadowRadius property. ...

Sets the value of the viewShadowRadius property.

  • 3.3
  • 3.3

Parameters

  • viewShadowRadius : Number

    New value for the property.

Returns

  • void
( visible ) : void
Sets the value of the visible property. ...

Sets the value of the visible property.

Parameters

  • visible : Boolean

    New value for the property.

Returns

  • void
( width ) : void
Sets the value of the width property. ...

Sets the value of the width property.

Parameters

  • width : Number/String

    New value for the property.

Returns

  • void
( zIndex ) : void
Sets the value of the zIndex property. ...

Sets the value of the zIndex property.

Parameters

  • zIndex : Number

    New value for the property.

Returns

  • void
Makes this view visible. ...

Makes this view visible.

Returns

  • void
( [options] ) : void
Makes the navigation bar visible. ...

Makes the navigation bar visible.

If the window is not displayed in a Titanium.UI.iOS.NavigationWindow, this method has no effect.

  • 0.9
  • 0.9

Parameters

  • options : Dictionary (optional)

    Options dictionary supporting a single animated boolean property to determine whether the navigation bar will be animated (default) while being shown.

Returns

  • void
( ) : voiddeprecated
Starts a batch update of this view's layout properties. ...

Starts a batch update of this view's layout properties.

deprecated since 3.0.0

Use the applyProperties method to batch-update layout properties.

To prevent a layout pass each time a property is modified, call startLayout before changing any properties that may change this view's layout. This initiates a batch update mode where layout changes are deferred.

Call finishLayout to end batch update mode and trigger a layout pass. For example:

view.startLayout();
view.top = 50;
view.left = 50;
view.finishLayout();

Note that any property changes made during the batch update may be deferred until finishLayout is called. This may vary somewhat by platform. For example, changing the text of a label may trigger a layout pass. In iOS, updating the label text is deferred, while on Mobile Web and Tizen, the label text is updated immediately but the control is not resized until finishLayout is called.

See also: updateLayout, finishLayout, postlayout event.

On Mobile Web and Tizen, this method is included for parity only, and thus has no effect.

  • 2.0
  • 3.1.2
  • 2.0
  • 2.0
  • 2.0
  • 3.1

Returns

  • void
( [callback], [honorScaleFactor] ) : Titanium.Blob
Returns an image of the rendered view, as a Blob. ...

Returns an image of the rendered view, as a Blob.

The honorScaleFactor method is only supported on iOS.

  • 0.9
  • 0.9
  • 0.9

Parameters

  • callback : Callback<Titanium.Blob> (optional)

    Function to be invoked upon completion. If non-null, this method will be performed asynchronously. If null, it will be performed immediately. On Tizen, this function is asynchronous only. The callback is mandatory and function always returns "undefined".

  • honorScaleFactor : Boolean (optional)

    Determines whether the image is scaled based on scale factor of main screen. (iOS only)

    When set to true, image is scale factor is honored. When set to false, the image in the blob has the same dimensions for retina and non-retina devices.

    Default: False

Returns

( params ) : voiddeprecated
Performs a batch update of all supplied layout properties and schedules a layout pass after they have been updated. ...

Performs a batch update of all supplied layout properties and schedules a layout pass after they have been updated.

deprecated since 3.0.0

Use the applyProperties method to batch-update layout properties.

This is another way to perform a batch update. The updateLayout method is called with a dictionary of layout properties to perform the batch update. For example:

view.updateLayout({top:50, left:50});

This is equivalent to the following:

view.startLayout();
view.top = 50;
view.left = 50;
view.finishLayout();

See also: startLayout, finishLayout, postlayout event.

On Mobile Web and Tizen, this method is included for parity only, and thus has no effect.

  • 2.0
  • 3.1.2
  • 2.0
  • 2.0
  • 2.0
  • 3.1

Parameters

  • params : Dictionary

    Layout properties to be updated.

Returns

  • void
Defined By

Events

Fired when the window loses focus. ...

Fired when the window loses focus.

On Android, this event also fires before putting the activity in the background (before the activity enters the pause state).

On iOS, this event does not fire before putting the application in the background. The application needs to monitor the Titanium.App.pause event. See Titanium.App for more information on the iOS application lifecycle.

Properties

  • bubbles : Boolean

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

    •  
    •  
    •  
  • cancelBubble : Boolean

    Set to true to stop the event from bubbling.

    •  
    •  
    •  
  • source : Object

    Source object that fired the event.

  • type : String

    Name of the event fired.

Fired when the device detects a click against the view. ...

Fired when the device detects a click against the view.

There is a subtle difference between singletap and click events.

A singletap event is generated when the user taps the screen briefly without moving their finger. This gesture will also generate a click event.

However, a click event can also be generated when the user touches, moves their finger, and then removes it from the screen.

On Android, a click event can also be generated by a trackball click.

Properties

  • bubbles : Boolean

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

    •  
    •  
    •  
  • cancelBubble : Boolean

    Set to true to stop the event from bubbling.

    •  
    •  
    •  
  • source : Object

    Source object that fired the event.

  • type : String

    Name of the event fired.

  • x : Number

    X coordinate of the event from the source view's coordinate system.

  • y : Number

    Y coordinate of the event from the source view's coordinate system.

Fired when the window is closed. ...

Fired when the window is closed.

Properties

  • bubbles : Boolean

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

    •  
    •  
    •  
  • cancelBubble : Boolean

    Set to true to stop the event from bubbling.

    •  
    •  
    •  
  • source : Object

    Source object that fired the event.

  • type : String

    Name of the event fired.

Fired when the device detects a double click against the view. ...

Fired when the device detects a double click against the view.

  • 0.9
  • 0.9
  • 0.9
  • 1.8
  • 3.1

Properties

  • bubbles : Boolean

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

    •  
    •  
    •  
  • cancelBubble : Boolean

    Set to true to stop the event from bubbling.

    •  
    •  
    •  
  • source : Object

    Source object that fired the event.

  • type : String

    Name of the event fired.

  • x : Number

    X coordinate of the event from the source view's coordinate system.

  • y : Number

    Y coordinate of the event from the source view's coordinate system.

Fired when the device detects a double tap against the view. ...

Fired when the device detects a double tap against the view.

  • 0.9
  • 0.9
  • 0.9

Properties

  • bubbles : Boolean

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

    •  
    •  
    •  
  • cancelBubble : Boolean

    Set to true to stop the event from bubbling.

    •  
    •  
    •  
  • source : Object

    Source object that fired the event.

  • type : String

    Name of the event fired.

  • x : Number

    X coordinate of the event from the source view's coordinate system.

  • y : Number

    Y coordinate of the event from the source view's coordinate system.

Fired when the window gains focus. ...

Fired when the window gains focus.

The listener for this event must be defined before this window is opened.

On Android, this event also fires when the activity enters the foreground (after the activity enters the resume state).

On iOS, this event does not fire after the application returns to the foreground if it was previously backgrounded. The application needs to monitor the Titanium.App.resumed event. See Titanium.App for more information on the iOS application lifecycle.

  • 0.9
  • 3.1.2
  • 0.9
  • 0.9
  • 1.8
  • 3.1

Properties

  • bubbles : Boolean

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

    •  
    •  
    •  
  • cancelBubble : Boolean

    Set to true to stop the event from bubbling.

    •  
    •  
    •  
  • source : Object

    Source object that fired the event.

  • type : String

    Name of the event fired.

Overrides: Titanium.UI.View.focus

Fired when the device detects a long press. ...

Fired when the device detects a long press.

A long press is generated by touching and holding on the touchscreen. Unlike a longclick, it does not respond to the trackball button.

The event occurs before the finger is lifted.

A longpress and a longclick can occur together.

In contrast to a longclick, this event returns the x and y coordinates of the touch.

  • 0.9
  • 0.9
  • 0.9
  • 1.8
  • 3.1

Properties

  • bubbles : Boolean

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

    •  
    •  
    •  
  • cancelBubble : Boolean

    Set to true to stop the event from bubbling.

    •  
    •  
    •  
  • source : Object

    Source object that fired the event.

  • type : String

    Name of the event fired.

  • x : Number

    X coordinate of the event from the source view's coordinate system.

  • y : Number

    Y coordinate of the event from the source view's coordinate system.

Fired when the window is opened. ...

Fired when the window is opened.

The listener for this event must be defined before this window is opened.

Properties

  • bubbles : Boolean

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

    •  
    •  
    •  
  • cancelBubble : Boolean

    Set to true to stop the event from bubbling.

    •  
    •  
    •  
  • source : Object

    Source object that fired the event.

  • type : String

    Name of the event fired.

Fired when the device detects a pinch gesture. ...

Fired when the device detects a pinch gesture.

A pinch is a touch and expand or contract with two fingers. The event occurs continuously until a finger is lifted again.

  • 1.8
  • 1.8

Properties

  • bubbles : Boolean

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

    •  
    •  
    •  
  • cancelBubble : Boolean

    Set to true to stop the event from bubbling.

    •  
    •  
    •  
  • scale : Number

    The scale factor relative to the points of the two touches in screen coordinates.

  • source : Object

    Source object that fired the event.

  • type : String

    Name of the event fired.

  • velocity : Number

    The velocity of the pinch in scale factor per second.

Fired when a layout cycle is finished. ...

Fired when a layout cycle is finished.

This event is fired when the view and its ancestors have been laid out. The rect and size values should be usable when this event is fired.

This event is typically triggered by either changing layout properties or by changing the orientation of the device. Note that changing the layout of child views or ancestors can also trigger a relayout of this view. On Mobile Web, this event can also be triggered by resizing the browser window.

Note that altering any properties that affect layout from the postlayout callback may result in an endless loop.

  • 2.0
  • 3.1.2
  • 2.0
  • 2.0
  • 2.0
  • 3.1

Properties

  • bubbles : Boolean

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

    •  
    •  
    •  
  • cancelBubble : Boolean

    Set to true to stop the event from bubbling.

    •  
    •  
    •  
  • source : Object

    Source object that fired the event.

  • type : String

    Name of the event fired.

Fired when the device detects a single tap against the view. ...

Fired when the device detects a single tap against the view.

Properties

  • bubbles : Boolean

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

    •  
    •  
    •  
  • cancelBubble : Boolean

    Set to true to stop the event from bubbling.

    •  
    •  
    •  
  • source : Object

    Source object that fired the event.

  • type : String

    Name of the event fired.

  • x : Number

    X coordinate of the event from the source view's coordinate system.

  • y : Number

    Y coordinate of the event from the source view's coordinate system.

Fired when the device detects a swipe gesture against the view. ...

Fired when the device detects a swipe gesture against the view.

  • 0.9
  • 0.9
  • 0.9
  • 1.8
  • 3.1

Properties

  • bubbles : Boolean

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

    •  
    •  
    •  
  • cancelBubble : Boolean

    Set to true to stop the event from bubbling.

    •  
    •  
    •  
  • direction : String

    Direction of the swipe--either 'left', 'right', 'up', or 'down'.

  • source : Object

    Source object that fired the event.

  • type : String

    Name of the event fired.

  • x : Number

    X coordinate of the event's endpoint from the source view's coordinate system.

  • y : Number

    Y coordinate of the event's endpoint from the source view's coordinate system.

Fired when a touch event is interrupted by the device. ...

Fired when a touch event is interrupted by the device.

A touchcancel can happen in circumstances such as an incoming call to allow the UI to clean up state.

Properties

  • bubbles : Boolean

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

    •  
    •  
    •  
  • cancelBubble : Boolean

    Set to true to stop the event from bubbling.

    •  
    •  
    •  
  • source : Object

    Source object that fired the event.

  • type : String

    Name of the event fired.

  • x : Number

    X coordinate of the event from the source view's coordinate system.

  • y : Number

    Y coordinate of the event from the source view's coordinate system.

Fired when a touch event is completed. ...

Fired when a touch event is completed.

On the Android platform, other gesture events, such as longpress or swipe, cancel touch events, so this event may not be triggered after a touchstart event.

Properties

  • bubbles : Boolean

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

    •  
    •  
    •  
  • cancelBubble : Boolean

    Set to true to stop the event from bubbling.

    •  
    •  
    •  
  • source : Object

    Source object that fired the event.

  • type : String

    Name of the event fired.

  • x : Number

    X coordinate of the event from the source view's coordinate system.

  • y : Number

    Y coordinate of the event from the source view's coordinate system.

Fired as soon as the device detects movement of a touch. ...

Fired as soon as the device detects movement of a touch.

Event coordinates are always relative to the view in which the initial touch occurred

Properties

  • bubbles : Boolean

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

    •  
    •  
    •  
  • cancelBubble : Boolean

    Set to true to stop the event from bubbling.

    •  
    •  
    •  
  • source : Object

    Source object that fired the event.

  • type : String

    Name of the event fired.

  • x : Number

    X coordinate of the event from the source view's coordinate system.

  • y : Number

    Y coordinate of the event from the source view's coordinate system.

Fired as soon as the device detects a touch gesture. ...

Fired as soon as the device detects a touch gesture.

Properties

  • bubbles : Boolean

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

    •  
    •  
    •  
  • cancelBubble : Boolean

    Set to true to stop the event from bubbling.

    •  
    •  
    •  
  • source : Object

    Source object that fired the event.

  • type : String

    Name of the event fired.

  • x : Number

    X coordinate of the event from the source view's coordinate system.

  • y : Number

    Y coordinate of the event from the source view's coordinate system.

Fired when the device detects a two-finger tap against the view. ...

Fired when the device detects a two-finger tap against the view.

  • 3.0
  • 0.9
  • 0.9
  • 1.8
  • 3.1

Properties

  • bubbles : Boolean

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

    •  
    •  
    •  
  • cancelBubble : Boolean

    Set to true to stop the event from bubbling.

    •  
    •  
    •  
  • source : Object

    Source object that fired the event.

  • type : String

    Name of the event fired.

  • x : Number

    X coordinate of the event from the source view's coordinate system.

  • y : Number

    Y coordinate of the event from the source view's coordinate system.