Dynamic behavior to support connections between two items.
Requires: iOS 7.0 and later
The following APIs are supported on iOS 7 and later.
A view attachment behavior creates a dynamic connection between two items. To define a view attachment behavior:
- Use the Titanium.UI.iOS.createViewAttachmentBehavior method to create and define a behavior.
- Set the anchorItem and item properties.
- Add the behavior to the Animator object.
To create a dynamic connection between an item and anchor point, use Titanium.UI.iOS.AnchorAttachmentBehavior.
Examples
Simple Example
The following example anchors a green block to either a red or blue block. Click on the red or blue block to change which one the green block is anchored to.
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});
var redBlock = Ti.UI.createView({
backgroundColor: 'red',
width: 25,
height: 25,
top: 10,
left: 75
});
// Snap the red block so it does not move
var redSnap = Ti.UI.iOS.createSnapBehavior({
snapPoint: {x: 75, y: 10},
item: redBlock,
damping: 0.0
});
animator.addBehavior(redSnap);
var greenBlock = Ti.UI.createView({
backgroundColor: 'green',
width: 25,
height: 25,
top: 50,
});
var WIDTH = Ti.Platform.displayCaps.platformWidth;
var blueBlock = Ti.UI.createView({
backgroundColor: 'blue',
width: 25,
height: 25,
top: 10,
right: 75
});
// Snap the blue block so it does not move
var blueSnap = Ti.UI.iOS.createSnapBehavior({
snapPoint: {x: WIDTH - 75, y: 10},
item: blueBlock,
damping: 0.0
});
animator.addBehavior(blueSnap);
// Anchor the green block to the red one when the app starts
var anchor = Ti.UI.iOS.createViewAttachmentBehavior({
anchorItem: redBlock,
item: greenBlock
});
animator.addBehavior(anchor);
// Simulate Earth's gravity to allow the green block to swing
var gravity = Ti.UI.iOS.createGravityBehavior({
gravityDirection: {x: 0.0, y: 1.0}
});
gravity.addItem(greenBlock);
animator.addBehavior(gravity);
// Change the anchor item when clicking either the red or blue block
redBlock.addEventListener('click', function(e){
anchor.anchorItem = redBlock;
});
blueBlock.addEventListener('click', function(e){
anchor.anchorItem = blueBlock;
});
// Start the animation when the window opens
win.addEventListener('open', function(e){
animator.startAnimator();
});
win.add(redBlock);
win.add(greenBlock);
win.add(blueBlock);
win.open();
- 3.2
- 3.2
Properties
Offset from the center point of the anchor item for the attachment.
Default: (0,0)
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.
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
Amount of damping to apply to the attachment behavior.
Default: 0
Distance, in points, between the two attachment points.
Default: 0
Frequency of oscillation for the behavior.
Default: 0
Offset from the center point of the item for the attachment.
Default: (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
Methods
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.
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.
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
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
Sets the value of the anchorItem property.
Parameters
- anchorItem : Titanium.UI.View
New value for the property.
Returns
- void
Sets the value of the anchorOffset property.
Parameters
- anchorOffset : Point
New value for the property.
Returns
- void
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 damping property.
Parameters
- damping : Number
New value for the property.
Returns
- void
Sets the value of the distance property.
Parameters
- distance : Number
New value for the property.
Returns
- void
Sets the value of the frequency property.
Parameters
- frequency : Number
New value for the property.
Returns
- void
Sets the value of the item property.
Parameters
- item : Titanium.UI.View
New value for the property.
Returns
- void
Sets the value of the itemOffset property.
Parameters
- itemOffset : Point
New value for the property.
Returns
- void
Sets the value of the lifecycleContainer property.
- 3.6.0
Parameters
- lifecycleContainer : Titanium.UI.Window/Titanium.UI.TabGroup
New value for the property.
Returns
- void