Titanium.UI.iOS.PreviewActionGroup
> Titanium.UI.iOS.PreviewActionGroup

A PreviewActionGroup provides options to configure a group of actions used by the iOS9 3D-Touch feature "Peek and Pop".

Requires: iOS 9.0 and later

The PreviewActionGroup is created by the Titanium.UI.iOS.createPreviewActionGroup method. You need to set the title property when creating a PreviewActionGroup object.

Use this class to configure a group of preview actions used in the Titanium.UI.iOS.PreviewContext. The actions are of the type Titanium.UI.iOS.PreviewAction.

For an example, see Titanium.UI.iOS.PreviewContext.

See also:

  • 5.1.0
Defined By

Properties

Titanium.UI.iOS.PreviewActionGroup
actions : Titanium.UI.iOS.PreviewAction[]

The preview actions assigned to this preview action group.

The preview actions assigned to this preview action group.

Provides an array with elements of the type Titanium.UI.iOS.PreviewAction. Note: Apple does not allow adding a preview group to another preview group, so only one hirarchie level is allowed.

apiName : Stringreadonly

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.

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

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

  • 3.0.0
  • 3.0.0
  • 3.0.0

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.

  • 3.6.0
Titanium.UI.iOS.PreviewActionGroup
: Number
The style of the action group. ...
Titanium.UI.iOS.PreviewActionGroup
title : String

The title of the action group.

The title of the action group.

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

Defined By

Methods

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

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

Parameters

  • name : String

    Name of the event.

  • callback : Callback<Object>

    Callback function to invoke when the event is fired.

Returns

  • void
Applies the properties to the proxy. ...

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.

  • 3.0.0
  • 3.0.0
  • 3.0.0

Parameters

  • props : Dictionary

    A dictionary of properties to apply.

Returns

  • void
Fires a synthesized event to any registered listeners. ...

Fires a synthesized event to any registered listeners.

Parameters

  • 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

  • void
Titanium.UI.iOS.PreviewActionGroup
( ) : Titanium.UI.iOS.PreviewAction[]
Gets the value of the actions property. ...

Gets the value of the actions property.

Returns

Gets the value of the apiName property. ...

Gets the value of the apiName property.

  • 3.2.0
  • 3.2.0
  • 3.2.0

Returns

  • String
Gets the value of the bubbleParent property. ...

Gets the value of the bubbleParent property.

  • 3.0.0
  • 3.0.0
  • 3.0.0

Returns

  • Boolean
Gets the value of the lifecycleContainer property. ...

Gets the value of the lifecycleContainer property.

  • 3.6.0

Returns

Titanium.UI.iOS.PreviewActionGroup
( ) : Number
Gets the value of the style property. ...

Gets the value of the style property.

Returns

  • Number
Titanium.UI.iOS.PreviewActionGroup
( ) : String
Gets the value of the title property. ...

Gets the value of the title property.

Returns

  • String
Removes the specified callback as an event listener for the named event. ...

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

    Name of the event.

  • callback : Callback<Object>

    Callback function to remove. Must be the same function passed to addEventListener.

Returns

  • void
Titanium.UI.iOS.PreviewActionGroup
( actions )
Sets the value of the actions property. ...

Sets the value of the actions property.

Parameters

Returns

  • void
Sets the value of the bubbleParent property. ...

Sets the value of the bubbleParent property.

  • 3.0.0
  • 3.0.0
  • 3.0.0

Parameters

  • bubbleParent : Boolean

    New value for the property.

Returns

  • void
Sets the value of the lifecycleContainer property. ...

Sets the value of the lifecycleContainer property.

  • 3.6.0

Parameters

Returns

  • void
Titanium.UI.iOS.PreviewActionGroup
( style )
Sets the value of the style property. ...

Sets the value of the style property.

Parameters

  • style : Number

    New value for the property.

Returns

  • void
Titanium.UI.iOS.PreviewActionGroup
( title )
Sets the value of the title property. ...

Sets the value of the title property.

Parameters

  • title : String

    New value for the property.

Returns

  • void