# Titanium.UI.iOS.PreviewAction

A PreviewAction provides options to configure actions used by the iOS 9 3D-Touch "Peek and Pop" feature.

Availability

5.1.0

Extends

# Overview

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.

# Properties

# apiName READONLY

Availability

5.1.0

apiName :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, Titanium.UI.Button returns Ti.UI.Button.

# bubbleParent

Availability

5.1.0

bubbleParent :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.

Default: true

# style

Availability

5.1.0

style :Number

The style of the action.

This API can be assigned the following constants:

Default: Titanium.UI.iOS.PREVIEW_ACTION_STYLE_DEFAULT

# title

Availability

5.1.0

title :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

Availability

5.1.0

addEventListener(name, callback) → void

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

# applyProperties

Availability

5.1.0

applyProperties(props) → void

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

# fireEvent

Availability

5.1.0

fireEvent(name[, event]) → void

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

# removeEventListener

Availability

5.1.0

removeEventListener(name, callback) → void

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 `addEventListener`.

Returns

Type: void

# Events

# click

Availability

5.1.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.

Properties

Name	Type	Description
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.
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.