Titanium.UI.iOS.PreviewAction

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:

• iOS Developer Library: Adopting 3D Touch on iPhone

Extends: Titanium.Proxy · Since: 5.1.0 · Platforms: iphone

Properties

apiName

extended

3.2.0

3.2.0

3.2.0

9.2.0

Type: String

The name of the API that this proxy corresponds to.

The value of this property is the fully qualified name of the API. For example, Button
returns Ti.UI.Button.

bubbleParent

extended

3.0.0

3.0.0

3.0.0

9.2.0

Type: Boolean

Indicates if the proxy will bubble an event to its parent.

Some proxies (most commonly views) have a relationship to other proxies, often
established by the add() method. For example, for a button added to a window, a
click event on the button would bubble up to the window. Other common parents are
table sections to their rows, table views to their sections, and scrollable views
to their views. Set this property to false to disable the bubbling to the proxy's parent.

lifecycleContainer

extended

3.6.0

Type: Titanium.UI.Window, Titanium.UI.TabGroup

The Window or TabGroup whose Activity lifecycle should be triggered on the proxy.

If this property is set to a Window or TabGroup, then the corresponding Activity lifecycle event callbacks
will also be called on the proxy. Proxies that require the activity lifecycle will need this property set
to the appropriate containing Window or TabGroup.

style

0.9

0.9

0.9

9.2.0

Type: Number

The style of the action.

title

0.9

0.9

0.9

9.2.0

Type: String

The title of the action.

Provides a title to be shown when "peeking" a view referenced in the Titanium.UI.iOS.PreviewContext.

Methods

addEventListener

extended

0.9

0.9

0.9

9.2.0

Adds the specified callback as an event listener for the named event.

Parameters:

Name	Type	Summary	Optional
name	String	Name of the event.	No
callback	Callback<Titanium.Event>	Callback function to invoke when the event is fired.	No

applyProperties

extended

3.0.0

3.0.0

3.0.0

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	Summary	Optional
props	Dictionary	A dictionary of properties to apply.	No

fireEvent

extended

0.9

0.9

0.9

9.2.0

Fires a synthesized event to any registered listeners.

Parameters:

Name	Type	Summary	Optional
name	String	Name of the event.	No
event	Dictionary	A dictionary of keys and values to add to the Titanium.Event object sent to the listeners.	Yes

removeEventListener

extended

0.9

0.9

0.9

9.2.0

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	Summary	Optional
name	String	Name of the event.	No
callback	Callback<Titanium.Event>	Callback function to remove. Must be the same function passed to addEventListener.	No

Events

click

0.9

0.9

0.9

9.2.0

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:

Name	Type	Summary
index	Number	The index of the clicked action.
itemIndex	Number	The index of the clicked row, if the previewContext property of the Titanium.UI.iOS.PreviewContext is a Titanium.UI.ListView.
sectionIndex	Number	The index of the clicked section, if the previewContext property of the Titanium.UI.iOS.PreviewContext is a Titanium.UI.ListView.
itemId	String	The item ID of cell, if the previewContext property of the Titanium.UI.iOS.PreviewContext is a Titanium.UI.ListView.