# Titanium.UI.iOS.BlurView
A Titanium.UI.iOS.BlurView object gives you an easy way implement some complex visual effects. The blur effect is applied to every view the blur view is added to by default. You can also place the blur view above other views and all visible views layered under the blur view are blurred as well.
For more information on BlurView, please refer to the official Apple documentation. Note: Apple introduced two new constants BLUR_EFFECT_STYLE_REGULAR and BLUR_EFFECT_STYLE_PROMINENT in iOS 10. These are internally mapped to BLUR_EFFECT_STYLE_LIGHT and BLUR_EFFECT_STYLE_EXTRA_LIGHT.
# Examples
# Basic Blur View
The following example shows how to create a simple blur view:
var win = Ti.UI.createWindow({
backgroundColor: "#fff"
});
// Reference image (or view)
var img = Ti.UI.createImageView({
image: "/default_app_logo.png",
top: 100,
width: 300,
height: 300
});
// Blur view
var blur = Ti.UI.iOS.createBlurView({
width: Ti.UI.FILL,
height: Ti.UI.FILL
});
img.add(blur);
// Effect controls
var tabs = Ti.UI.iOS.createTabbedBar({
labels: ["Extra light", "Light", "Dark"],
bottom: 100
});
// Available blur effects
var effects = [
Ti.UI.iOS.BLUR_EFFECT_STYLE_EXTRA_LIGHT,
Ti.UI.iOS.BLUR_EFFECT_STYLE_LIGHT,
Ti.UI.iOS.BLUR_EFFECT_STYLE_DARK,
];
tabs.addEventListener("click", function(e) {
blur.effect = effects[e.index];
});
win.add(tabs);
win.add(img);
win.open();
# Properties
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.
Default: false
# accessibilityHint
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: null
# accessibilityLabel
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.
Defaults to Title or label of the control.
# accessibilityValue
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.
Defaults to State or value of the control.
# anchorPoint
Coordinate of the view about which to pivot an animation.
Used on iOS only. For Android, use 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 READONLY
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, Titanium.UI.Button
returns Ti.UI.Button
.
# backgroundColor
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
.
# backgroundGradient
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
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
Size of the left end cap.
See the section on backgroundLeftCap and backgroundTopCap behavior on iOS in Titanium.UI.View.
Default: 0
# backgroundRepeat
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
# backgroundTopCap
Size of the top end cap.
See the section on backgroundLeftCap and backgroundTopCap behavior on iOS in Titanium.UI.View.
Default: 0
# borderColor
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
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)"
.
Default: 0
# borderWidth
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
# bottom
View's bottom position, in platform-specific units.
This position is relative to the view's parent. Exact interpretation depends on the parent view's layout property. Can be either a float value or a dimension string (for example, '50%' or '10px').
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
.
# bubbleParent
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
# center
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
View's clipping behavior.
Setting this to CLIP_MODE_ENABLED enforces all child views to be clipped to this views bounds. Setting this to CLIP_MODE_DISABLED allows child views to be drawn outside the bounds of this view. When set to 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 CLIP_MODE_DEFAULT.
# effect
The effect you provide for the view.
- Titanium.UI.iOS.BLUR_EFFECT_STYLE_EXTRA_LIGHT
- Titanium.UI.iOS.BLUR_EFFECT_STYLE_LIGHT
- Titanium.UI.iOS.BLUR_EFFECT_STYLE_DARK
- Titanium.UI.iOS.BLUR_EFFECT_STYLE_REGULAR
- Titanium.UI.iOS.BLUR_EFFECT_STYLE_PROMINENT
- Titanium.UI.iOS.BLUR_EFFECT_STYLE_SYSTEM_ULTRA_THIN_MATERIAL
- Titanium.UI.iOS.BLUR_EFFECT_STYLE_SYSTEM_THIN_MATERIAL
- Titanium.UI.iOS.BLUR_EFFECT_STYLE_SYSTEM_MATERIAL
- Titanium.UI.iOS.BLUR_EFFECT_STYLE_SYSTEM_THICK_MATERIAL
- Titanium.UI.iOS.BLUR_EFFECT_STYLE_SYSTEM_CHROME_MATERIAL
- Titanium.UI.iOS.BLUR_EFFECT_STYLE_SYSTEM_ULTRA_THIN_MATERIAL_LIGHT
- Titanium.UI.iOS.BLUR_EFFECT_STYLE_SYSTEM_THIN_MATERIAL_LIGHT
- Titanium.UI.iOS.BLUR_EFFECT_STYLE_SYSTEM_MATERIAL_LIGHT
- Titanium.UI.iOS.BLUR_EFFECT_STYLE_SYSTEM_THICK_MATERIAL_LIGHT
- Titanium.UI.iOS.BLUR_EFFECT_STYLE_SYSTEM_CHROME_MATERIAL_LIGHT
- Titanium.UI.iOS.BLUR_EFFECT_STYLE_SYSTEM_ULTRA_THIN_MATERIAL_DARK
- Titanium.UI.iOS.BLUR_EFFECT_STYLE_SYSTEM_THIN_MATERIAL_DARK
- Titanium.UI.iOS.BLUR_EFFECT_STYLE_SYSTEM_MATERIAL_DARK
- Titanium.UI.iOS.BLUR_EFFECT_STYLE_SYSTEM_THICK_MATERIAL_DARK
- Titanium.UI.iOS.BLUR_EFFECT_STYLE_SYSTEM_CHROME_MATERIAL_DARK
Default: undefined (no effect is applied)
# height
View height, in platform-specific units.
Defaults to: If undefined, defaults to either FILL or 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. The view should size itself to fit its contents.
- FILL. The view should size itself to fill its parent.
- 'auto'. Represents the default sizing behavior for a given type of
view. The use of 'auto' is deprecated, and should be replaced with the
SIZE
orFILL
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.
# horizontalMotionEffect
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
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
# id
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 getViewById method.
# layout
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
,right
andcenter
). If no positioning properties are specified, the child is centered.The child is always sized based on its
width
andheight
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 bothleft
andcenter.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
andbottom
are all specified, theheight
andcenter.y
values take precedence.)Scenario Behavior height
&top
specifiedChild positioned top
unit from parent's top, using specifiedheight
; anycenter.y
andbottom
values are ignored.height
¢er.y
specifiedChild positioned with center at center.y
, using specifiedheight
; anybottom
value is ignored.height
&bottom
specifiedChild positioned bottom
units from parent's bottom, using specifiedheight
.top
¢er.y
specifiedChild positioned with top edge top
units from parent's top and center atcenter.y
. Height is determined implicitly; anybottom
value is ignored.top
&bottom
specifiedChild positioned with top edge top
units from parent's top and bottom edgebottom
units from parent's bottom. Height is determined implicitly.Only top
specifiedChild positioned top
units from parent's top, and uses the default height calculation for the view type.center.y
andbottom
specifiedChild positioned with center at center.y
and bottom edgebottom
units from parent's bottom. Height is determined implicitly.Only center.y
specifiedChild positioned with center at center.y
, and uses the default height calculation for the view type.Only bottom
specifiedChild positioned with bottom edge bottom
units from parent's bottom, and uses the default height calculation for the view type.height
,top
,center.y
, andbottom
unspecifiedChild entered 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 outtop
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'sbottom
value plus the lower child'stop
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 (thehorizontalWrap
property 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
horizontalWrap
property is set to true, the first row is placed at the top of the parent view, and successive rows are placed below the first row. Each child is positioned vertically within its row somewhat like composite layout mode. In particular:- If neither
top
orbottom
is specified, the child is centered in the row. - If either
top
orbottom
is specified, the child is aligned to either the top or bottom of the row, with the specified amount of padding. - If both
top
andbottom
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. Theleft
andright
properties are used as padding between the children, and thetop
andbottom
properties are used to position the children vertically.Defaults to Composite layout.
- If neither
# left
View's left position, in platform-specific units.
This position is relative to the view's parent. Exact interpretation depends on the parent view's layout property. Can be either a float value or a dimension string (for example, '50%' or '10px').
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
.
# opacity
Opacity of this view, from 0.0 (transparent) to 1.0 (opaque). Defaults to 1.0 (opaque).
# 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 iOS9 or later and supporting 3D-Touch. It is ignored on older devices and can manually be checked using forceTouchSupported.
# pullBackgroundColor
Background color of the wrapper view when this view is used as either pullView or headerPullView.
Defaults to undefined
. Results in a light grey background color on the wrapper view.
# rect READONLY
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
View's right position, in platform-specific units.
This position is relative to the view's parent. Exact interpretation depends on the parent view's layout property. Can be either a float value or a dimension string (for example, '50%' or '10px').
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
.
# rotation
Clockwise 2D rotation of the view in degrees.
Translation values are applied to the static post layout value.
# size READONLY
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.
# tintColor
The view's tintColor
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: null
# tooltip
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
The view's top position.
This position is relative to the view's parent. Exact interpretation depends on the parent view's layout property. Can be either a float value or a dimension string (for example, '50%' or '10px').
This is an input property for specifying where the view should be positioned, and does not represent the view's calculated position.
# touchEnabled
Determines whether view should receive touch events.
If false, will forward the events to peers.
Default: true
# transform
Transformation matrix to apply to the view.
Android only supports Matrix2D transforms.
Default: Identity matrix
# verticalMotionEffect
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
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
Determines the offset for the shadow of the view.
Defaults to undefined
. Behaves as if set to (0,-3)
# viewShadowRadius
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
View's width, in platform-specific units.
Defaults to: If undefined, defaults to either FILL or 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. The view should size itself to fit its contents.
- FILL. The view should size itself to fill its parent.
- 'auto'. Represents the default sizing behavior for a given type of
view. The use of 'auto' is deprecated, and should be replaced with the
SIZE
orFILL
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.
# zIndex
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:
- Titanium.UI.ActivityIndicator
- Titanium.UI.Button
- Titanium.UI.ImageView
- Titanium.UI.Label
- Titanium.UI.ProgressBar
- Titanium.UI.SearchBar
- Titanium.UI.Slider
- Titanium.UI.Switch
- Titanium.UI.TableView
- Titanium.UI.TextArea
- Titanium.UI.TextField
- Titanium.UI.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 positon other views as
siblings. For example, instead of adding a button as a child of a WebView
, you can add
the button to the web view's parent such that it appears on top of the web view.
# Special-Purpose Containers
A few view objects act as special-purpose containers--that is, they only manage
certain types of children, and many of them support a special means of adding
these children, instead of the general add
method. These containers include:
-
Titanium.UI.ButtonBar and Titanium.UI.iOS.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. -
Titanium.UI.Picker. Can only hold
PickerRows
andPickerColumns
, which are added using theadd
method. Adding other types of views to aPicker
is not supported. -
Titanium.UI.TableView is a specialized container for
TableViewSection
andTableViewRow
objects. These objects must be added using the properties and methods thatTableView
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. -
Titanium.UI.TableViewSection is a specialized container for
TableViewRow
objects, which are added using theadd
method. Theadd
method onTableViewSection
can only be used to addTableViewRow
objects. -
Titanium.UI.iOS.Toolbar is designed to hold buttons and certain other controls, added to its
items
array. Views added using theadd
method are displayed on top of the controls in theitems
array. -
The
Tab
,TabGroup
,NavigationWindow
andSplitWindow
objects are special containers that manage windows. These are discussed in the "Top-Level Containers" section.
# Top-Level Containers
There are certain top-level containers that are not intended to be added as the children of other views. These top-level containers include Titanium.UI.Window, Titanium.UI.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.
Parameters
Name | Type | Description |
---|---|---|
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. |
Returns
- Type
- void
# addEventListener
Adds the specified callback as an event listener for the named event.
Parameters
Name | Type | Description |
---|---|---|
name | String | Name of the event. |
callback | Callback<Titanium.Event> | Callback function to invoke when the event is fired. |
Returns
- Type
- void
# animate
Animates this view.
The Titanium.UI.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.
Parameters
Name | Type | Description |
---|---|---|
animation | Titanium.UI.Animation | Dictionary<Titanium.UI.Animation> | Either a dictionary of animation properties or an Titanium.UI.Animation object. |
callback | Callback<Object> | Function to be invoked upon completion of the animation. |
Returns
- Type
- void
# 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.
Parameters
Name | Type | Description |
---|---|---|
props | Dictionary | A dictionary of properties to apply. |
Returns
- Type
- void
# clearMotionEffects
Removes all previously added motion effects.
Use this method together with <Titanium.UI.horizontalMotionEffect> and <Titanium.UI.verticalMotionEffect>.
Returns
- Type
- void
# 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.
Parameters
Name | Type | Description |
---|---|---|
point | Point | A point in this view's coordinate system. If this argument is missing an |
destinationView | Titanium.UI.View | View that specifies the destination coordinate system to convert to. If this argument is not a view, an exception will be raised. |
Returns
- Type
- Point
# fireEvent
Fires a synthesized event to any registered listeners.
Parameters
Name | Type | Description |
---|---|---|
name | String | Name of the event. |
event | Dictionary | A dictionary of keys and values to add to the Titanium.Event object sent to the listeners. |
Returns
- Type
- void
# getViewById
Returns the matching view of a given view ID.
Parameters
Name | Type | Description |
---|---|---|
id | String | The ID of the view that should be returned. Use the |
Returns
- Type
- Titanium.UI.View
# hide
Hides this view.
Parameters
Name | Type | Description |
---|---|---|
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 |
Returns
- Type
- void
# insertAt
Inserts a view at the specified position in the children array.
Useful if the layout
property is set to horizontal
or vertical
.
Parameters
Name | Type | Description |
---|---|---|
params | ViewPositionOptions | Pass an object that specifies the view to insert and optionally at which position (defaults to end) |
Returns
- Type
- void
# remove
Removes a child view from this view's hierarchy.
Parameters
Name | Type | Description |
---|---|---|
view | Titanium.UI.View | View to remove from this view's hierarchy. |
Returns
- Type
- void
# removeAllChildren
Removes all child views from this view's hierarchy.
Returns
- Type
- void
# 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);
Parameters
Name | Type | Description |
---|---|---|
name | String | Name of the event. |
callback | Callback<Titanium.Event> | Callback function to remove. Must be the same function passed to |
Returns
- Type
- void
# replaceAt
Replaces a view at the specified position in the children array.
Useful if the layout
property is set to horizontal
or vertical
.
Parameters
Name | Type | Description |
---|---|---|
params | ViewPositionOptions | Pass an object with the view to insert and the position of the view to replace. In this case the |
Returns
- Type
- void
# show
Makes this view visible.
Parameters
Name | Type | Description |
---|---|---|
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 |
Returns
- Type
- void
# toImage
Returns an image of the rendered view, as a Blob.
The honorScaleFactor
argument is only supported on iOS.
Parameters
Name | Type | Description |
---|---|---|
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. |
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. |
Returns
- Type
- Titanium.Blob
# Events
# 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.
Properties
Name | Type | Description |
---|---|---|
x | Number | X coordinate of the event from the |
y | Number | Y coordinate of the event from the |
obscured | Boolean | Returns 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. |
source | Object | Source object that fired the event. |
type | String | Name of the event fired. |
bubbles | Boolean | True if the event will try to bubble up if possible. |
cancelBubble | Boolean | Set to true to stop the event from bubbling. |
# dblclick
Fired when the device detects a double click against the view.
Properties
Name | Type | Description |
---|---|---|
x | Number | X coordinate of the event from the |
y | Number | Y coordinate of the event from the |
obscured | Boolean | Returns 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. |
source | Object | Source object that fired the event. |
type | String | Name of the event fired. |
bubbles | Boolean | True if the event will try to bubble up if possible. |
cancelBubble | Boolean | Set to true to stop the event from bubbling. |
# doubletap
Fired when the device detects a double tap against the view.
Properties
Name | Type | Description |
---|---|---|
x | Number | X coordinate of the event from the |
y | Number | Y coordinate of the event from the |
obscured | Boolean | Returns 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. |
source | Object | Source object that fired the event. |
type | String | Name of the event fired. |
bubbles | Boolean | True if the event will try to bubble up if possible. |
cancelBubble | Boolean | Set to true to stop the event from bubbling. |
# 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 Titanium.UI.TextArea, Titanium.UI.TextField and Titanium.UI.SearchBar.
Properties
Name | Type | Description |
---|---|---|
keyCode | Number | The code for the physical key that was pressed. For more details, see KeyEvent. This API is experimental and subject to change. |
source | Object | Source object that fired the event. |
type | String | Name of the event fired. |
bubbles | Boolean | True if the event will try to bubble up if possible. |
cancelBubble | Boolean | Set to true to stop the event from bubbling. |
# 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.
Properties
Name | Type | Description |
---|---|---|
x | Number | X coordinate of the event from the |
y | Number | Y coordinate of the event from the |
obscured | Boolean | Returns 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. |
source | Object | Source object that fired the event. |
type | String | Name of the event fired. |
bubbles | Boolean | True if the event will try to bubble up if possible. |
cancelBubble | Boolean | Set to true to stop the event from bubbling. |
# 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.
Properties
Name | Type | Description |
---|---|---|
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 |
source | Object | Source object that fired the event. |
type | String | Name of the event fired. |
bubbles | Boolean | True if the event will try to bubble up if possible. |
cancelBubble | Boolean | Set to true to stop the event from bubbling. |
# 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.
# singletap
Fired when the device detects a single tap against the view.
Properties
Name | Type | Description |
---|---|---|
x | Number | X coordinate of the event from the |
y | Number | Y coordinate of the event from the |
obscured | Boolean | Returns 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. |
source | Object | Source object that fired the event. |
type | String | Name of the event fired. |
bubbles | Boolean | True if the event will try to bubble up if possible. |
cancelBubble | Boolean | Set to true to stop the event from bubbling. |
# swipe
Fired when the device detects a swipe gesture against the view.
Properties
Name | Type | Description |
---|---|---|
direction | String | Direction of the swipe--either 'left', 'right', 'up', or 'down'. |
x | Number | X coordinate of the event's endpoint from the |
y | Number | Y coordinate of the event's endpoint from the |
obscured | Boolean | Returns 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. |
source | Object | Source object that fired the event. |
type | String | Name of the event fired. |
bubbles | Boolean | True if the event will try to bubble up if possible. |
cancelBubble | Boolean | Set to true to stop the event from bubbling. |
# 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.
Properties
Name | Type | Description |
---|---|---|
x | Number | X coordinate of the event from the |
y | Number | Y coordinate of the event from the |
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 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. |
source | Object | Source object that fired the event. |
type | String | Name of the event fired. |
bubbles | Boolean | True if the event will try to bubble up if possible. |
cancelBubble | Boolean | Set to true to stop the event from bubbling. |
# 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.
Properties
Name | Type | Description |
---|---|---|
x | Number | X coordinate of the event from the |
y | Number | Y coordinate of the event from the |
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 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. |
source | Object | Source object that fired the event. |
type | String | Name of the event fired. |
bubbles | Boolean | True if the event will try to bubble up if possible. |
cancelBubble | Boolean | Set to true to stop the event from bubbling. |
# 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
Properties
Name | Type | Description |
---|---|---|
x | Number | X coordinate of the event from the |
y | Number | Y coordinate of the event from the |
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 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. |
source | Object | Source object that fired the event. |
type | String | Name of the event fired. |
bubbles | Boolean | True if the event will try to bubble up if possible. |
cancelBubble | Boolean | Set to true to stop the event from bubbling. |
# touchstart
Fired as soon as the device detects a touch gesture.
Properties
Name | Type | Description |
---|---|---|
x | Number | X coordinate of the event from the |
y | Number | Y coordinate of the event from the |
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 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. |
source | Object | Source object that fired the event. |
type | String | Name of the event fired. |
bubbles | Boolean | True if the event will try to bubble up if possible. |
cancelBubble | Boolean | Set to true to stop the event from bubbling. |
# twofingertap
Fired when the device detects a two-finger tap against the view.
Properties
Name | Type | Description |
---|---|---|
x | Number | X coordinate of the event from the |
y | Number | Y coordinate of the event from the |
obscured | Boolean | Returns 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. |
source | Object | Source object that fired the event. |
type | String | Name of the event fired. |
bubbles | Boolean | True if the event will try to bubble up if possible. |
cancelBubble | Boolean | Set to true to stop the event from bubbling. |