# Titanium.UI.iOS.PreviewContext

A PreviewContext provides options to configure the iOS 9 3D-Touch "Peek and Pop" feature.

Availability
5.1.0

# Overview

The PreviewContext is created by the Titanium.UI.iOS.createPreviewContext method. You must set the pop and preview properties when creating a PreviewContext object.

Use this class to configure the previewing context which is displayed while "peeking" a view.

Note: This feature requires iOS 9 and a 3D-Touch capable device (such as iPhone 6S or iPhone 6S Plus). You cannot test 3D touch on the iOS simulator. To check if the current device supports 3D touch, use the Titanium.UI.iOS.forceTouchSupported property and consider using the longpress event to provide a fallback to your users on non-3D-touch devices.

See also:

# Examples

# PreviewContext example using a Button as receiver.

The example below creates a new preview context and assigns a window, actions and a contentHeight. After that, we assign the preview context to a view which will trigger the "peeking" of it. Note, that this is independent from the click event of the view itself.

var actions = [];
var win = Ti.UI.createWindow({
    backgroundColor: "white"
});

// The view to be previewed while popping.
var previewView = Ti.UI.createView({
    backgroundColor: "blue"
});

// The window to be opened after popping the preview.
var detailWindow = Ti.UI.createWindow({
    backgroundColor: "yellow"
});

detailWindow.add(Ti.UI.createLabel({
    text: "You made it!"
}));

// The actions to be added to the preview context.
var action = Ti.UI.iOS.createPreviewAction({
    title: "Preview Action",
    style: Ti.UI.iOS.PREVIEW_ACTION_STYLE_DEFAULT
});

action.addEventListener("click", function(e) {
    alert("Title: " + e.title + " / Style: " + e.style+" / Index: " + e.index);
});

var subAction = Ti.UI.iOS.createPreviewAction({
    title: "Preview Subaction"
})

subAction.addEventListener("click", function(e) {
    alert("Title: " + e.title + " / Style: " + e.style+" / Subindex: " + e.index);
});

var actionGroup = Ti.UI.iOS.createPreviewActionGroup({
    title: "More actions...",
    style: Ti.UI.iOS.PREVIEW_ACTION_STYLE_DESTRUCTIVE,
    actions: [subAction]
});

actions.push(action);
actions.push(actionGroup);

// Create the preview context
var context = Ti.UI.iOS.createPreviewContext({
    preview: previewView,
    actions: actions, // Can have both Ti.UI.iOS.PreviewAction + Ti.UI.iOS.PreviewActionGroup
        contentHeight: 300 // When unspecified, we use the available height
});

// Fired after popping the preview
context.addEventListener("pop", function(e) {
    detailWindow.open();
});

// Assign the preview context
var button = Ti.UI.createButton({
    previewContext: context, // Will be ignored on unsupported devices
    title : "Open Window!",
    backgroundColor: "#A6171C",
    width: 200,
    height: 50,
    tintColor: "#fff"
});

win.add(button);
win.open();

# PreviewContext example using a ListView as receiver.

var actions = [];
var win = Ti.UI.createWindow({
    backgroundColor: "white"
});

// The view to be previewed while popping.
var previewView = Ti.UI.createView({
    backgroundColor: "blue"
});

// The window to be opened after popping the preview.
var detailWindow = Ti.UI.createWindow({
    backgroundColor: "yellow"
});

detailWindow.add(Ti.UI.createLabel({
    text: "You made it!"
}));

// The actions to be added to the preview context.
var action = Ti.UI.iOS.createPreviewAction({
    title: "Preview Action",
    style: Ti.UI.iOS.PREVIEW_ACTION_STYLE_DEFAULT
});

action.addEventListener("click", function(e) {
    alert(
        "Title: " + e.title +
        "\nStyle: " + e.style +
        "\nIndex: " + e.index +
        "\nSectionIndex: " + e.sectionIndex +
        "\nItemIndex: " + e.itemIndex
    );
});

