Titanium SDK

# Titanium.UI.iOS.AnchorAttachmentBehavior

Dynamic behavior to support connections between an anchor point and an item.

Availability
3.2.0
9.2.0
Extends
Titanium.Proxy

# Overview

An anchor attachment behavior creates a dynamic connection between an anchor point and an item. To define an anchor attachment behavior:

  1. Use the Titanium.UI.iOS.createAnchorAttachmentBehavior method to create a behavior.
  2. Set the Titanium.UI.iOS.AnchorAttachmentBehavior.anchor and Titanium.UI.iOS.AnchorAttachmentBehavior.item properties.
  3. Add the behavior to the Titanium.UI.iOS.Animator.

To create a dynamic connection between two items, use Titanium.UI.iOS.ViewAttachmentBehavior.

# Examples

# Simple Example

The following example creates a red block and anchors it to a point near the top-center of the window. Using a gravitational force, the red block swings like a pendulum.

var win = Ti.UI.createWindow({backgroundColor: 'white', fullscreen: true});

// Create an Animator object using the window as the coordinate system
var animator = Ti.UI.iOS.createAnimator({referenceView: win});

// Create a red block to animate
var redBlock = Ti.UI.createView({
    backgroundColor: 'red',
    width: 25,
    height: 25,
    top: 10,
    left: 25
});

var WIDTH = Ti.Platform.displayCaps.platformWidth;

// Anchor the red block to a point near the top-center
var anchor = Ti.UI.iOS.createAnchorAttachmentBehavior({
    anchor: {x: WIDTH/2, y: 10},
    item: redBlock
});
animator.addBehavior(anchor);

// Simulate Earth's gravity to allow the pendulum to swing
var gravity = Ti.UI.iOS.createGravityBehavior({
    gravityDirection: {x: 0.0, y: 1.0}
});
gravity.addItem(redBlock);
animator.addBehavior(gravity);

// Start the animation when the window opens
win.addEventListener('open', function(e){
    animator.startAnimator();
});

win.add(redBlock);
win.open();

# Properties

# anchor

Availability
3.2.0
9.2.0
anchor :Point

Anchor point for the attachment behavior relative to the animator's coordinate system.

Default: (0,0)

# apiName READONLY

Availability
3.2.0
9.2.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
3.2.0
9.2.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

# damping

Availability
3.2.0
9.2.0
damping :Number

Amount of damping to apply to the attachment behavior.

Default: 0

# distance

Availability
3.2.0
9.2.0
distance :Number

Distance, in points, between the two attachment points.

Default: 0

# frequency

Availability
3.2.0
9.2.0
frequency :Number

Frequency of oscillation for the behavior.

Default: 0

# item

Availability
3.2.0
9.2.0
item :Titanium.UI.View

Item to connect to use the attachment behavior.

# offset

Availability
3.2.0
9.2.0
offset :Point

Offset from the center point of the item for the attachment.

Default: (0,0)

# Methods

# addEventListener

Availability
3.2.0
9.2.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
3.2.0
9.2.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
3.2.0
9.2.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
3.2.0
9.2.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

Contents