Titanium.UI.iOS.NavigationWindow
> Deprecated since 8.0.0: Use Titanium.UI.NavigationWindow instead.
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.iOS.SplitWindow.
Extends: Titanium.UI.Window · Since: 3.1.3, 3.1.3, 9.2.0 · Platforms: iphone, ipad, macos
Properties #
accessibilityDisableLongPress#
Type: Boolean
Boolean value to remove the long press notification for the device's accessibility service.
Will disable the "double tap and hold for long press" message when selecting an item.
accessibilityHidden#
Type: Boolean
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.
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.
accessibilityHint#
Type: String
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
Titanium.UI.View.accessibilityLabel and Titanium.UI.View.accessibilityValue in the order: accessibilityLabel,
accessibilityValue, accessibilityHint. The concatenated value is then passed as the
argument to the native View.setContentDescription method.
accessibilityLabel#
Type: String
A succinct 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
Titanium.UI.View.accessibilityValue and Titanium.UI.View.accessibilityHint in the order: accessibilityLabel,
accessibilityValue, accessibilityHint. The concatenated value is then passed as the
argument to the native View.setContentDescription method.
Defaults to Title or label of the control.
accessibilityValue#
Type: String
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
Titanium.UI.View.accessibilityLabel and Titanium.UI.View.accessibilityHint in the order: accessibilityLabel,
accessibilityValue, accessibilityHint. The concatenated value is then passed as the
argument to the native View.setContentDescription method.
Defaults to State or value of the control.
activity#
Type: Titanium.Android.Activity
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.
activityEnterTransition#
Type: Number
The type of transition used when activity is entering.
Activity B's enter transition determines how views in B are animated when A starts B.
Applicable for Android 5.0 and above. This transition property will be ignored if animated is set to false.
Will also be ignored unless at least 1 view has been assigned to the addSharedElement() method,
except on Titanium 8.0.1 and higher where shared elements are no longer required to do transitions.
See "Material design activity transitions in Android" in the main description of Titanium.UI.Window
for more information.
activityExitTransition#
Type: Number
The type of transition used when activity is exiting.
Activity A's exit transition determines how views in A are animated when A starts B.
Applicable for Android 5.0 and above. This transition property will be ignored if animated is set to false.
Will also be ignored unless at least 1 view has been assigned to the addSharedElement() method,
except on Titanium 8.0.1 and higher where shared elements are no longer required to do transitions.
See "Material design activity transitions in Android" in the main description of Titanium.UI.Window
for more information.
activityReenterTransition#
Type: Number
The type of transition used when reentering to a previously started activity.
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 transition property will be ignored if animated is set to false.
Will also be ignored unless at least 1 view has been assigned to the addSharedElement() method,
except on Titanium 8.0.1 and higher where shared elements are no longer required to do transitions.
See "Material design activity transitions in Android" in the main description of Titanium.UI.Window
for more information.
activityReturnTransition#
Type: Number
The type of transition used when returning from a previously started activity.
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 transition property will be ignored if animated is set to false.
Will also be ignored unless at least 1 view has been assigned to the addSharedElement() method,
except on Titanium 8.0.1 and higher where shared elements are no longer required to do transitions.
See "Material design activity transitions in Android" in the main description of Titanium.UI.Window
for more information.
activitySharedElementEnterTransition#
Type: Number
The type of enter transition used when animating shared elements between two activities.
Activity B's shared element enter transition determines how shared elements animate from A to B.
Applicable for Android 5.0 and above. This value will be ignored if animated is set to false.
See "Material design activity transitions in Android" in the main description of Titanium.UI.Window
for more information.
activitySharedElementExitTransition#
Type: Number
The type of exit transition used when animating shared elements between two activities.
Activity A's shared element exit transition animates shared elements before they transition from A to B
Applicable for Android 5.0 and above. This value will be ignored if animated is set to false.
See "Material design activity transitions in Android" in the main description of Titanium.UI.Window
for more information.
activitySharedElementReenterTransition#
Type: Number
The type of reenter transition used when animating shared elements between two activities.
Activity A's shared element reenter transition animates shared elements after they have transitioned from B to A.
Applicable for Android 5.0 and above. This value will be ignored if animated is set to false.
See "Material design activity transitions in Android" in the main description of Titanium.UI.Window
for more information.
activitySharedElementReturnTransition#
Type: Number
The type of return transition used when animating shared elements between two activities.
Activity B's shared element return transition determines how shared elements animate from B to A.
Applicable for Android 5.0 and above. This value will be ignored if animated is set to false.
See "Material design activity transitions in Android" in the main description of Titanium.UI.Window
for more information.
anchorPoint#
Type: Point
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.
The default is center of this view.
apiName#
Type: String
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.
autoAdjustScrollViewInsets#
Type: Boolean
Specifies whether or not the view controller should automatically adjust its scroll view insets.
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.
backgroundColor#
Type: String, Titanium.UI.Color
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.
backgroundDisabledColor#
Type: String
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.
Defaults to the normal background color of this view.
backgroundDisabledImage#
Type: String
Disabled background image for the view, specified as a local file path or URL.
If backgroundDisabledImage is undefined, and the normal background imagebackgroundImage
is set, the normal image is used when this view is disabled.
backgroundFocusedColor#
Type: String
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.
Defaults to the normal background color of this view.
backgroundFocusedImage#
Type: String
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.
If backgroundFocusedImage is undefined, and the normal background image backgroundImage
is set, the normal image is used when this view is focused.
backgroundGradient#
Type: Gradient
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 points, 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.
Defaults to no gradient.
backgroundImage#
Type: String
Background image for the view, specified as a local file path or URL.
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, textfields, and so on), platform-specific default images are used.
backgroundLeftCap#
Type: Number
Size of the left end cap.
See the section on backgroundLeftCap and backgroundTopCap behavior on iOS in Titanium.UI.View.
backgroundRepeat#
Type: Boolean
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:
backgroundSelectedColor#
Type: String, Titanium.UI.Color
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.
Defaults to transparent, so the background color of this view will be used.
backgroundSelectedImage#
Type: String
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.
If backgroundSelectedImage is undefined, and the normal background image backgroundImage is set
the normal image is used when this view is selected.
backgroundTopCap#
Type: Number
Size of the top end cap.
See the section on backgroundLeftCap and backgroundTopCap behavior on iOS in Titanium.UI.View.
borderColor#
Type: String, Titanium.UI.Color
Border color of the view, as a color name or hex triplet.
For information about color values, see the "Colors" section of Titanium.UI.
Defaults to the normal background color of this view (Android), black (iOS).
borderRadius#
Type: Number, String, Array<Number>, Array<String>
Radius for the rounded corners of the view's border.
Each corner is rounded using an arc of a circle.
Values for each corner can be specified. For example, '20px 20px' will set both left and right corners to 20px.
Specifying '20px 20px 20px 20px' will set top-left, top-right, bottom-right and bottom-left corners in that order.
If you have issues with dark artifacts on Android you can try to disable Hardware acceleration by setting a
backgroundColor with a small amount of transparency: backgroundColor:"rgba(255,255,255,254)".
borderWidth#
Type: Number
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.
bottom#
Type: Number, String
Window's bottom position, in platform-specific units.
On Android, this property has no effect.
bubbleParent#
Type: Boolean
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.
center#
Type: Point
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.
Defaults to undefined.
clipMode#
Type: Number
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.
Defaults to undefined. Behaves as if set to Titanium.UI.iOS.CLIP_MODE_DEFAULT.
elevation#
Type: Number
Base elevation of the view relative to its parent in pixels.
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.
exitOnClose#
Type: Boolean
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.
extendEdges#
Type: Array<Number>
An array of supported values specified using the EXTEND_EDGE constants in Titanium.UI.
This is only valid for windows hosted by navigation controllers or tab bar controllers. This property is used to
determine the layout of the window within its parent view controller. For example if the window is specified to extend its top edge
and it is hosted in a navigation controller, then the top edge of the window is extended underneath the navigation bar so that part
of the window is obscured. If the navigation bar is opaque (translucent property on window is false), then the top edge of the window
will only extend if Titanium.UI.Window.includeOpaqueBars is set to true.
The default behavior is to assume that no edges are to be extended. Must be specified before opening the window.
extendSafeArea#
Type: Boolean
Specifies whether the screen insets/notches are allowed to overlap the window's content or not.
If set true, then the contents of the window will be extended to fill the whole screen and allow the
system's UI elements (such as a translucent status-bar) and physical obstructions (such as the iPhone X
rounded corners and top sensor housing) to overlap the window's content. In this case, it is the app
developer's responsibility to position views so that they're unobstructed. On Android, you can use the
Window.safeAreaPadding property after the window has been opened to
layout your content within the insets.
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.
filterTouchesWhenObscured#
Type: Boolean
Discards touch related events if another app's system overlay covers the view.
This is a security feature to protect an app from "tapjacking", where a malicious app can use a
system overlay to intercept touch events in your app or to trick the end-user to tap on UI
in your app intended for the overlay.
Setting this property to true causes touch related events (including "click") to not be fired
if a system overlay overlaps the view.
flagSecure#
Type: Boolean
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.
focusable#
Type: Boolean
Whether view should be focusable while navigating with the trackball.
fullscreen#
Type: Boolean
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.
height#
Type: Number, String
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 theSIZEor
FILLconstants 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.
hiddenBehavior#
Type: Number
Sets the behavior when hiding an object to release or keep the free space
If setting hiddenBehavior to Titanium.UI.HIDDEN_BEHAVIOR_GONE it will automatically release the space the view occupied.
For example: in a vertical layout the views below the object will move up when you hide
an object with hiddenBehavior:Titanium.UI.HIDDEN_BEHAVIOR_GONE.
- Titanium.UI.HIDDEN_BEHAVIOR_INVISIBLE. Keeps the space and just hides the object (default).
- Titanium.UI.HIDDEN_BEHAVIOR_GONE. Releases the space and hides the object.
Defaults to Titanium.UI.HIDDEN_BEHAVIOR_INVISIBLE.
hidesBackButton#
Type: Boolean
Set this to true to hide the back button of navigation bar.
When this property is set to true, the navigation window hides its back button.
hidesBarsOnSwipe#
Type: Boolean
Set this to true to hide the navigation bar on swipe.
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.
hidesBarsOnTap#
Type: Boolean
Set this to true to hide the navigation bar on tap.
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.
hidesBarsWhenKeyboardAppears#
Type: Boolean
Set this to true to hide the navigation bar when the keyboard appears.
When this property is set to true, the appearance of the keyboard causes the
navigation controller to hide its navigation bar and toolbar.
hidesSearchBarWhenScrolling#
Type: Boolean
A Boolean value indicating whether the integrated search bar is hidden when scrolling any underlying content.
When the value of this property is true, the search bar is visible only when the scroll position
equals the top of your content view. When the user scrolls down, the search bar collapses into
the navigation bar. Scrolling back to the top reveals the search bar again. When the value of
this property is false, the search bar remains regardless of the current scroll position.
You must set Titanium.UI.ListView.showSearchBarInNavBar or Titanium.UI.TableView.showSearchBarInNavBar
property for this property to have any effect.
homeIndicatorAutoHidden#
Type: Boolean
Boolean value indicating whether the system is allowed to hide the visual indicator for returning to the Home screen.
Set this value true, if you want the system to determine when to hide the indicator. Set this value false,
if you want the indicator shown at all times. The system takes your preference into account, but setting
true is no guarantee that the indicator will be hidden.
horizontalMotionEffect#
Type: MinMaxOptions
Adds a horizontal parallax effect to the view
Note that the parallax effect only happens by tilting the device so results can not be seen on Simulator.
To clear all motion effects, use the Titanium.UI.clearMotionEffects method.
horizontalWrap#
Type: Boolean
Determines whether the layout has wrapping behavior.
For more information, see the discussion of horizontal layout mode in the description of
the layout property.
id#
Type: String
View's identifier.
The id property of the Ti.UI.View represents the view's identifier. The identifier string does
not have to be unique. You can use this property with Titanium.UI.View.getViewById method.
includeOpaqueBars#
Type: Boolean
Specifies if the edges should extend beyond opaque bars (navigation bar, tab bar, toolbar).
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.
keepHardwareMode#
Type: Boolean
A value indicating the render mode of the View
Set to true to keep hardware mode when using a border and transparent backgrounds.
keepScreenOn#
Type: Boolean
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.
For iOS look at Titanium.App.idleTimerDisabled.
largeTitleDisplayMode#
Type: Number
The mode to use when displaying the title of the navigation bar.
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.
largeTitleEnabled#
Type: Boolean
A Boolean value indicating whether the title should be displayed in a large format.
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 Titanium.UI.Window.largeTitleDisplayMode.
layout#
Type: String
Specifies how the view positions its children.
One of: 'composite', 'vertical', or 'horizontal'.
There are three layout options:
-
composite(orabsolute). Default layout. A child view is positioned based on its
positioning properties or "pins" (top,bottom,left,rightandcenter).
If no positioning properties are specified, the child is centered.The child is always sized based on its
widthandheightproperties, 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 bothleftand
center.xare 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, ifheight,center.yandbottomare all specified, the
heightandcenter.yvalues take precedence.)<table class="doc-table">
<thead>
<tr>
<th>Scenario</th>
<th>Behavior</th>
</tr>
</thead>
<tbody>
<tr>
<td><code>height</code> & <code>top</code> specified</td>
<td>
Child positioned <code>top</code> unit from parent's top, using specified <code>height</code>;
any <code>center.y</code> and <code>bottom</code> values are ignored.
</td>
</tr>
<tr>
<td><code>height</code> & <code>center.y</code> specified</td>
<td>
Child positioned with center at <code>center.y</code>, using specified <code>height</code>;
any <code>bottom</code> value is ignored.
</td>
</tr>
<tr>
<td><code>height</code> & <code>bottom</code> specified</td>
<td>Child positioned <code>bottom</code> units from parent's bottom, using specified <code>height</code>.</td>
</tr>
<tr>
<td><code>top</code> & <code>center.y</code> specified</td>
<td>
Child positioned with top edge <code>top</code> units from parent's top and center at
<code>center.y</code>. Height is determined implicitly; any <code>bottom</code> value is ignored.
</td>
</tr>
<tr>
<td><code>top</code> & <code>bottom</code> specified</td>
<td>
Child positioned with top edge <code>top</code> units from parent's top and bottom edge
<code>bottom</code> units from parent's bottom. Height is determined implicitly.
</td>
</tr>
<tr>
<td>Only <code>top</code> specified</td>
<td>
Child positioned <code>top</code> units from parent's top, and uses the default height
calculation for the view type.
</td>
</tr>
<tr>
<td><code>center.y</code> and <code>bottom</code> specified</td>
<td>
Child positioned with center at <code>center.y</code> and bottom edge <code>bottom</code>
units from parent's bottom. Height is determined implicitly.
</td>
</tr>
<tr>
<td>Only <code>center.y</code> specified</td>
<td>Child positioned with center at <code>center.y</code>, and uses the default height calculation for the view type.</td>
</tr>
<tr>
<td>Only <code>bottom</code> specified</td>
<td>Child positioned with bottom edge <code>bottom</code> units from parent's bottom, and uses the default height calculation for the view type.</td>
</tr>
<tr>
<td><code>height</code>, <code>top</code>, <code>center.y</code>, and <code>bottom</code> unspecified</td>
<td>Child entered vertically in the parent and uses the default height calculation for the child view type.</td>
</tr>
</tbody>
</table>Horizontal positioning works like vertical positioning, except that the
precedence iswidth,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 outtopunits 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'sbottomvalue plus the lower child'stopvalue.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 (thehorizontalWrapproperty istrue).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. When the
horizontalWrapproperty 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
toporbottomis specified, the child is centered in the
row. - If either
toporbottomis specified, the child is aligned to either
the top or bottom of the row, with the specified amount of padding. - If both
topandbottomis specified for a given child, the properties
are both treated as padding.
If the
horizontalWrapproperty is false, the behavior is more equivalent to a vertical layout.
Children are laid or horizontally from left to right in a single row. Theleftand
rightproperties are used as padding between the children, and thetopandbottom
properties are used to position the children vertically.Defaults to Composite layout.
- If neither
left#
Type: Number, String
Window's left position, in platform-specific units.
On Android, this property has no effect.
leftNavButtons#
Type: Array<Titanium.UI.View>
An Array of views to show in the left nav bar area.
lifecycleContainer#
Type: Titanium.UI.Window, Titanium.UI.TabGroup
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.
modal#
Type: Boolean
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.
navigationWindow#
Type: Titanium.UI.NavigationWindow
The Titanium.UI.NavigationWindow instance hosting this window.
Returns the navigation window that hosts this window. Returns null if the window is not
hosted by a navigation window.
onBack#
Type: Callback<void>
Callback function that overrides the default behavior when the user presses the Back
button.
This was separated from the Titanium.UI.Window.androidback event. You need to define this
callback if you explicitly want to override the back button behavior.
opacity#
Type: Number
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.
orientation#
Type: Number
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.
orientationModes#
Type: Array<Number>
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, orientation behavior is dependent on the Android SDK level
of the device itself. Devices running Android 2.3 and above support "sensor portrait
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.
overrideCurrentAnimation#
Type: Boolean
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.
Defaults to undefined but behaves as false
previewContext#
Type: Titanium.UI.iOS.PreviewContext
The preview context used in the 3D-Touch feature "Peek and Pop".
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 iOS 9 or later and supporting 3D-Touch.
It is ignored on older devices and can manually be checked using Titanium.UI.iOS.forceTouchSupported.
pullBackgroundColor#
Type: String, Titanium.UI.Color
Background color of the wrapper view when this view is used as either Titanium.UI.ListView.pullView or Titanium.UI.TableView.headerPullView.
Defaults to undefined. Results in a light grey background color on the wrapper view.
rect#
Type: DimensionWithAbsolutes
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.
right#
Type: Number, String
Window's right position, in platform-specific units.
On Android, this property has no effect.
rightNavButtons#
Type: Array<Titanium.UI.View>
An Array of views to show in the right nav bar area.
rotation#
Type: Number
Clockwise 2D rotation of the view in degrees.
Translation values are applied to the static post layout value.
rotationX#
Type: Number
Clockwise rotation of the view in degrees (x-axis).
Translation values are applied to the static post layout value.
rotationY#
Type: Number
Clockwise rotation of the view in degrees (y-axis).
Translation values are applied to the static post layout value.
safeAreaPadding#
Type: Padding
The padding needed to safely display content without it being overlapped by the screen insets and notches.
When setting Window.extendSafeArea to true, the system's insets
such as a translucent status bar, translucent navigation bar, and/or camera notches will be allowed to
overlay on top of the window's content. In this case, it is the app developer's responsibility to
prevent these insets from overlapping key content such as buttons. This property provides the amount of
space needed to be added to the left, top, right, and bottom edges of the window root view to do this.
This property won't return values greater than zero until the window has been opened. It is recommended
that you read this property via a Titanium.UI.View.postlayout event listener since the padding values can
change when when the app's orientation changes or when showing/hiding the action bar.
If the Window.extendSafeArea property is set false, then the
returned padding will be all zeros since the root content will be positioned between all insets.
Below is an example on how to set up a safe-area view container using this property.
// Set up a window with a translucent top status bar and translucent nav bar.
// This will only work on Android 4.4 and newer OS versions.
var win = Ti.UI.createWindow({
extendSafeArea: true,
theme: 'Theme.Titanium.NoTitleBar',
windowFlags: Ti.UI.Android.FLAG_TRANSLUCENT_NAVIGATION | Ti.UI.Android.FLAG_TRANSLUCENT_STATUS
});
// Set up a safe-area view to be laid out between the system insets.
// You should use this as a container for child views.
var safeAreaView = Ti.UI.createView({
backgroundColor: 'green'
});
win.add(safeAreaView);
win.addEventListener('postlayout', function() {
// Update the safe-area view's dimensions after every 'postlayout' event.
safeAreaView.applyProperties(win.safeAreaPadding);
});
// Open the window.
win.open();
scaleX#
Type: Number
Scaling of the view in x-axis in pixels.
Translation values are applied to the static post layout value.
scaleY#
Type: Number
Scaling of the view in y-axis in pixels.
Translation values are applied to the static post layout value.
size#
Type: Dimension
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.
softKeyboardOnFocus#
Type: Number
Determines keyboard behavior when this view is focused. Defaults to Titanium.UI.Android.SOFT_KEYBOARD_DEFAULT_ON_FOCUS.
splitActionBar (deprecated)#
Type: Boolean
Boolean value to enable split action bar.
splitActionBar must be set before opening the window.
This property indicates if the window should use a split action bar
statusBarStyle#
Type: Number
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.
sustainedPerformanceMode#
Type: Boolean
Maintain a sustainable level of performance.
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 for further info.
theme#
Type: String
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.
tintColor#
Type: String, Titanium.UI.Color
The view's tintColor
This property is a direct correspondent of the tintColor property of UIView on iOS. If no value is specified,
the tintColor of the View is inherited from its superview.
titleAttributes#
Type: titleAttributesParams
Title text attributes of the window.
Use this property to specify the color, font and shadow attributes of the title.
tooltip#
Type: String
The default text to display in the control's tooltip.
Assigning a value to this property causes the tool tip to be displayed for the view.
Setting the property to null cancels the display of the tool tip for the view.
Note: This property is only used for apps targeting macOS Catalyst.
top#
Type: Number, String
Window's top position, in platform-specific units.
On Android, this property has no effect.
touchEnabled#
Type: Boolean
Determines whether view should receive touch events.
If false, will forward the events to peers.
touchFeedback#
Type: Boolean
A material design visual construct that provides an instantaneous visual confirmation of touch point.
Touch feedback is only applied to a view's background. It is never applied to the view's foreground content
such as a Titanium.UI.ImageView's image.
For Titanium versions older than 9.1.0, touch feedback only works if you set the
Titanium.UI.View.backgroundColor property to a non-transparent color.
touchFeedbackColor#
Type: String
Optional touch feedback ripple color. This has no effect unless touchFeedback is true.
Defaults to provided theme color.
transform#
Type: Titanium.UI.Matrix2D, Titanium.UI.Matrix3D
Transformation matrix to apply to the view.
Android only supports Matrix2D transforms.
transitionName#
Type: String
A name to identify this view in activity transition.
Name should be unique in the View hierarchy.
translationX#
Type: Number
Horizontal location of the view relative to its left position in pixels.
Translation values are applied to the static post layout value.
translationY#
Type: Number
Vertical location of the view relative to its top position in pixels.
Translation values are applied to the static post layout value.
translationZ#
Type: Number
Depth of the view relative to its elevation in pixels.
Translation values are applied to the static post layout value.
uiFlags#
Type: Number
Additional UI flags to set on the Activity Window.
See WindowManager.LayoutParams for a
list of additional flags that can be assigned to this property. For example, you can use 8192 (SYSTEM_UI_FLAG_LIGHT_STATUS_BAR) to set
the status bar text color to a dark color.
verticalMotionEffect#
Type: MinMaxOptions
Adds a vertical parallax effect to the view
Note that the parallax effect only happens by tilting the device so results can not be seen on Simulator.
To clear all motion effects, use the Titanium.UI.clearMotionEffects method.
viewShadowColor#
Type: String, Titanium.UI.Color
Determines the color of the shadow.
iOS Defaults to undefined. Behaves as if transparent. Android default is black.
On Android you can set <item name="android:ambientShadowAlpha">0.5</item> and
<item name="android:spotShadowAlpha">0.5</item> in your theme to change the
opacity.
viewShadowOffset#
Type: Point
Determines the offset for the shadow of the view.
Defaults to undefined. Behaves as if set to (0,-3)
viewShadowRadius#
Type: Number, String
Determines the blur radius used to create the shadow.
Defaults to undefined. Behaves as if set to 3. Accepts density units as of 10.0.1.
width#
Type: Number, String
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 theSIZEor
FILLconstants 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.
windowFlags#
Type: Number
Additional flags to set on the Activity Window.
Sets flags such as Titanium.UI.Android.FLAG_TRANSLUCENT_NAVIGATION and
Titanium.UI.Android.FLAG_TRANSLUCENT_STATUS. When using multiple flags, you must bitwise-or them together.
See WindowManager.LayoutParams for
list of additional flags that you can assign to this property. You can assign these Java flags to this property
by using their numeric constant.
Setting Titanium.UI.Window.fullscreen to true automatically sets the WindowManager.LayoutParams.FLAG_FULLSCREEN
flag. Setting Titanium.UI.Window.flagSecure to true automatically sets the WindowManager.LayoutParams.FLAG_SECURE flag.
Use Titanium.UI.Android.STATUS_BAR_LIGHT to set the status bar text color to light mode.
windowPixelFormat#
Type: Number
Set the pixel format for the Activity's Window.
For more information on pixel formats, see
Android SDK Window.setFormat
windowSoftInputMode#
Type: Number
Determines whether a window's soft input area (ie software keyboard) is visible
as it receives focus and how the window behaves in order to accommodate 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.
This property is capable of representing two settings from the soft input visibility
constants 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.
zIndex#
Type: Number
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.
Defaults to undefined.
Methods #
add #
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:
- ActivityIndicator
- Button
- ImageView
- Label
- ProgressBar
- SearchBar
- Slider
- Switch
- TableView
- TextArea
- TextField
- WebView
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 position 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 theaddmethod are displayed on top of these buttons. -
Picker. Can only hold
PickerRowsandPickerColumns, which
are added using theaddmethod. Adding other types of views to aPickeris not
supported. -
TableView is a specialized container for
TableViewSectionandTableViewRowobjects. These objects must be
added using the properties and methods thatTableViewprovides
for adding and removing sections and rows.On some platforms, it is possible to add arbitrary child views to a table view
using theaddmethod. However, this is not guaranteed to work on all platforms,
and in general, should be avoided. -
TableViewSection is a specialized container
forTableViewRowobjects, which are added using theaddmethod. Theaddmethod
onTableViewSectioncan only be used to addTableViewRowobjects. -
Toolbar is designed to hold buttons and certain
other controls, added to itsitemsarray. Views added using theaddmethod are
displayed on top of the controls in theitemsarray. -
The
Tab,TabGroup,NavigationWindowandSplitWindowobjects 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.iOS.SplitWindow, Titanium.UI.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.NavigationWindow,
Titanium.UI.iOS.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.
| Name | Type | Summary | Optional |
|---|---|---|---|
view | Titanium.UI.View, Array<Titanium.UI.View> | View to add to this view's hierarchy. You may pass an array of views, e.g. view.add([subview1, subview2]. | No |
addEventListener #
Adds the specified callback as an event listener for the named event.
| Name | Type | Summary | Optional |
|---|---|---|---|
name | String | Name of the event. | No |
callback | Callback<Titanium.Event> | Callback function to invoke when the event is fired. | No |
addSharedElement #
Adds a common UI element to participate in window transition animation.
Available from Android 5.0. Use the current window's UI element that is contextually shared with the other window.
| Name | Type | Summary | Optional |
|---|---|---|---|
view | Titanium.UI.View | The shared view from the current window. | No |
transitionName | String | The assigned common transition name of UI elements in both windows. | No |
animate #
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 on SDKs older than 9.1.0 - 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.
As of SDK 9.1.0, the final values of the animation will be set on the view just before the complete event and/or the callback is fired.
The rect property can be used to determine the actual size and
position of the view.
| Name | Type | Summary | Optional |
|---|---|---|---|
animation | Titanium.UI.Animation, Dictionary<Titanium.UI.Animation> | Either a dictionary of animation properties or an Animation object. | No |
callback | Callback<Object> | Function to be invoked upon completion of the animation. | Yes |
applyProperties #
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.
| Name | Type | Summary | Optional |
|---|---|---|---|
props | Dictionary | A dictionary of properties to apply. | No |
clearMotionEffects #
Removes all previously added motion effects.
Use this method together with Titanium.UI.horizontalMotionEffect and Titanium.UI.verticalMotionEffect.
close #
Closes the window.
Android only supports the argument type closeWindowParams.
| Name | Type | Summary | Optional |
|---|---|---|---|
params | Titanium.UI.Animation, Dictionary<Titanium.UI.Animation>, closeWindowParams | Animation or display properties to use when closing the window. | Yes |
Returns: Promise<any> — Starting in SDK 10.0.0, this method returns a `Promise` that will be resolved once the window is closed,
akin to adding a one-time listener for the `close` event. If the window fails to close (for example, because
it was not yet open) the `Promise` will be rejected.
closeWindow #
Closes a window and removes it from the navigation window.
| Name | Type | Summary | Optional |
|---|---|---|---|
window | Titanium.UI.Window | Window to close. | No |
options | Dictionary | Options supporting a single animated boolean property to determine whether the windowwill be animated (default) while being closed (default: true). | No |
convertPointToView #
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.
| Name | Type | Summary | Optional |
|---|---|---|---|
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 beconverted into numbers, an exception will be raised. | No |
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. | No |
Returns: Point
fireEvent #
Fires a synthesized event to any registered listeners.
| Name | Type | Summary | Optional |
|---|---|---|---|
name | String | Name of the event. | No |
event | Dictionary | A dictionary of keys and values to add to the Titanium.Event object sent to the listeners. | Yes |
getViewById #
Returns the matching view of a given view ID.
| Name | Type | Summary | Optional |
|---|---|---|---|
id | String | The ID of the view that should be returned. Use the id property in your views toenable it for indexing in this method. | No |
Returns: Titanium.UI.View
hide #
Hides this view.
| Name | Type | Summary | Optional |
|---|---|---|---|
options | AnimatedOptions | Animation options for Android only. Since SDK 5.1.0 and used only on Android 5.0+ Determines whether to enable a circular reveal animation. Note that the default here is equivalent to passing in { animated: false } | Yes |
hideNavBar #
Hides the navigation bar.
If the window is not displayed in a Titanium.UI.NavigationWindow, this method has no effect.
| Name | Type | Summary | Optional |
|---|---|---|---|
options | AnimatedOptions | Options dictionary supporting a single animated boolean property to determine whetherthe navigation bar will be animated (default) while being hidden. Note that the default here is equivalent to { animated: true } | Yes |
hideTabBar #
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.
hideToolbar #
Makes the bottom toolbar invisible.
If the window is not displayed in a Titanium.UI.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.
| Name | Type | Summary | Optional |
|---|---|---|---|
options | AnimatedOptions | Options dictionary supporting a single animated boolean property to determine whetherthe toolbar will be animated (default) while being hidden. Note that the default here is equivalent to { animated: true } | Yes |
insertAt #
Inserts a view at the specified position in the children array.
Useful if the layout property is set to horizontal or vertical.
| Name | Type | Summary | Optional |
|---|---|---|---|
params | ViewPositionOptions | Pass an object that specifies the view to insert and optionally at which position (defaults to end) | No |
open #
Opens the window.
| Name | Type | Summary | Optional |
|---|---|---|---|
params | openWindowParams | Animation or display properties to use when opening the window. | Yes |
Returns: Promise<any> — Starting in SDK 10.0.0, this method returns a `Promise` that will be resolved once the window is opened,
akin to adding a one-time listener for the `open` event. If the window fails to open (for example, because
it is already opened or opening) the `Promise` will be rejected.
openWindow #
Opens a window within the navigation window.
| Name | Type | Summary | Optional |
|---|---|---|---|
window | Titanium.UI.Window | Window to open. | No |
options | Dictionary | Options supporting a single animated boolean property to determine whether the windowwill be animated (default) while being opened (default: true). | No |
popToRootWindow #
Closes all windows that are currently opened inside the navigation window.
Note that only the close event of the most recently opened window is fired.
| Name | Type | Summary | Optional |
|---|---|---|---|
options | Dictionary | Options supporting a single animated boolean property to determine whether the windowswill be animated while being closed (default: false). | No |
remove #
Removes a child view from this view's hierarchy.
| Name | Type | Summary | Optional |
|---|---|---|---|
view | Titanium.UI.View | View to remove from this view's hierarchy. | No |
removeAllSharedElements #
Clears all added shared elements.
Available from Android 5.0. Use this method to clear all shared elements. This will not remove the views from view hierarchy.
removeEventListener #
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 | Type | Summary | Optional |
|---|---|---|---|
name | String | Name of the event. | No |
callback | Callback<Titanium.Event> | Callback function to remove. Must be the same function passed to addEventListener. | No |
replaceAt #
Replaces a view at the specified position in the children array.
Useful if the layout property is set to horizontal or vertical.
| Name | Type | Summary | Optional |
|---|---|---|---|
params | ViewPositionOptions | Pass an object with the view to insert and the position of the view to replace. In this case the position property is required. | No |
show #
Makes this view visible.
| Name | Type | Summary | Optional |
|---|---|---|---|
options | AnimatedOptions | Animation options for Android only. Since SDK 5.1.0 and only used on Android 5.0+ Determines whether to enable a circular reveal animation. Note that the default here is equivalent to passing in { animated: false } | Yes |
showNavBar #
Makes the navigation bar visible.
If the window is not displayed in a Titanium.UI.NavigationWindow, this method has no effect.
| Name | Type | Summary | Optional |
|---|---|---|---|
options | AnimatedOptions | Options dictionary supporting a single animated boolean property to determine whetherthe navigation bar will be animated (default) while being shown. Note that the default here is equivalent to { animated: true } | Yes |
showTabBar #
Shows the tab bar. Must be called before opening the window.
To show the tab bar when opening a window as a child of a tab, call
showTabBar or set tabBarHidden to false before opening the window.
If the window is not a child of a tab, this method has no effect.
showToolbar #
Makes the bottom toolbar visible.
If the window is not displayed in a Titanium.UI.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.
| Name | Type | Summary | Optional |
|---|---|---|---|
options | AnimatedOptions | Options dictionary supporting a single animated boolean property to determine whetherthe toolbar will be animated (default) while being shown. Note that the default here is equivalent to { animated: true } | Yes |
toImage #
Returns an image of the rendered view, as a Blob.
The honorScaleFactor argument is only supported on iOS.
| Name | Type | Summary | Optional |
|---|---|---|---|
callback | Callback<Titanium.Blob> | Function to be invoked upon completion. If non-null, this method will be performed asynchronously. If null, it will be performed immediately. | Yes |
honorScaleFactor | Boolean | 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. | Yes |
Returns: Titanium.Blob
Events #
androidback #
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.
androidcamera #
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 window.
androidfocus #
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 window.
androidsearch #
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 window.
androidvoldown #
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 window.
androidvolup #
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 window.
blur #
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.
click #
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.
| Name | Type | Summary |
|---|---|---|
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. |
obscured | Boolean | Returns true if the click passed through an overlapping window belonging to another app.This is a security feature to protect an app from "tapjacking", where a malicious app can use a system overlay to intercept touch events in your app or to trick the end-user to tap on UI in your app intended for the overlay. |
close #
Fired when the window is closed.
dblclick #
Fired when the device detects a double click against the view.
| Name | Type | Summary |
|---|---|---|
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. |
obscured | Boolean | Returns true if the double click passed through an overlapping window belonging to another app.This is a security feature to protect an app from "tapjacking", where a malicious app can use a system overlay to intercept touch events in your app or to trick the end-user to tap on UI in your app intended for the overlay. |
doubletap #
Fired when the device detects a double tap against the view.
| Name | Type | Summary |
|---|---|---|
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. |
obscured | Boolean | Returns true if the double tap passed through an overlapping window belonging to another app.This is a security feature to protect an app from "tapjacking", where a malicious app can use a system overlay to intercept touch events in your app or to trick the end-user to tap on UI in your app intended for the overlay. |
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.
keypressed #
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.
| Name | Type | Summary |
|---|---|---|
keyCode | Number | The code for the physical key that was pressed. For more details, see KeyEvent. This API is experimental and subject to change. |
longclick #
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.
longpress #
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.
| Name | Type | Summary |
|---|---|---|
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. |
obscured | Boolean | Returns true if the long press passed through an overlapping window belonging to another app.This is a security feature to protect an app from "tapjacking", where a malicious app can use a system overlay to intercept touch events in your app or to trick the end-user to tap on UI in your app intended for the overlay. |
open #
Fired when the window is opened.
The listener for this event must be defined before this window
is opened.
pinch #
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.
| Name | Type | Summary |
|---|---|---|
scale | Number | The scale factor relative to the points of the two touches in screen coordinates. |
velocity | Number | The velocity of the pinch in scale factor per second. |
time | Number | The event time of the current event being processed. |
timeDelta | Number | The time difference in milliseconds between the previous accepted scaling event and the current scaling event. |
currentSpan | Number | The average distance between each of the pointers forming the gesture in progress through the focal point. |
currentSpanX | Number | The average X distance between each of the pointers forming the gesture in progress through the focal point. |
currentSpanY | Number | The average Y distance between each of the pointers forming the gesture in progress through the focal point. |
previousSpan | Number | The previous average distance between each of the pointers forming the gesture in progress through the focal point. |
previousSpanX | Number | The previous average X distance between each of the pointers forming the gesture in progress through the focal point. |
previousSpanY | Number | The previous average Y distance between each of the pointers forming the gesture in progress through the focal point. |
focusX | Number | The X coordinate of the current gesture's focal point. |
focusY | Number | The Y coordinate of the current gesture's focal point. |
inProgress | Boolean | Returns true if a scale gesture is in progress, false otherwise. |
postlayout #
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.
rotate #
Fired when the device detects a two finger rotation.
This event is fired when doing a two finger rotation and returning the angle.
The event occurs continuously until a finger is lifted again.
| Name | Type | Summary |
|---|---|---|
rotate | Number | Rotation in degrees. |
singletap #
Fired when the device detects a single tap against the view.
| Name | Type | Summary |
|---|---|---|
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. |
obscured | Boolean | Returns true if the single tap passed through an overlapping window belonging to another app.This is a security feature to protect an app from "tapjacking", where a malicious app can use a system overlay to intercept touch events in your app or to trick the end-user to tap on UI in your app intended for the overlay. |
swipe #
Fired when the device detects a swipe gesture against the view.
| Name | Type | Summary |
|---|---|---|
direction | String | Direction of the swipe--either 'left', 'right', 'up', or 'down'. |
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. |
obscured | Boolean | Returns true if the swipe passed through an overlapping window belonging to another app.This is a security feature to protect an app from "tapjacking", where a malicious app can use a system overlay to intercept touch events in your app or to trick the end-user to tap on UI in your app intended for the overlay. |
touchcancel #
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.
| Name | Type | Summary |
|---|---|---|
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. |
force | Number | 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. |
size | Number | The current size of the touch area. Note: This property is only available on some Android devices. |
maximumPossibleForce | Number | 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. |
altitudeAngle | Number | 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. |
timestamp | Number | 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. |
azimuthUnitVectorInViewX | Number | 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. |
azimuthUnitVectorInViewY | Number | 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. |
obscured | Boolean | Returns true if the touch passed through an overlapping window belonging to another app.This is a security feature to protect an app from "tapjacking", where a malicious app can use a system overlay to intercept touch events in your app or to trick the end-user to tap on UI in your app intended for the overlay. |
touchend #
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.
| Name | Type | Summary |
|---|---|---|
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. |
force | Number | 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. |
size | Number | The current size of the touch area. Note: This property is only available on some Android devices. |
maximumPossibleForce | Number | 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. |
altitudeAngle | Number | 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. |
timestamp | Number | 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. |
azimuthUnitVectorInViewX | Number | 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. |
azimuthUnitVectorInViewY | Number | 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. |
obscured | Boolean | Returns true if the touch passed through an overlapping window belonging to another app.This is a security feature to protect an app from "tapjacking", where a malicious app can use a system overlay to intercept touch events in your app or to trick the end-user to tap on UI in your app intended for the overlay. |
touchmove #
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
| Name | Type | Summary |
|---|---|---|
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. |
force | Number | 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. |
size | Number | The current size of the touch area. Note: This property is only available on some Android devices. |
maximumPossibleForce | Number | 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. |
altitudeAngle | Number | 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. |
timestamp | Number | 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. |
azimuthUnitVectorInViewX | Number | 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. |
azimuthUnitVectorInViewY | Number | 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. |
obscured | Boolean | Returns true if the touch passed through an overlapping window belonging to another app.This is a security feature to protect an app from "tapjacking", where a malicious app can use a system overlay to intercept touch events in your app or to trick the end-user to tap on UI in your app intended for the overlay. |
touchstart #
Fired as soon as the device detects a touch gesture.
| Name | Type | Summary |
|---|---|---|
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. |
force | Number | 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. |
size | Number | The current size of the touch area. Note: This property is only available on some Android devices. |
maximumPossibleForce | Number | 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. |
altitudeAngle | Number | 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. |
timestamp | Number | 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. |
azimuthUnitVectorInViewX | Number | 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. |
azimuthUnitVectorInViewY | Number | 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. |
obscured | Boolean | Returns true if the touch passed through an overlapping window belonging to another app.This is a security feature to protect an app from "tapjacking", where a malicious app can use a system overlay to intercept touch events in your app or to trick the end-user to tap on UI in your app intended for the overlay. |
twofingertap #
Fired when the device detects a two-finger tap against the view.
| Name | Type | Summary |
|---|---|---|
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. |
obscured | Boolean | Returns true if the tap passed through an overlapping window belonging to another app.This is a security feature to protect an app from "tapjacking", where a malicious app can use a system overlay to intercept touch events in your app or to trick the end-user to tap on UI in your app intended for the overlay. |
Examples #
Simple Navigation Window
Creates a navigation window 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 = Ti.UI.createWindow({
backgroundColor: 'red',
title: 'Red Window'
});
var win1 = Ti.UI.iOS.createNavigationWindow({
window: win2
});
var win3 = Ti.UI.createWindow({
backgroundColor: 'blue',
title: 'Blue Window'
});
var button = Ti.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>function openBlueWindow(e) {
var win3 = Alloy.createController('bluewin').getView();
$.win1.openWindow(win3);
}
$.win1.open();<Alloy>
<Window id="win3" title="Blue Window" backgroundColor="blue">
<Button onClick="closeWindow">Close Window</Button>
</Window>
</Alloy>function closeWindow(){
$.win3.close();
}