A SplitWindow is a window that manages the presentation of two side-by-side view controllers.
This class replaces the deprecated Titanium.UI.iPad.SplitWindow class.
The masterView and detailView properties are required before the SplitWindow is opened.
You use this class to implement a master-detail interface, in which the left-side view presents
a list of items and the right-side presents details of the selected item. The SplitWindow is supported
for both iPhone and iPad idioms. Use the Titanium.UI.iOS.createSplitWindow method to create a SplitWindow object
By default, SplitWindow shows both master and detail views in landscape orientation. When the
device switches into portrait orientation, the master is only shown if showMasterInPortrait
is set to true.
The property masterIsOverlayed controls how the master is
displayed in portrait mode. When masterIsOverlayed is set to true, the detailView occupies the full screen
and and masterView is displayed overlayed on top to the left of the screen. When masterIsOverlayed is set
to false, the available screen width is split between the masterView and detailView.
The width of the masterView can be controlled by the portraitSplit and
landscapeSplit properties. These values are capped in the range 0.25 to 0.5.
Any values outside this range are ignored.
To add a navigation bar to either the master or detail view of the split window, use a Titanium.UI.iOS.NavigationWindow.
The SplitWindow is a top-level window and cannot be contained within another window or view.
This is an example of a Split Window.
var detail = Ti.UI.createWindow({backgroundColor: 'white'});
var label1 = Ti.UI.createLabel({text: 'Detail View'});
detail.add(label1);
var detailNav = Ti.UI.iOS.createNavigationWindow({window: detail});
var master = Ti.UI.createWindow({backgroundColor: 'gray'});
var label2 = Ti.UI.createLabel({text: 'Master View'});
master.add(label2);
var masterNav = Ti.UI.iOS.createNavigationWindow({window: master});
var splitWin = Ti.UI.iOS.createSplitWindow({
detailView: detailNav,
masterView: masterNav
});
splitWin.open();
Below is an Alloy version of the previous example. The first window is the masterView and the second window is the detailView. You can also use the <Require> element to add a <Window> or <NavigationWindow>.
**views/index.xml:**
<Alloy>
<SplitWindow backgroundColor="white" showMasterInPortrait="true">
<!-- First window is the masterView -->
<NavigationWindow>
<Window title="Master View">
<ListView>
<ListSection headerTitle="Some items">
<ListItem title="Item 1"></ListItem>
<ListItem title="Item 2"></ListItem>
<ListItem title="Item 3"></ListItem>
</ListSection>
</ListView>
</Window>
</NavigationWindow>
<!-- Second window is the detailView -->
<NavigationWindow>
<Window title="Detail View">
<Label>I am the detail view.</Label>
</Window>
</NavigationWindow>
</SplitWindow>
</Alloy>
*controllers/index.js:**
$.index.addEventListener('visible',function(e){
if (e.view == 'detail'){
e.button.title = "Master";
$.index.detailView.getWindow().leftNavButton = e.button;
} else if (e.view == 'master'){
$.index.detailView.getWindow().leftNavButton = null;
}
});
$.index.open();
Whether the view should be "hidden" from (i.e., ignored by) the accessibility service.
Requires: Android 4.0 and later iOS 5.0 and later
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
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.
Default:
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.
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.
For lightweight windows, this property returns undefined. For heavyweight windows, this property contains a reference to the Android Activity object associated with this window.
An Activity object is not created until the window is opened.
Before the window is opened, activity refers to an empty JavaScript object.
You can be set properties on this object, but cannot invoke any Activity methods on it.
Once the window is opened, the actual Activity object is created,
using any properties set on the JavaScript object. At this point, you can call methods
on the activity and access any properties that are set when the activity is created,
for example, actionBar.
The type of transition used when activity is entering.
Requires: Android 5 and later
Activity B's enter transition determines how views in B are animated when A starts B.
Applicable for Android 5.0 and above. This value will be ignored if animated is set to false or
there is no shared element between the participating activities.
See "Material design activity transitions in Android" in the main description of Titanium.UI.Window
for more information.
This API can be assigned the following constants:
Default: If not specified uses platform theme transition.
The type of transition used when activity is exiting.
Requires: Android 5 and later
Activity A's exit transition determines how views in A are animated when A starts B.
Applicable for Android 5.0 and above. This value will be ignored if animated is set to false or
there is no shared element between the participating activities.
See "Material design activity transitions in Android" in the main description of Titanium.UI.Window
for more information.
This API can be assigned the following constants:
Default: If not specified uses platform theme transition.
The type of transition used when reentering to a previously started activity.
Requires: Android 5 and later
Activity A's reenter transition determines how views in A are animated when B returns to A.
Applicable for Android 5.0 and above. This value will be ignored if animated is set to false or
there is no shared element between the participating activities.
See "Material design activity transitions in Android" in the main description of Titanium.UI.Window
for more information.
This API can be assigned the following constants:
Default: If not specified uses `activityExitTransition`.
The type of transition used when returning from a previously started activity.
Requires: Android 5 and later
Activity B's return transition determines how views in B are animated when B returns to A.
Applicable for Android 5.0 and above. This value will be ignored if animated is set to false or
there is no shared element between the participating activities.
See "Material design activity transitions in Android" in the main description of Titanium.UI.Window
for more information.
This API can be assigned the following constants:
Default: If not specified uses `activityEnterTransition`.
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.
Current position of the view during an animation.
Current position of the view during an animation.
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.
Specifies whether or not the view controller should automatically adjust its scroll view insets. Valid on iOS 7 and greater.
Requires: iOS 7.0 and later
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.
Title for the back button. This is only valid when the window is a child of a tab.
The image to show as the back button. This is only valid when the window is a child of a tab.
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
Disabled background 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.
Disabled background image for the view, specified as a local file path or URL.
Default: If `backgroundDisabledImage` is undefined, and the normal background image `backgroundImage` is set, the normal image is used when this view is disabled.
Focused background color of the view, as a color name or hex triplet.
For information about color values, see the "Colors" section of Titanium.UI.
For normal views, the focused color is only used if focusable is true.
Default: Same as the normal background color of this view.
Focused background image for the view, specified as a local file path or URL.
For normal views, the focused background is only used if focusable is true.
Default: If `backgroundFocusedImage` is undefined, and the normal background image `backgroundImage` is set, the normal image is used when this view is focused.
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 } ]
Android's linear gradients ignores backfillStart and backfillEnd, treating them as if
they are true. Android's radial gradients ignore the endPoint property.
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: 50,
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
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.
See the section on backgroundLeftCap and backgroundTopCap behavior on iOS in Titanium.UI.View.
Default: 0
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
Selected background color of the view, as a color name or hex triplet.
For information about color values, see the "Colors" section of Titanium.UI.
focusable must be true for normal views.
Default: Background color of this view.
Selected background image url for the view, specified as a local file path or URL.
For normal views, the selected background is only used if focusable is true.
Default: If `backgroundSelectedImage` is undefined, and the normal background image `backgroundImage` is set, the normal image is used when this view is selected.
Size of the top end cap.
See the section on backgroundLeftCap and backgroundTopCap behavior on iOS in Titanium.UI.View.
Default: 0
Background color for the nav bar, as a color name or hex triplet.
Background color for the nav bar, as a color name or hex triplet.
For information about color values, see the "Colors" section of Titanium.UI.
Background image for the nav bar, specified as a URL to a local image.
Background image for the nav bar, specified as a URL to a local image.
The behavior of this API on iOS has changed from version 3.2.0. Previous versions
of the SDK created a custom image view and inserted it as a child of the navigation bar.
The titanium sdk now uses the native call to set the background image of the navigation bar.
You can set it to a 1px transparent png to use a combination of barColor and hideShadow:true.
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), black (iOS).
Radius for the rounded corners of the view's border.
Each corner is rounded using an arc of a circle.
Default: 0
Border width of the view.
If borderColor is set without borderWidth, this value will be changed to 1 of the unit declared as 'ti.ui.defaultunit' in tiapp.xml descriptor.
Default: 0
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.
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
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.
Array of this view's child views.
Array of this view's child views.
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.
View for the detail view section of the SplitWindow.
View for the detail view section of the SplitWindow.
Base elevation of the view relative to its parent in pixels.
Requires: Android 5 and later
The elevation of a view determines the appearance of its shadow. Higher elevations produce larger and softer shadows.
Note: The elevation property only works on Titanium.UI.View objects.
Many Android components have a default elevation that cannot be modified.
For more information, see
Google design guidelines: Elevation and shadows.
Boolean value indicating if the application should exit when the Android Back button is pressed while the window is being shown or when the window is closed programmatically.
Starting in 3.4.2 you can set this property at any time. In earlier releases you can only set this as a createWindow({...}) option.
Default: true if this is the first window launched else false; prior to Release 3.3.0, the default was always false.
An array of supported values specified using the EXTEND_EDGE constants in Titanium.UI. Valid on iOS 7 and greater.
Requires: iOS 7.0 and later
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 API can be assigned the following constants:
Specifies whether the content (subviews) of the window will render inside the safe-area or not. Only used in iOS 11.0 and later.
Requires: iOS 11.0 and later
If set true (the default), then the content of the window will be extended to fill the whole screen and
under the system's UI elements (such as the top status-bar) and physical obstructions (such as the iPhone X
rounded corners and top sensor housing). In this case, it is the app developer's responsibility to position
views so that they're unobstructed.
If set false, then the window's content will be laid out within the safe-area and its child views will be
unobstructed. For example, you will not need to position a view below the top status-bar.
Read more about the safe-area layout-guide in the Human Interface Guidelines.
Default: true
Treat the content of the window as secure, preventing it from appearing in screenshots or from being viewed on non-secure displays.
When the value is true, preventing it from appearing in screenshots or from being viewed on non-secure displays.
Default: false
Whether view should be focusable while navigating with the trackball.
Default: false
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
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:
SIZE or
FILL constants if it is necessary to set the view's behavior explicitly.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 API can be assigned the following constants:
Set this to true to hide the shadow image of the navigation bar.
This property is only honored if a valid value is specified for the barImage property.
Default: false
Set this to true to hide the navigation bar on swipe.
Requires: iOS 8.0 and later
When this property is set to true, an upward swipe hides the navigation bar and toolbar. A downward swipe shows both bars again. If the toolbar does not have any items, it remains visible even after a swipe.
Default: false
Set this to true to hide the navigation bar on tap.
Requires: iOS 8.0 and later
When the value of this property is true, the navigation controller toggles the hiding and showing of its navigation bar and toolbar in response to an otherwise unhandled tap in the content area.
Default: false
Set this to true to hide the navigation bar when the keyboard appears.
Requires: iOS 8.0 and later
When this property is set to true, the appearance of the keyboard causes the navigation controller to hide its navigation bar and toolbar.
Default: false
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
Specifies if the edges should extend beyond opaque bars (navigation bar, tab bar, toolbar). Valid on iOS 7 and greater.
Requires: iOS 7.0 and later
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.
Determines whether to keep the device screen on.
When true the screen will not power down. Note: enabling this feature will use more
power, thereby adversely affecting run time when on battery.
Default: false
Determines the width of the masterView in landscape mode.
These values are capped in the range 0.25 to 0.5. Any values outside this range are ignored.
Default: The width of the master-view divided by the screen-height
The mode to use when displaying the title of the navigation bar.
Requires: iOS 11.0 and later
Automatically use the large out-of-line title based on the state of the
previous item in the navigation bar. An item with
largeTitleDisplayMode = Ti.UI.iOS.LARGE_TITLE_DISPLAY_MODE_AUTOMATIC
will show or hide the large title based on the request of the previous
navigation item. If the first item pushed is set to Automatic, then it
will show the large title if the navigation bar has largeTitleEnabled = true.
This API can be assigned the following constants:
Default: Titanium.UI.iOS.LARGE_TITLE_DISPLAY_MODE_AUTOMATIC
A Boolean value indicating whether the title should be displayed in a large format.
Requires: iOS 11.0 and later
When set to true, the navigation bar will use a larger out-of-line
title view when requested by the current navigation item. To specify when
the large out-of-line title view appears, see largeTitleDisplayMode.
Default: false
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.)
| Scenario | Behavior |
|---|---|
| `height` & `top` specified | Child positioned `top` unit from parent's top, using specified `height`; any `center.y` and `bottom` values are ignored. |
| `height` & `center.y` specified | Child positioned with center at `center.y`, using specified `height`; any `bottom` value is ignored. |
| `height` & `bottom` specified | Child positioned `bottom` units from parent's bottom, using specified `height`. |
| `top` & `center.y` specified | Child 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` specified | Child 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` specified | Child positioned `top` units from parent's top, and uses the default height calculation for the view type. |
| `center.y` and `bottom` specified | Child positioned with center at `center.y` and bottom edge `bottom` units from parent's bottom. Height is determined implicitly. |
| Only `center.y` specified | Child positioned with center at `center.y`, and uses the default height calculation for the view type. |
| Only `bottom` specified | Child 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` unspecified | Child 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 and Android (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:
top or bottom is specified, the child is centered in the
row.top or bottom is specified, the child is aligned to either
the top or bottom of the row, with the specified amount of padding.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 Android and iOS prior to Release
2.1.0, the horizontal layout always wraps and the horizontalWrap property is not supported.
Default: Composite layout
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
The Window or TabGroup whose Activity lifecycle should be triggered on the proxy.
The Window or TabGroup whose Activity lifecycle should be triggered on the proxy.
If this property is set to a Window or TabGroup, then the corresponding Activity lifecycle event callbacks will also be called on the proxy. Proxies that require the activity lifecycle will need this property set to the appropriate containing Window or TabGroup.
Determines whether to show the master view is overlayed in portrait orientation.
Note that you need to set showMasterInPortrait to true if you want to use
this property in portrait mode.
Default: false
View for the master view section of the SplitWindow.
View for the master view section of the SplitWindow.
Indicates to open a modal window or not.
Set to true to create a modal window.
Must be specified at creation time or in the dictionary passed to the Window.open method.
In the user interface, a modal window is a window that blocks the main application UI until the modal window is dismissed. A modal window requires the user to interact with it to resume the normal flow of the application.
See the "Modal Windows" section for platform-specific information.
Default: false
Callback function that overrides the default behavior when the user presses the Back button.
Callback function that overrides the default behavior when the user presses the Back button.
This was separated from the
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 API can be assigned the following constants:
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.
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:
Empty array. Enables orientation to be fully controlled by the device sensor.
Array includes one or both portrait modes and one or both landscape modes. Enables full sensor control (identical to an empty array).
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.
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.
Array contains only PORTRAIT. Locks screen orientation to normal portrait mode.
Array contains only LANDSCAPE_LEFT. Locks screen orientation to normal landscape mode.
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.
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 API can be assigned the following constants:
Default: empty array
When on, animate call overrides current animation if applicable.
If this property is set to false, the animate call is ignored if the view is currently being animated.
Default: undefined but behaves as false
Determines the width of the masterView in portrait mode.
These values are capped in the range 0.25 to 0.5. Any values outside this range are ignored.
Default: The width of the master-view divided by the screen-width
The preview context used in the 3D-Touch feature "Peek and Pop".
Requires: iOS 9.0 and later
Preview context to present the "Peek and Pop" of a view. Use an configured instance of Titanium.UI.iOS.PreviewContext here.
Note: This property can only be used on devices running iOS9 or later and supporting 3D-Touch. It is ignored on older devices and can manually be checked using Titanium.UI.iOS.forceTouchSupported.
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.
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).
On Android it will also return rect.absoluteX and 'rect.absoluteY' which are relative to
the main window.
The correct values will only be available when layout is complete. To determine when layout is complete, add a listener for the postlayout event.
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
Clockwise 2D rotation of the view in degrees.
Clockwise 2D rotation of the view in degrees.
Translation values are applied to the static post layout value.
Clockwise rotation of the view in degrees (x-axis).
Clockwise rotation of the view in degrees (x-axis).
Translation values are applied to the static post layout value.
Clockwise rotation of the view in degrees (y-axis).
Clockwise rotation of the view in degrees (y-axis).
Translation values are applied to the static post layout value.
Scaling of the view in x-axis in pixels.
Scaling of the view in x-axis in pixels.
Translation values are applied to the static post layout value.
Scaling of the view in y-axis in pixels.
Scaling of the view in y-axis in pixels.
Translation values are applied to the static post layout value.
Shadow image for the navigation bar, specified as a URL to a local image..
Shadow image for the navigation bar, specified as a URL to a local image..
This property is only honored if a valid value is specified for the barImage property.
Determines whether to show the master view in portrait orientation.
Default: false
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.
Determines keyboard behavior when this view is focused.
This API can be assigned the following constants:
Default: Titanium.UI.Android.SOFT_KEYBOARD_DEFAULT_ON_FOCUS
Boolean value to enable split action bar.
deprecated since 6.2.0
Deprecated in AppCompat theme. The same behaviour can be achived by using Toolbar.
splitActionBar must be set before opening the window.
This property indicates if the window should use a split action bar
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.iOS.StatusBar.DEFAULT.
This API can be assigned the following constants:
Maintain a sustainable level of performance.
Requires: Android 7.0 and later
Performance can fluctuate dramatically for long-running apps, because the system throttles system-on-chip engines as device components reach their temperature limits. This fluctuation presents a moving target for app developers creating high-performance, long-running apps.
Setting this feature to true will set sustained performance mode for the corresponding window. If property is undefined then it defaults to false.
Note: This feature is only available on supported devices. The functionality is experimental and subject to change in future releases. See Android docs and Google VR docs for further info.
Boolean value indicating if the tab bar should be hidden.
Boolean value indicating if the tab bar should be hidden.
tabBarHidden must be set before opening the window.
This property is only valid when the window is the child of a tab.
Name of the theme to apply to the window.
Name of the theme to apply to the window.
Set the theme of the window. It can be either a built-in theme or a custom theme.
The view's tintColor. This property is applicable on iOS 7 and greater.
Requires: iOS 7.0 and later
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.
Default:
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.
View to show in the title area of the nav bar.
View to show in the title area of the nav bar.
In an Alloy application you can specify this property using a <TitleControl> element inside
<Window>, for example:
<Alloy>
<Window>
<RightNavButton>
<Button title="Back" />
</RightNavButton>
<LeftNavButton>
<Button title="Back" />
</LeftNavButton>
<TitleControl>
<View backgroundColor="blue" height="100%" width="100%"></View>
</TitleControl>
</Window>
</Alloy>
Image to show in the title area of the nav bar, specified as a local file path or URL.
Image to show in the title area of the nav bar, specified as a local file path or URL.
Key identifying a string from the locale file to use for the window title.
Key identifying a string from the locale file to use for the window title.
Only one of title or titleid should be specified.
Key identifying a string from the locale file to use for the window title prompt.
Key identifying a string from the locale file to use for the window title prompt.
Only one of titlePrompt or titlepromptid should be specified.
Array of button objects to show in the window's toolbar.
Array of button objects to show in the window's toolbar.
The toolbar is only shown when the window is inside a Titanium.UI.iOS.NavigationWindow. To display a toolbar when a window is not inside a NavigationWindow, add an instance of a Titanium.UI.iOS.Toolbar to the window.
To customize the toolbar, use the setToolbar() method.
Since Alloy 1.6.0, you can specify this property using the <WindowToolbar> element as a
child of a <Window> element, for example:
<Alloy>
<NavigationWindow>
<Window>
<WindowToolbar>
<Button id="send" title="Send" style="Ti.UI.iOS.SystemButtonStyle.DONE" />
<FlexSpace/>
<Button id="camera" systemButton="Ti.UI.iOS.SystemButton.CAMERA" />
<FlexSpace/>
<Button id="cancel" systemButton="Ti.UI.iOS.SystemButton.CANCEL" />
</WindowToolbar>
</Window>
</NavigationWindow>
</Alloy>
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.
Overrides: Titanium.UI.View.top
Determines whether view should receive touch events.
If false, will forward the events to peers.
Default: true
A material design visual construct that provides an instantaneous visual confirmation of touch point.
Requires: Android 5.0 and later
This is an opt-in feature available from Android Lollipop. Touch feedback is applied only if the backgroundColor is a solid color.
Default: false
Optional touch feedback ripple color. This has no effect unless touchFeedback is true.
Requires: Android 5.0 and later
Default: Theme provided color.
Transformation matrix to apply to the view.
Android only supports 2DMatrix transforms.
Default: Identity matrix
A name to identify this view in activity transition.
Requires: Android 5 and later
Name should be unique in the View hierarchy.
Horizontal location of the view relative to its left position in pixels.
Horizontal location of the view relative to its left position in pixels.
Translation values are applied to the static post layout value.
Vertical location of the view relative to its top position in pixels.
Vertical location of the view relative to its top position in pixels.
Translation values are applied to the static post layout value.
Depth of the view relative to its elevation in pixels.
Requires: Android 5 and later
Translation values are applied to the static post layout value.
Boolean value indicating if the nav bar is translucent.
Default: true on iOS7 and above, false otherwise.
Loads a JavaScript file from a local URL.
Loads a JavaScript file from a local URL.
This property has been removed since 6.0.0
Note: The recommended way of creating windows with their own context is to either use the Alloy Framework or a CommonJS module than using this property. One benefit of using a CommonJS module is that it consumes less resources.
Use this property to have Windows load a JavaScript file in its own subcontext and thread,
separate from the app.js global context.
Reference a file relative to your project's Resources folder for classic Titanium
projects or app/lib folder for Alloy projects.
Note that Titanium will refuse to load JavaScript files from a remote URL. Loading remote JavaScript from a URL and providing it with the full capabilities of the Titanium API would be very dangerous.
When loading JavaScript files using this property, the special property Titanium.UI.currentWindow is available inside a multi-context application that points to the JavaScript instance by reference in the global context.
Determines the color of the shadow.
Default: Undefined. Behaves as if transparent.
Determines the offset for the shadow of the view.
Default: Undefined. Behaves as if set to (0,-3)
Determines the blur radius used to create the shadow.
Default: Undefined. Behaves as if set to 3.
Determines whether the view is visible.
Default: true
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:
SIZE or
FILL constants if it is necessary to set the view's behavior explicitly.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 API can be assigned the following constants:
Additional flags to set on the Activity Window.
Additional flags to set on the Activity Window.
Set the flags of the window, as per the WindowManager.LayoutParams flags. See WindowManager.LayoutParams for a list of supported flags. Setting fullscreen to true automatically sets the WindowManager.LayoutParams.FLAG_FULLSCREEN flag. Setting flagSecure to true automatically sets the WindowManager.LayoutParams.FLAG_SECURE flag.
Set the pixel format for the Activity's Window.
Set the pixel format for the Activity's Window.
For more information on pixel formats, see Android SDK Window.setFormat
This API can be assigned the following constants:
Determines whether a heavyweight window's soft input area (ie software keyboard) is visible as it receives focus and how the window behaves in order to accomodate it while keeping its contents in view.
In order for this property to take effect on an emulator, its Android Virtual Device (AVD)
must be configured with the Keyboard Support setting set to No. Note that it is always
recommended to test an application on a physical device to understand its true behavior.
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.
This property is capable of representing two settings from the soft input visibility constatns and soft input adjustment constants using the bitwise OR operation.
Note that in JavaScript, bitwise OR is achieved using the single pipe operand. See the example for a demonstration.
For more information, see the official Android Developers website API Reference for Window.setSoftInputMode.
This API can be assigned the following constants:
Create a white window and respond to a click of it to open a red window containing a text area. Show the software keyboard automatically as the red window opens.
var win1 = Ti.UI.createWindow({
backgroundColor: 'white',
exitOnClose: true,
fullscreen: false,
title: 'Click window to test'
});
// use bitwise OR to combine two settings for the windowSoftInputMode property
var softInput = Ti.UI.Android.SOFT_INPUT_STATE_ALWAYS_VISIBLE | Ti.UI.Android.SOFT_INPUT_ADJUST_PAN;
win1.addEventListener('click', function(){
var win2 = Ti.UI.createWindow({
backgroundColor: 'red',
fullscreen: false,
windowSoftInputMode: softInput
});
var textArea = Ti.UI.createTextArea({
value : 'I am a textarea',
height : 200,
width : 300,
top : 200
});
win2.add(textArea);
win2.open();
});
win1.open();
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.
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:
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.
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, NavigationWindow and SplitWindow objects are
special containers that manage windows. These are discussed in the
"Top-Level Containers" section.
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.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.
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.
View to add to this view's hierarchy.
You may pass an array of views, e.g. view.add([subview1, subview2].
Adds the specified callback as an event listener for the named event.
Name of the event.
Callback function to invoke when the event is fired.
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.
Either a dictionary of animation properties or an Animation object.
Function to be invoked upon completion of the animation.
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.
A dictionary of properties to apply.
Closes the window.
Android only supports the argument type closeWindowParams.
Animation or display properties to use when closing the window.
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.
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.
View that specifies the destination coordinate system to convert to. If this argument is not a view, an exception will be raised.
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 <Titanium.Proxy.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.
Fires a synthesized event to any registered listeners.
Name of the event.
A dictionary of keys and values to add to the Titanium.Event object sent to the listeners.
Gets the value of the backgroundColor property.
Overrides: Titanium.UI.View.getBackgroundColor
Gets the value of the splitActionBar property.
deprecated since 6.2.0
Deprecated in AppCompat theme. The same behaviour can be achived by using Toolbar.
Returns the matching view of a given view ID.
The ID of the view that should be returned. Use the id property in your views to
enable it for indexing in this method.
Hides this view.
Animation options for Android. Since Release 5.1.0.
Hides the tab bar. Must be called before opening the window.
To hide the tab bar when opening a window as a child of a tab, call
hideTabBar or set tabBarHidden to true before opening the window.
If the window is not a child of a tab, this method has no effect.
Makes the bottom toolbar invisible.
If the window is not displayed in a Titanium.UI.iOS.NavigationWindow, this method has no effect. Note: This method is only intended to work with toolbars that are created using setToolbar. It will not have any effect on toolbars added manually to the window.
Options dictionary supporting a single animated boolean property to determine whether
the toolbar will be animated (default) while being hidden.
Inserts a view at the specified position in the children array.
Useful if the layout property is set to horizontal or vertical.
Pass an object with the following key-value pairs:
view (Titanium.UI.View): View to insertposition (Number): Position in the children array to
insert the view. If omitted, inserts the view to the end of the array.Opens the window.
Animation or display properties to use when opening the window.
Removes a child view from this view's hierarchy.
View to remove from this view's hierarchy.
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);
Name of the event.
Callback function to remove. Must be the same function passed to addEventListener.
Replaces a view at the specified position in the children array.
Useful if the layout property is set to horizontal or vertical.
Pass an object with the following key-value pairs:
view (Titanium.UI.View): View to insertposition (Number): Position in the children array of
the view elment to replace.Sets the value of the accessibilityHidden property.
New value for the property.
Sets the value of the accessibilityHint property.
New value for the property.
Sets the value of the accessibilityLabel property.
New value for the property.
Sets the value of the accessibilityValue property.
New value for the property.
Sets the value of the activityEnterTransition property.
New value for the property.
Sets the value of the activityExitTransition property.
New value for the property.
Sets the value of the activityReenterTransition property.
New value for the property.
Sets the value of the activityReturnTransition property.
New value for the property.
Sets the value of the anchorPoint property.
New value for the property.
Sets the value of the autoAdjustScrollViewInsets property.
New value for the property.
Sets the value of the backButtonTitle property.
New value for the property.
Sets the value of the backButtonTitleImage property.
New value for the property.
Sets the value of the backgroundColor property.
New value for the property.
Overrides: Titanium.UI.View.setBackgroundColor
Sets the value of the backgroundDisabledColor property.
New value for the property.
Sets the value of the backgroundDisabledImage property.
New value for the property.
Sets the value of the backgroundFocusedColor property.
New value for the property.
Sets the value of the backgroundFocusedImage property.
New value for the property.
Sets the value of the backgroundGradient property.
New value for the property.
Sets the value of the backgroundImage property.
New value for the property.
Sets the value of the backgroundLeftCap property.
New value for the property.
Sets the value of the backgroundRepeat property.
New value for the property.
Sets the value of the backgroundSelectedColor property.
New value for the property.
Sets the value of the backgroundSelectedImage property.
New value for the property.
Sets the value of the backgroundTopCap property.
New value for the property.
Sets the value of the barColor property.
New value for the property.
Sets the value of the barImage property.
New value for the property.
Sets the value of the borderColor property.
New value for the property.
Sets the value of the borderRadius property.
New value for the property.
Sets the value of the borderWidth property.
New value for the property.
Sets the value of the bottom property.
New value for the property.
Overrides: Titanium.UI.View.setBottom
Sets the value of the bubbleParent property.
New value for the property.
Sets the value of the clipMode property.
New value for the property.
Sets the value of the detailView property.
New value for the property.
Sets the value of the elevation property.
New value for the property.
Sets the value of the exitOnClose property.
New value for the property.
Sets the value of the extendEdges property.
New value for the property.
Sets the value of the extendSafeArea property.
New value for the property.
Sets the value of the flagSecure property.
New value for the property.
Sets the value of the focusable property.
New value for the property.
Sets the value of the fullscreen property.
New value for the property.
Sets the value of the height property.
New value for the property.
Sets the value of the hiddenBehavior property.
New value for the property.
Sets the value of the hideShadow property.
New value for the property.
Sets the value of the hidesBarsOnSwipe property.
New value for the property.
Sets the value of the hidesBarsOnTap property.
New value for the property.
Sets the value of the hidesBarsWhenKeyboardAppears property.
New value for the property.
Sets the value of the horizontalWrap property.
New value for the property.
Sets the value of the includeOpaqueBars property.
New value for the property.
Sets the value of the keepScreenOn property.
New value for the property.
Sets the value of the landscapeSplit property.
New value for the property.
Sets the value of the largeTitleDisplayMode property.
New value for the property.
Sets the value of the largeTitleEnabled property.
New value for the property.
Sets the value of the layout property.
New value for the property.
Sets the value of the left property.
New value for the property.
Overrides: Titanium.UI.View.setLeft
Sets the value of the lifecycleContainer property.
New value for the property.
Sets the value of the masterIsOverlayed property.
New value for the property.
Sets the value of the masterView property.
New value for the property.
Sets the value of the modal property.
New value for the property.
Sets the value of the onBack property.
New value for the property.
Sets the value of the opacity property.
New value for the property.
Overrides: Titanium.UI.View.setOpacity
Sets the value of the orientationModes property.
New value for the property.
Sets the value of the overrideCurrentAnimation property.
New value for the property.
Sets the value of the portraitSplit property.
New value for the property.
Sets the value of the previewContext property.
New value for the property.
Sets the value of the pullBackgroundColor property.
New value for the property.
Sets the value of the right property.
New value for the property.
Overrides: Titanium.UI.View.setRight
Sets the value of the rotation property.
New value for the property.
Sets the value of the rotationX property.
New value for the property.
Sets the value of the rotationY property.
New value for the property.
Sets the value of the scaleX property.
New value for the property.
Sets the value of the scaleY property.
New value for the property.
Sets the value of the shadowImage property.
New value for the property.
Sets the value of the showMasterInPortrait property.
New value for the property.
Sets the value of the softKeyboardOnFocus property.
New value for the property.
Sets the value of the splitActionBar property.
deprecated since 6.2.0
Deprecated in AppCompat theme. The same behaviour can be achived by using Toolbar.
New value for the property.
Sets the value of the statusBarStyle property.
New value for the property.
Sets the value of the sustainedPerformanceMode property.
New value for the property.
Sets the value of the tabBarHidden property.
New value for the property.
Sets the value of the theme property.
New value for the property.
Sets the value of the tintColor property.
New value for the property.
Sets the value of the title property.
New value for the property.
Sets the value of the titleAttributes property.
New value for the property.
Sets the value of the titleControl property.
New value for the property.
Sets the value of the titleImage property.
New value for the property.
Sets the value of the titlePrompt property.
New value for the property.
Sets the value of the titleid property.
New value for the property.
Sets the value of the titlepromptid property.
New value for the property.
Sets the value of the toolbar property.
New value for the property.
Sets the value of the top property.
New value for the property.
Overrides: Titanium.UI.View.setTop
Sets the value of the touchEnabled property.
New value for the property.
Sets the value of the touchFeedback property.
New value for the property.
Sets the value of the touchFeedbackColor property.
New value for the property.
Sets the value of the transform property.
New value for the property.
Sets the value of the transitionName property.
New value for the property.
Sets the value of the translationX property.
New value for the property.
Sets the value of the translationY property.
New value for the property.
Sets the value of the translationZ property.
New value for the property.
Sets the value of the translucent property.
New value for the property.
Sets the value of the url property.
This method has been removed since 6.0.0
New value for the property.
Sets the value of the viewShadowColor property.
New value for the property.
Sets the value of the viewShadowOffset property.
New value for the property.
Sets the value of the viewShadowRadius property.
New value for the property.
Sets the value of the visible property.
New value for the property.
Sets the value of the width property.
New value for the property.
Sets the value of the windowFlags property.
New value for the property.
Sets the value of the windowPixelFormat property.
New value for the property.
Sets the value of the windowSoftInputMode property.
New value for the property.
Sets the value of the zIndex property.
New value for the property.
Makes this view visible.
Animation options for Android. Since Release 5.1.0.
Makes the bottom toolbar visible.
If the window is not displayed in a Titanium.UI.iOS.NavigationWindow, this method has no effect. Note: This method is only intended to work with toolbars that are created using setToolbar. It will not have any effect on toolbars added manually to the window.
Options dictionary supporting a single animated boolean property to determine whether
the toolbar will be animated (default) while being shown.
Starts a batch update of this view's layout properties.
deprecated since 3.0.0
Use the <Titanium.Proxy.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.
See also: updateLayout, finishLayout, postlayout event.
Returns an image of the rendered view, as a Blob.
The honorScaleFactor method is only supported on iOS.
Function to be invoked upon completion. If non-null, this method will be performed asynchronously. If null, it will be performed immediately.
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.
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 <Titanium.Proxy.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.
Layout properties to be updated.
Fired when the Back button is released.
deprecated since 3.0.0
Use <Titanium.UI.Window.androidback> instead.
Setting a listener disables the default key handling for the Back button. To restore default behavior, remove the listener. It is recommended that you only have one handler per heavyweight window.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Fired when the Camera button is released.
deprecated since 3.0.0
Use <Titanium.UI.Window.androidcamera> instead.
Setting a listener disables the default key handling for this button. To restore default behavior, remove the listener. It is recommended that you only have one handler per heavyweight window.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Fired when the Camera button is half-pressed then released.
deprecated since 3.0.0
Use <Titanium.UI.Window.androidfocus> instead.
Setting a listener disables the default key handling for this button. To restore default behavior, remove the listener. It is recommended that you only have one handler per heavyweight window.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Fired when the Search button is released.
deprecated since 3.0.0
Use <Titanium.UI.Window.androidsearch> instead.
Setting a listener disables the default key handling for this button. To restore default behavior, remove the listener. It is recommended that you only have one handler per heavyweight window.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Fired when the volume down button is released.
deprecated since 3.0.0
Use <Titanium.UI.Window.androidvoldown> instead.
Setting a listener disables the default key handling for this button. To restore default behavior, remove the listener. It is recommended that you only have one handler per heavyweight window.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Fired when the volume up button is released.
deprecated since 3.0.0
Use <Titanium.UI.Window.androidvolup> instead.
Setting a listener disables the default key handling for this button. To restore default behavior, remove the listener. It is recommended that you only have one handler per heavyweight window.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Fired when the back button is pressed by the user.
This event is fired when the current window's activity detects a back button press by the user to navigate back.
By default this event would trigger the current activity to be finished and removed from the task stack. Subscribing to this event with a listener will prevent the default behavior. To finish the activity from your listener just call the close method of the window.
This event replaces the android:back event. Some behavior changes may exist such as the event no longer firing when the user dismisses the keyboard with the back button or when the user closes a full-screen video which is embedded in a web view with the back button.
As of 5.0.0, you can create an event that can prevent accidental closure of the app due to hitting the back button to many times.
var win = Ti.UI.createWindow(
{ // some code... }
);
// more code
win.addEventListener("windows:back", function()
{ alert("Back pressed"); }
);
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Fired when the Camera button is released.
Setting a listener disables the default key handling for this button. To restore default behavior, remove the listener. It is recommended that you only have one handler per heavyweight window.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Fired when the Camera button is half-pressed then released.
Setting a listener disables the default key handling for this button. To restore default behavior, remove the listener. It is recommended that you only have one handler per heavyweight window.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Fired when the Search button is released.
Setting a listener disables the default key handling for this button. To restore default behavior, remove the listener. It is recommended that you only have one handler per heavyweight window.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Fired when the volume down button is released.
Setting a listener disables the default key handling for this button. To restore default behavior, remove the listener. It is recommended that you only have one handler per heavyweight window.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Fired when the volume up button is released.
Setting a listener disables the default key handling for this button. To restore default behavior, remove the listener. It is recommended that you only have one handler per heavyweight window.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
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.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
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.
X coordinate of the event from the source view's coordinate system.
Y coordinate of the event from the source view's coordinate system.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Fired when the window is closed.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Fired when the device detects a double click against the view.
X coordinate of the event from the source view's coordinate system.
Y coordinate of the event from the source view's coordinate system.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Fired when the device detects a double tap against the view.
X coordinate of the event from the source view's coordinate system.
Y coordinate of the event from the source view's coordinate system.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
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.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Overrides: Titanium.UI.View.focus
Fired when a hardware key is pressed in the view.
A keypressed event is generated by pressing a hardware key. On Android, this event can only be fired when the property focusable is set to true. On iOS the event is generated only when using Ti.UI.TextArea, Ti.UI.TextField and Ti.UI.SearchBar.
The code for the physical key that was pressed. For more details, see KeyEvent. This API is experimental and subject to change.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Fired when the device detects a long click.
A long click is generated by touching and holding on the touchscreen or holding down the trackball button.
The event occurs before the finger/button is lifted.
A longpress and a longclick can occur together.
As the trackball can fire this event, it is not intended to return the x and y
coordinates of the touch, even when it is generated by the touchscreen.
A longclick blocks a click, meaning that a click event will not fire when a
longclick listener exists.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
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.
X coordinate of the event from the source view's coordinate system.
Y coordinate of the event from the source view's coordinate system.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Fired when the window is opened.
The listener for this event must be defined before this window is opened.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
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.
The scale factor relative to the points of the two touches in screen coordinates.
The velocity of the pinch in scale factor per second.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
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.
Note that altering any properties that affect layout from the postlayout callback
may result in an endless loop.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Fired when the device detects a single tap against the view.
X coordinate of the event from the source view's coordinate system.
Y coordinate of the event from the source view's coordinate system.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Fired when the device detects a swipe gesture against the view.
Direction of the swipe--either 'left', 'right', 'up', or 'down'.
X coordinate of the event's endpoint from the source view's coordinate system.
Y coordinate of the event's endpoint from the source view's coordinate system.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
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.
X coordinate of the event from the source view's coordinate system.
Y coordinate of the event from the source view's coordinate system.
The current force value of the touch event. Note: This property is only available for iOS devices that support 3D-Touch and run 9.0 or later and on some Android devices.
The current size of the touch area. Note: This property is only available on some Android devices.
Maximum possible value of the force property. Note: This property is only available for iOS devices that support 3D-Touch and run 9.0 or later.
A value which indicates the stylus angle on the screen. If the stylus is perpendicular to the screen or no stylus is being used, the value will be Pi/2. If the stylus is parallel to the screen, the value will be 0. Note: This property is only available for iOS devices that support 3D-Touch and are 9.1 or later.
The time (in seconds) when the touch was used in correlation with the system start up. Note: This property is only available for iOS devices that support 3D-Touch and run 9.0 or later.
The x value of the unit vector that points in the direction of the azimuth of the stylus. Note: This property is only available for iOS devices that support the Apple Pencil and are 9.1 or later.
The y value of the unit vector that points in the direction of the azimuth of the stylus. Note: This property is only available for iOS devices that support the Apple Pencil and are 9.1 or later.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
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.
X coordinate of the event from the source view's coordinate system.
Y coordinate of the event from the source view's coordinate system.
The current force value of the touch event. Note: This property is only available for iOS devices that support 3D-Touch and run 9.0 or later and on some Android devices.
The current size of the touch area. Note: This property is only available on some Android devices.
Maximum possible value of the force property. Note: This property is only available for iOS devices that support 3D-Touch and run 9.0 or later.
A value which indicates the stylus angle on the screen. If the stylus is perpendicular to the screen or no stylus is being used, the value will be Pi/2. If the stylus is parallel to the screen, the value will be 0. Note: This property is only available for iOS devices that support 3D-Touch and are 9.1 or later.
The time (in seconds) when the touch was used in correlation with the system start up. Note: This property is only available for iOS devices that support 3D-Touch and run 9.0 or later.
The x value of the unit vector that points in the direction of the azimuth of the stylus. Note: This property is only available for iOS devices that support the Apple Pencil and are 9.1 or later.
The y value of the unit vector that points in the direction of the azimuth of the stylus. Note: This property is only available for iOS devices that support the Apple Penciland are 9.1 or later.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
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
X coordinate of the event from the source view's coordinate system.
Y coordinate of the event from the source view's coordinate system.
The current force value of the touch event. Note: This property is only available for iOS devices that support 3D-Touch and run 9.0 or later and on some Android devices.
The current size of the touch area. Note: This property is only available on some Android devices.
Maximum possible value of the force property. Note: This property is only available for iOS devices that support 3D-Touch and run 9.0 or later.
A value which indicates the stylus angle on the screen. If the stylus is perpendicular to the screen or no stylus is being used, the value will be Pi/2. If the stylus is parallel to the screen, the value will be 0. Note: This property is only available for iOS devices that support 3D-Touch and are 9.1 or later.
The time (in seconds) when the touch was used in correlation with the system start up. Note: This property is only available for iOS devices that support 3D-Touch and run 9.0 or later.
The x value of the unit vector that points in the direction of the azimuth of the stylus. Note: This property is only available for iOS devices that support the Apple Pencil and are 9.1 or later.
The y value of the unit vector that points in the direction of the azimuth of the stylus. Note: This property is only available for iOS devices that support the Apple Pencil and are 9.1 or later.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Fired as soon as the device detects a touch gesture.
X coordinate of the event from the source view's coordinate system.
Y coordinate of the event from the source view's coordinate system.
The current force value of the touch event. Note: This property is only available for iOS devices that support 3D-Touch and run 9.0 or later and on some Android devices.
The current size of the touch area. Note: This property is only available on some Android devices.
Maximum possible value of the force property. Note: This property is only available for iOS devices that support 3D-Touch and run 9.0 or later.
A value which indicates the stylus angle on the screen. If the stylus is perpendicular to the screen or no stylus is being used, the value will be Pi/2. If the stylus is parallel to the screen, the value will be 0. Note: This property is only available for iOS devices that support 3D-Touch and are 9.1 or later.
The time (in seconds) when the touch was used in correlation with the system start up. Note: This property is only available for iOS devices that support 3D-Touch and run 9.0 or later.
The x value of the unit vector that points in the direction of the azimuth of the stylus. Note: This property is only available for iOS devices that support the Apple Pencil and are 9.1 or later.
The y value of the unit vector that points in the direction of the azimuth of the stylus. Note: This property is only available for iOS devices that support the Apple Pencil and are 9.1 or later.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.
Fired when the device detects a two-finger tap against the view.
X coordinate of the event from the source view's coordinate system.
Y coordinate of the event from the source view's coordinate system.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.