# Titanium.UI.Button
A button widget that has four states: normal, disabled, focused and selected.
# Overview
Android | iOS |
---|---|
A button displays its selected state while it is being pressed. The focused state is only used on Android devices that have navigation keys or a keyboard, to indicate which button has input focus.
You can specify background images for each state, as well as button text and a button icon. On iOS, there are button styles which define appearance for each state, even if no button images are set.
Use the Titanium.UI.createButton method or a <Button>
Alloy element to create a button
(see Examples) .
# Android Platform Notes
Android uses default button images for the normal, focused, selected and disabled states. If you use a custom button image, you should specify versions for the focused and selected states (and the disabled state, if the button is ever disabled).
Android also supports setting the background color for each of the states. These are not supported on iOS.
The Material style introduced in Titanium SDK 10.0.0 will change the default look of the buttons. You can change button styles with a custom theme as follows:
<!-- Assign this custom theme to "tiapp.xml" file's android manifest application element. -->
<style name="Theme.MyTheme" parent="Theme.Titanium.Light">
<item name="textAppearanceButton">@style/TextAppearance.MyButton</item>
<item name="android:buttonStyle">@style/Widget.MyButton</item>
<item name="buttonStyle">@style/Widget.MyButton</item>
</style>
<!-- Affects the appearance of text in all material buttons. -->
<style name="TextAppearance.MyButton" parent="TextAppearance.MaterialComponents.Button">
<!-- Do not display button text in all-caps. -->
<item name="android:textAllCaps">false</item>
<!-- Remove extra spacing between characters. -->
<item name="android:letterSpacing">0</item>
</style>
<!-- Affects the appearance of all non-material system buttons. -->
<style name="Widget.MyButton" parent="Widget.AppCompat.Button">
<!-- Do not display button text in all-caps. -->
<item name="android:textAllCaps">false</item>
<!-- Remove extra spacing between characters. -->
<item name="android:letterSpacing">0</item>
</style>
# iOS Platform Notes
iOS buttons have two special properties, style
and systemButton
.
The style
property specifies the type of button decoration, and can be set to one
of the values described in Titanium.UI.iOS.SystemButtonStyle.
To use a custom button style, such as a background gradient, you may need to explicitly set
the button's style
property to PLAIN
, to prevent the button style from overriding any background color or gradient.
Also note:
- When assigning a custom image to the
backgroundImage
property, the image must be partially or wholly transparent for the background color or background gradient to be visible. - Similarly, for an assigned background gradient to show through, the
backgroundColor
may need to be set to 'transparent'.
Unlike Android, iOS doesn't supply any default background images for buttons-- system button styles serve this purpose.
The systemButton
property lets you create a predefined system-defined button,
such as the Camera or Add buttons, for use in toolbars and nav bars.
Specifically, system buttons may be used in the following locations:
- Titanium.UI.iOS.Toolbar. The
items
array can contain system buttons. - Titanium.UI.iPad.Popover. The
leftNavButton
andrightNavButton
properties can refer to system buttons - Titanium.UI.iOS.SplitWindow. The
toolbar
array can contain system buttons. - Titanium.UI.TextField. The
keyboardToolbar
array can contain system buttons. - Titanium.UI.TextArea. The
keyboardToolbar
array can contain system buttons. - Titanium.UI.Window. The
leftNavButton
andrightNavButton
properties can refer to system buttons and thetoolbar
array can contain system buttons.
Use the constants in Titanium.UI.iOS.SystemButton
to specify a button type. The size, style and decoration of system buttons is set
automatically, so you can create a button by setting only the systemButton
property.
For example:
var cancelButton = Ti.UI.createButton({ systemButton: Ti.UI.iOS.SystemButton.CANCEL });
In Alloy, you can omit the namespace when setting the systemButton
property:
<Button id="cancelbtn" systemButton="CANCEL"></Button>
Note that the systemButton
property specifies appearance, not behavior. For
example, to bring up the camera when the user presses the Camera button, you must
add an event listener to the button and call Titanium.Media.showCamera when the
button is clicked.
# iOS Pressed Button Effects
If you do not supply separate background images for the normal and selected states, iOS supplies a built-in effect for pressed buttons. For most iOS buttons, the effect dims the entire button (except for the text) while the button is being pressed.
For toolbar buttons that use the Titanium.UI.iOS.SystemButtonStyle.PLAIN style or use system icons such as Titanium.UI.iOS.SystemButton.CAMERA, a glow effect is used. The glow effect shows as a white circular glow or highlight at the center of the button when the button is pressed.
# Examples
# Simple Button Example
var win = Ti.UI.createWindow();
var button = Titanium.UI.createButton({
title: 'Hello',
top: 10,
width: 100,
height: 50
});
button.addEventListener('click',function(e)
{
Titanium.API.info("You clicked the button");
});
win.add(button);
win.open();
# Alloy XML Markup
Previous example as an Alloy view.
button.xml:
<Alloy>
<Window id="win" backgroundColor="white">
<!-- The title property can also be defined as node text. -->
<Button id="button" onClick="doClick" title="Hello"
top="10" width="100" height="50" />
</Window>
</Alloy>
button.js:
function doClick(e){
Titanium.API.info("You clicked the button");
};
# Properties
# accessibilityDisableLongPress CREATION ONLY
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.
Default: true
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
.
# attributedString
Specify an attributed string for the label.
The underlying attributed string drawn by the label. If set, avoid setting common attributes
in the label, such as color
and font
, as unexpected behaviors may result.
iOS Note: This property can also be used to supress the underline style when accessibility
is enabled. To do so, set the type
to ATTRIBUTE_UNDERLINES_STYLE and the
value
to ATTRIBUTE_UNDERLINE_STYLE_NONE.
# 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
.
# backgroundDisabledColor
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
Background image for the button in its disabled state, specified as a local file path or URL.
Also sets the background image for the other button states (normal, focused, selected), unless they've been specified explicitly, except for iOS, which requires a backgroundImage.
# backgroundFocusedColor
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
Background image for the button in its focused state, specified as a local file path or URL.
Focusable must be true for normal views. Sets the background image for the focused state only. For iOS, since there is not a trackball, this does nothing.
# 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 button in its normal state, specified as a local file path or URL.
Also sets the background image for the other button states (disabled, focused, selected),
unless they've been specified explicitly. On iOS, if backgroundDisabledImage is unset, the
image will appear faded to indicate being disabled. Also on iOS, if backgroundSelectedImage
is unset, the image will be darkened to indicate being selected.
# 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
# backgroundSelectedColor
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.
Default: Background color of this view.
# backgroundSelectedImage
Background image for the button in its selected state, specified as a local file path or URL.
On Android, Focusable must be true in order to be selected. Sets the background image for the selected state only.
# 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.
# color
Default button text color, as a color name or hex triplet.
For information about color values, see the "Colors" section of Titanium.UI.
# disabledColor
Text color of the button in its disabled state, as a color name or hex triplet.
# elevation
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.
# enabled
Set to true
to enable the button, false
to disable the button.
Default: true
# filterTouchesWhenObscured
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.
Default: false
# focusable
Whether view should be focusable while navigating with the trackball.
Default: false
# 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.
Sets the behavior when hiding an object to release or keep the free space
If setting hiddenBehavior
to 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
.
- HIDDEN_BEHAVIOR_INVISIBLE. Keeps the space and just hides the object (default).
- HIDDEN_BEHAVIOR_GONE. Releases the space and hides the object.
Defaults to Titanium.UI.HIDDEN_BEHAVIOR_INVISIBLE.
# 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.
# image
Image to display next to the button title.
As of Titanium 11.0.0, the imageIsMask property determines how
this image is displayed. If set true
, this image will be tinted using the color assigned to the
tintColor property. If set false
, the image is displayed as-is.
On Android, you can set this to a numeric resource drawable ID via Ti.App.Android.R.drawable.*
which lets you use native vector drawbles that are commonly used as icons.
# imageIsMask
Set true to tint the button image. Set false to show the image as-is.
Default: true
# keepScreenOn
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 idleTimerDisabled.
Default: false
# 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
.
# lifecycleContainer
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.
# opacity
Opacity of this view, from 0.0 (transparent) to 1.0 (opaque). Defaults to 1.0 (opaque).
# overrideCurrentAnimation CREATION ONLY
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
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.
# rotationX
Clockwise rotation of the view in degrees (x-axis).
Translation values are applied to the static post layout value.
# rotationY
Clockwise rotation of the view in degrees (y-axis).
Translation values are applied to the static post layout value.
# scaleX
Scaling of the view in x-axis in pixels.
Translation values are applied to the static post layout value.
# scaleY
Scaling of the view in y-axis in pixels.
Translation values are applied to the static post layout value.
# selectedColor
Button text color used to indicate the selected state, as a color name or hex triplet.
For information about color values, see the "Colors" section of Titanium.UI.
# shadowColor
Shadow color of the title, as a color name or hex triplet.
Use in conjunction with shadowOffset and shadowRadius. For information about color values, see the "Colors" section of Titanium.UI.
# shadowOffset
Shadow offset of the title, as a dictionary with the properties x
and y
.
Use in conjunction with shadowColor and shadowRadius.
# shadowRadius
Shadow radius of the title.
Use in conjunction with shadowColor and shadowOffset.
# 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.
# softKeyboardOnFocus
Determines keyboard behavior when this view is focused. Defaults to SOFT_KEYBOARD_DEFAULT_ON_FOCUS.
# style
The border and fill style the button will use.
On Android, this is a creation-only property and cannot be changed dynamically.
For Titanium versions older than 10.0.0, this is an iOS only property and must be assigned a constant from Titanium.UI.iOS.SystemButtonStyle which is now deprecated.
Default: Titanium.UI.BUTTON_STYLE_TEXT> (on iOS),
<Titanium.UI.BUTTON_STYLE_FILLED> (on Android)
Specifies an iOS system button appearance, as defined in Titanium.UI.iOS.SystemButton.
In JavaScript:
var cancelButton = Ti.UI.createButton({
systemButton: Ti.UI.iOS.SystemButton.CANCEL
});
In Alloy, you can omit the namespace when setting the systemButton
property on a <Button>
element:
<Button systemButton="CAMERA"/>
- Titanium.UI.iOS.SystemButton.ACTION
- Titanium.UI.iOS.SystemButton.ACTIVITY
- Titanium.UI.iOS.SystemButton.ADD
- Titanium.UI.iOS.SystemButton.BOOKMARKS
- Titanium.UI.iOS.SystemButton.CAMERA
- Titanium.UI.iOS.SystemButton.CANCEL
- Titanium.UI.iOS.SystemButton.COMPOSE
- Titanium.UI.iOS.SystemButton.CONTACT_ADD
- Titanium.UI.iOS.SystemButton.DISCLOSURE
- Titanium.UI.iOS.SystemButton.DONE
- Titanium.UI.iOS.SystemButton.EDIT
- Titanium.UI.iOS.SystemButton.FAST_FORWARD
- Titanium.UI.iOS.SystemButton.FIXED_SPACE
- Titanium.UI.iOS.SystemButton.FLEXIBLE_SPACE
- Titanium.UI.iOS.SystemButton.INFO_DARK
- Titanium.UI.iOS.SystemButton.INFO_LIGHT
- Titanium.UI.iOS.SystemButton.ORGANIZE
- Titanium.UI.iOS.SystemButton.PAUSE
- Titanium.UI.iOS.SystemButton.PLAY
- Titanium.UI.iOS.SystemButton.REFRESH
- Titanium.UI.iOS.SystemButton.REPLY
- Titanium.UI.iOS.SystemButton.REWIND
- Titanium.UI.iOS.SystemButton.SAVE
- Titanium.UI.iOS.SystemButton.SPINNER
- Titanium.UI.iOS.SystemButton.STOP
- Titanium.UI.iOS.SystemButton.TRASH
# textAlign
Text alignment, specified using one of the Titanium.UI text alignment constants.
Default: Titanium.UI.TEXT_ALIGNMENT_CENTER
# tintColor
Color applied to button's image and title.
Color to be applied to the button's image, but only if the
imageIsMask property is set true
.
This tint color is also applied to the button's title unless the color property is set.
Default: null
# titleid
Key identifying a string from the locale file to use for the button title.
Only one of title
or titleid
should be specified.
# 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
# touchFeedback
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 backgroundColor property to a non-transparent color.
Default: false
# touchFeedbackColor
Optional touch feedback ripple color. This has no effect unless touchFeedback
is true.
Defaults to provided theme color.
# transform
Transformation matrix to apply to the view.
Android only supports Matrix2D transforms.
Default: Identity matrix
# transitionName
A name to identify this view in activity transition.
Name should be unique in the View hierarchy.
# translationX
Horizontal location of the view relative to its left position in pixels.
Translation values are applied to the static post layout value.
# translationY
Vertical location of the view relative to its top position in pixels.
Translation values are applied to the static post layout value.
# translationZ
Depth of the view relative to its elevation in pixels.
Translation values are applied to the static post layout value.
# verticalAlign
Vertical alignment for the text field, specified using one of the vertical alignment constants from Titanium.UI.
Default: Titanium.UI.TEXT_VERTICAL_ALIGNMENT_CENTER
# 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
# 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
# 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
# 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
# stopAnimation
Stops a running animation.
Stops a running view Titanium.UI.Animation.
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. |
# focus
Fired when the view element gains focus.
This event only fires when using the trackball to navigate.
# 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. |
# 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.
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. |
# touchfiltered
Fired when the device detects a swipe gesture against the view.
If the button's filterTouchesWhenObscured property
is set true
, then this event will be fired if the touch event was discarded because another app's
overlapping window obscured it.
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.
You can use this event to display an alert dialog explaining why the button's action has been disabled. Especially if the overlapping window is completely invisible.
Properties
Name | Type | Description |
---|---|---|
x | Number | X coordinate of the event from the |
y | Number | Y coordinate of the event from the |
obscured | Boolean | Always |
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. |