You are reading 13.2.0. See this page in 13.4.1.
Titanium.UI.iOS.PreviewAction
Extends Titanium.Proxy
A PreviewAction provides options to configure actions used by the iOS 9 3D-Touch "Peek and Pop" feature.
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:
Properties 4
Inherited from Titanium.Proxy
The name of the API that this proxy corresponds to.
Inherited from Titanium.Proxy
Indicates if the proxy will bubble an event to its parent.
Default: true
style
NumberThe style of the action.
Default: Titanium.UI.iOS.PREVIEW_ACTION_STYLE_DEFAULT
title
StringThe title of the action.
Provides a title to be shown when "peeking" a view referenced in the Titanium.UI.iOS.PreviewContext.
Methods 4
Inherited from Titanium.Proxy
Adds the specified callback as an event listener for the named event.
| Parameters | Type | Description |
|---|---|---|
| name | String | Name of the event. |
| callback | Callback<Titanium.Event> | Callback function to invoke when the event is fired. 4 fields
|
applyProperties
since 3.0.0Inherited from Titanium.Proxy
Applies the properties to the proxy.
| Parameters | Type | Description |
|---|---|---|
| props | Dictionary | A dictionary of properties to apply. |
Inherited from Titanium.Proxy
Fires a synthesized event to any registered listeners.
| Parameters | 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. |
Inherited from Titanium.Proxy
Removes the specified callback as an event listener for the named event.
| Parameters | Type | Description |
|---|---|---|
| name | String | Name of the event. |
| callback | Callback<Titanium.Event> | Callback function to remove. Must be the same function passed to 4 fields
|
Events 1
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.
| Event properties | Type | Description |
|---|---|---|
| index | Number | The index of the clicked action. |
| itemIndex | Number | The index of the clicked row, if the |
| sectionIndex | Number | The index of the clicked section, if the |
| itemId | String | The item ID of cell, if the |