actions.push(action);

// Create the preview context
var context = Ti.UI.iOS.createPreviewContext({
    preview: previewView,
    actions: actions, // Can have both Ti.UI.iOS.PreviewAction + Ti.UI.iOS.PreviewActionGroup
    contentHeight: 300 // When unspecified, we use the available height
});

// Fired after peeking the preview
// Use this event to configure the preview depending on the sectionIndex / itemIndex
context.addEventListener("peek", function(e) {
    Ti.API.warn("sectionIndex: " + e.sectionIndex);
    Ti.API.warn("itemIndex: " + e.itemIndex);
});

// Fired after popping the preview
context.addEventListener("pop", function(e) {
    detailWindow.open();
});

// Assign the preview context
var listView = Ti.UI.createListView({
    previewContext: context, // Will be ignored on unsupported devices
});

var section1 = Ti.UI.createListSection({
    headerTitle: "Section 1"
});

var section2 = Ti.UI.createListSection({
    headerTitle: "Section 2"
});

var items = [];

for(var i = 1; i <= 5; i++) {
    items.push({
        properties: {
            title: "Cell #" + i
        }
    });
}

section1.items = items;
section2.items = items;
listView.sections = [section1, section2];

win.add(listView);
win.open();

# Properties

# actions

Availability
5.1.0

The preview actions and preview action groups.

Provides an array with elements of the type Titanium.UI.iOS.PreviewAction and Titanium.UI.iOS.PreviewActionGroup. Both can be used together.


# contentHeight

Availability
5.1.0
contentHeight :Number

The height of the preview.

Specified the height of the preview which will be shown during "peeking".

Default: The available height of the screen.


# preview

Availability
5.1.0
preview :Titanium.UI.View

The preview view.

Provides the preview for "peeking". This view is independent from the window which can be openend after "popping" the preview to give you the ability to provide different layouts for the preview and the full window. If you want to adjust the preview inside the peek event, change the view assigned to this property.

# Events

# peek

Availability
5.1.0

Fired when the user peeks the preview. You can configure the preview

You can configure the preview in this event before it is displayed. If the preview context is assigned to a normal view like a Titanium.UI.Button the preview property can be received here to change the content of it before displaying. If the preview context is assigned to a Titanium.UI.ListView, you can also receive the properties sectionIndex, itemIndex and itemId here to access item-specific data to display.

Note: Don't do asynchronous operations like HTTP requests here, since the preview will not wait for the operations to complete.

Properties

Name Type Description
preview Titanium.UI.View

The view to be previewed.

sectionIndex Number

The section index of the ListView to identify the selected section. Note: This property is only available if the preview context is assigned to a Titanium.UI.ListView.

itemIndex Number

The item index of the ListView to identify the selected item. Note: This property is only available if the preview context is assigned to a Titanium.UI.ListView.

itemId String

The item ID bound to the list item that generated the event.

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.


# pop

Availability
5.1.0

Fired when the user pop the preview. You will most likely open a fullscreen window here.

You can open a window here or update your current UI. If the preview context is assigned to a normal view like a Titanium.UI.Button the preview property can be received here to change the content of it before displaying. If the preview context is assigned to a Titanium.UI.ListView, you can also receive the properties sectionIndex, itemIndex and itemId here to access item-specific data to display.

Note: Don't do asynchronous operations like HTTP requests here, since the preview will not wait for the operations to complete.

Properties

Name Type Description
preview Titanium.UI.View

The view to be previewed.

sectionIndex Number

The section index of the ListView to identify the selected section. Note: This property is only available if the preview context is assigned to a Titanium.UI.ListView.

itemIndex Number

The item index of the ListView to identify the selected item. Note: This property is only available if the preview context is assigned to a Titanium.UI.ListView.

itemId String

The item ID bound to the list item that generated the event.

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.