Instance Method

setDragState:animated:

Sets the current drag state for the annotation view.

Declaration

- (void)setDragState:(MKAnnotationViewDragState)newDragState animated:(BOOL)animated;

Parameters

newDragState

The new drag state for the annotation view.

animated

If YES, the change to the new drag state should be animated; otherwise, it should be made without animations.

Discussion

Applications targeting iOS 4.2 and later can override this method and use it to implement drag support for custom annotation views. As the system detects user actions that would indicate a drag, it calls this method to update the drag state. In response to these changes, your custom implementation of this method should do the following:

The default implementation of this method sets the value of the dragState property to the value in the newDragState parameter only. Therefore, direct subclasses can simply call the inherited version of this method to change the drag state; otherwise, just change the value in the draggable property directly.

Changing the state to MKAnnotationViewDragStateDragging or MKAnnotationViewDragStateNone is the way to signal to the map view that you are done with any animations you wanted to perform. For example, when a drag operation begins for a pin annotation, the MKPinAnnotationView class executes an animation to lift the pin off the map. Similarly, when the pin is dropped, the class performs a drop animation. Even if you do not perform any animations, you should call the inherited version of this method to update the dragState property.

You must not try to abort a new drag operation by changing the state from MKAnnotationViewDragStateStarting to MKAnnotationViewDragStateNone. If you do not want your annotation view to be draggable, set the draggable property to NO.

See Also

Supporting Drag Operations

draggable

A Boolean indicating whether the annotation view is draggable.

dragState

The current drag state of the annotation view.