A PreviewAction provides options to configure actions used by the iOS 9 3D-Touch "Peek and Pop" feature.
Requires: iOS 9.0 and later
The PreviewAction is created by the Titanium.UI.iOS.createPreviewAction method. Set the
title property when creating a PreviewAction object.
Use this class to configure preview actions used in the Titanium.UI.iOS.PreviewContext. The actions can also be part of the Titanium.UI.iOS.PreviewActionGroup.actions property.
For an example, see Titanium.UI.iOS.PreviewContext.
See also:
The name of the API that this proxy corresponds to.
The name of the API that this proxy corresponds to.
The value of this property is the fully qualified name of the API. For example, Button
returns Ti.UI.Button.
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
The Window or TabGroup whose Activity lifecycle should be triggered on the proxy.
The Window or TabGroup whose Activity lifecycle should be triggered on the proxy.
If this property is set to a Window or TabGroup, then the corresponding Activity lifecycle event callbacks will also be called on the proxy. Proxies that require the activity lifecycle will need this property set to the appropriate containing Window or TabGroup.
The style of the action.
This API can be assigned the following constants:
The title of the action.
The title of the action.
Provides a title to be shown when "peeking" a view referenced in the Titanium.UI.iOS.PreviewContext.
Adds the specified callback as an event listener for the named event.
Name of the event.
Callback function to invoke when the event is fired.
Applies the properties to the proxy.
Properties are supplied as a dictionary. Each key-value pair in the object is applied to the proxy such that myproxy[key] = value.
A dictionary of properties to apply.
Fires a synthesized event to any registered listeners.
Name of the event.
A dictionary of keys and values to add to the Titanium.Event object sent to the listeners.
Removes the specified callback as an event listener for the named event.
Multiple listeners can be registered for the same event, so the
callback parameter is used to determine which listener to remove.
When adding a listener, you must save a reference to the callback function in order to remove the listener later:
var listener = function() { Ti.API.info("Event listener called."); }
window.addEventListener('click', listener);
To remove the listener, pass in a reference to the callback function:
window.removeEventListener('click', listener);
Name of the event.
Callback function to remove. Must be the same function passed to addEventListener.
Sets the value of the bubbleParent property.
New value for the property.
Sets the value of the lifecycleContainer property.
New value for the property.
Fired when the device detects a click against a preview action.
This event provides different properties depending on the view the Titanium.UI.iOS.PreviewContext
is assigned to. Every event has the index property to identify the clicked action. If the Titanium.UI.iOS.PreviewContext
is assigned to a Titanium.UI.ListView, the event provides the additional properties itemIndex, sectionIndex
and itemId to identify the previewed row and section, respectively.
The index of the clicked action.
The index of the clicked row, if the previewContext property of the Titanium.UI.iOS.PreviewContext
is a Titanium.UI.ListView.
The index of the clicked section, if the previewContext property of the Titanium.UI.iOS.PreviewContext
is a Titanium.UI.ListView.
The item ID of cell, if the previewContext property of the Titanium.UI.iOS.PreviewContext
is a Titanium.UI.ListView.
Source object that fired the event.
Name of the event fired.
True if the event will try to bubble up if possible.
Set to true to stop the event from bubbling.