[TIMOB-12582] iOS: Adding custom views in the pin

apidoc/Titanium/Map/Annotation.yml

@@ -54,6 +54,15 @@ properties:
         Must be set before the annotation is added to the map view.
     type: Boolean
 
+  - name: customView
+    summary: Defines a custom view to be used by the annotation.
+    description: |
+        A custom View to display for the annotation. **User interaction is disabled on the view.**
+        No view interaction events (click, touchstart etc) will be fired.
+    type: Titanium.UI.View
+    platforms: [iphone, ipad]
+    since: "3.1.0"
+
   - name: draggable
     summary: Determines whether the pin can be dragged by the user.
     description: |
@@ -66,7 +75,7 @@ properties:
   - name: image
     summary: Image to use for the the pin.
     description: |
-        The image can be specified using a local URL or an image `Blob`.
+        The image can be specified using a local URL or an image `Blob`. This is ignored if the customeView property is set.
     type: [String, Titanium.Blob]
     default: If not specified, a standard map pin image is used.
 

iphone/Classes/TiMapAnnotationProxy.h

@@ -13,7 +13,7 @@
 
 @class TiMapViewProxy;
 
-@interface TiMapAnnotationProxy : TiViewProxy<MKAnnotation> {
+@interface TiMapAnnotationProxy : TiViewProxy<MKAnnotation, TiProxyObserver> {
 @private
 	int tag;
 	TiMapViewProxy *delegate;

iphone/Classes/TiMapAnnotationProxy.m

@@ -289,6 +289,28 @@ -(void)setImage:(id)image
 	}
 }
 
+-(void)setCustomView:(id)customView
+{
+	id current = [self valueForUndefinedKey:@"customView"];
+	[self replaceValue:customView forKey:@"customView" notification:NO];
+	if ([current isEqual: customView] == NO)
+	{
+        [current setProxyObserver:nil];
+        [self forgetProxy:current];
+        [self rememberProxy:customView];
+        [customView setProxyObserver:self];
+        [self setNeedsRefreshingWithSelection:YES];
+	}
+}
+
+-(void)proxyDidRelayout:(id)sender
+{
+    id current = [self valueForUndefinedKey:@"customView"];
+    if ( ([current isEqual:sender] == YES) && (self.placed) ) {
+        [self setNeedsRefreshingWithSelection:YES];
+    }
+}
+
 
 -(int)tag
 {

iphone/Classes/TiMapCustomAnnotationView.h

@@ -0,0 +1,27 @@
+/**
+ * Appcelerator Titanium Mobile
+ * Copyright (c) 2013 by Appcelerator, Inc. All Rights Reserved.
+ * Licensed under the terms of the Apache Public License
+ * Please see the LICENSE included with this distribution for details.
+ */
+#import "TiBase.h"
+
+#ifdef USE_TI_MAP
+
+#import <MapKit/MapKit.h>
+#import "TiMapView.h"
+#import "TiViewProxy.h"
+
+@interface TiMapCustomAnnotationView : MKAnnotationView<TiMapAnnotation> {
+@private
+    NSString * lastHitName;
+    TiViewProxy* theProxy;
+    UIView* wrapperView;
+}
+
+- (id)initWithAnnotation:(id <MKAnnotation>)annotation reuseIdentifier:(NSString *)reuseIdentifier map:(TiMapView*)map;
+- (NSString *)lastHitName;
+- (void)setProxy:(TiViewProxy*)customView;
+
+@end
+#endif

iphone/Classes/TiMapCustomAnnotationView.m

@@ -0,0 +1,97 @@
+/**
+ * Appcelerator Titanium Mobile
+ * Copyright (c) 2013 by Appcelerator, Inc. All Rights Reserved.
+ * Licensed under the terms of the Apache Public License
+ * Please see the LICENSE included with this distribution for details.
+ */
+#import "TiBase.h"
+
+#ifdef USE_TI_MAP
+
+#import "TiMapCustomAnnotationView.h"
+
+@implementation TiMapCustomAnnotationView
+
+- (id)initWithAnnotation:(id <MKAnnotation>)annotation reuseIdentifier:(NSString *)reuseIdentifier map:(TiMapView*)map
+{
+    if (self = [super initWithAnnotation:annotation reuseIdentifier:reuseIdentifier]) {
+        self.backgroundColor = [UIColor clearColor];
+        wrapperView = [[UIView alloc] initWithFrame:CGRectZero];
+        wrapperView.userInteractionEnabled = false;
+        [self addSubview:wrapperView];
+    }
+    return self;
+}
+
+- (void)setProxy:(TiViewProxy*)customView;
+{
+    if (theProxy != customView) {
+        [[theProxy view] removeFromSuperview];
+        RELEASE_TO_NIL(theProxy);
+        [self initWithProxy:customView];
+    }
+    else {
+        TiUIView* theView = [theProxy barButtonViewForSize:CGSizeZero];
+        self.frame = wrapperView.frame = [theView bounds];
+    }
+}
+
+- (void)initWithProxy:(TiViewProxy*)customView
+{
+    theProxy = [customView retain];
+    TiUIView* theView = [theProxy barButtonViewForSize:CGSizeZero];
+    self.frame = wrapperView.frame = [theView bounds];
+    [wrapperView addSubview:theView];
+}
+
+-(void)dealloc
+{
+    RELEASE_TO_NIL(wrapperView);
+    RELEASE_TO_NIL(lastHitName);
+    RELEASE_TO_NIL(theProxy);
+    [super dealloc];
+}
+
+-(NSString *)lastHitName
+{
+    NSString * result = lastHitName;
+    [lastHitName autorelease];
+    lastHitName = nil;
+    return result;
+}
+
+- (UIView *)hitTest:(CGPoint) point withEvent:(UIEvent *)event
+{
+    UIView * result = [super hitTest:point withEvent:event];
+
+    if (result==nil) {
+        for (UIView * ourSubView in [self subviews]) {
+            CGPoint subPoint = [self convertPoint:point toView:ourSubView];
+            for (UIView * ourSubSubView in [ourSubView subviews]) {
+                if (CGRectContainsPoint([ourSubSubView frame], subPoint) && [ourSubSubView isKindOfClass:[UILabel class]]) {
+                    NSString * labelText = [(UILabel *)ourSubSubView text];
+                    TiMapAnnotationProxy * ourProxy = (TiMapAnnotationProxy *)[self annotation];
+                    RELEASE_TO_NIL(lastHitName);
+                    if ([labelText isEqualToString:[ourProxy title]]) {
+                        lastHitName = [@"title" retain];
+                    }
+                    else if ([labelText isEqualToString:[ourProxy subtitle]]) {
+                        lastHitName = [@"subtitle" retain];
+                    }
+                    return nil;
+                }
+            }
+            if (CGRectContainsPoint([ourSubView bounds], subPoint)) {
+                RELEASE_TO_NIL(lastHitName);
+                lastHitName = [@"annotation" retain];
+                return nil;
+            }
+        }
+    }
+    RELEASE_TO_NIL(lastHitName);
+    return result;
+}
+
+@end
+
+#endif

iphone/Classes/TiMapView.m

@@ -13,6 +13,7 @@
 #import "TiMapAnnotationProxy.h"
 #import "TiMapPinAnnotationView.h"
 #import "TiMapImageAnnotationView.h"
+#import "TiMapCustomAnnotationView.h"
 
 @implementation TiMapView
 
@@ -128,6 +129,7 @@ -(void)refreshAnnotation:(TiMapAnnotationProxy*)proxy readd:(BOOL)yn
 {
 	NSArray *selected = map.selectedAnnotations;
 	BOOL wasSelected = [selected containsObject:proxy]; //If selected == nil, this still returns FALSE.
+    ignoreClicks = YES;
 	if (yn==NO)
 	{
 		[map deselectAnnotation:proxy animated:NO];
@@ -142,6 +144,7 @@ -(void)refreshAnnotation:(TiMapAnnotationProxy*)proxy readd:(BOOL)yn
 	{
 		[map selectAnnotation:proxy animated:NO];
 	}
+    ignoreClicks = NO;
 }
 
 #pragma mark Public APIs
@@ -678,60 +681,69 @@ - (void)mapView:(MKMapView *)mapView annotationView:(MKAnnotationView *)aview ca
 // For MapKit provided annotations (eg. MKUserLocation) return nil to use the MapKit provided annotation view.
 - (MKAnnotationView *)mapView:(MKMapView *)mapView viewForAnnotation:(id <MKAnnotation>)annotation
 {
-	if ([annotation isKindOfClass:[TiMapAnnotationProxy class]])
-	{
-		TiMapAnnotationProxy *ann = (TiMapAnnotationProxy*)annotation;
-        id imagePath = [ann valueForUndefinedKey:@"image"];
-        UIImage *image = [TiUtils image:imagePath proxy:ann];
-        NSString *identifier = (image!=nil) ? @"timap-image":@"timap-pin";
-		MKAnnotationView *annView = nil;
+    if ([annotation isKindOfClass:[TiMapAnnotationProxy class]]) {
+        TiMapAnnotationProxy *ann = (TiMapAnnotationProxy*)annotation;
+        id customView = [ann valueForUndefinedKey:@"customView"];
+        if ( (customView == nil) || (customView == [NSNull null]) || (![customView isKindOfClass:[TiViewProxy class]]) ){
+            customView = nil;
+        }
+        NSString *identifier = nil;
+        UIImage* image = nil;
+        if (customView == nil) {
+            id imagePath = [ann valueForUndefinedKey:@"image"];
+            image = [TiUtils image:imagePath proxy:ann];
+            identifier = (image!=nil) ? @"timap-image":@"timap-pin";
+        }
+        else {
+            identifier = @"timap-customView";
+        }
+        MKAnnotationView *annView = nil;
 
-		annView = (MKAnnotationView*) [mapView dequeueReusableAnnotationViewWithIdentifier:identifier];
+        annView = (MKAnnotationView*) [mapView dequeueReusableAnnotationViewWithIdentifier:identifier];
 
-        if (annView==nil)
-        {
-            if ([identifier isEqualToString:@"timap-image"])
-            {
+        if (annView==nil) {
+            if ([identifier isEqualToString:@"timap-customView"]) {
+                annView = [[[TiMapCustomAnnotationView alloc] initWithAnnotation:ann reuseIdentifier:identifier map:self] autorelease];
+            }
+            else if ([identifier isEqualToString:@"timap-image"]) {
                 annView=[[[TiMapImageAnnotationView alloc] initWithAnnotation:ann reuseIdentifier:identifier map:self image:image] autorelease];
             }
-            else
-            {
+            else {
                 annView=[[[TiMapPinAnnotationView alloc] initWithAnnotation:ann reuseIdentifier:identifier map:self] autorelease];
             }
         }
-        if ([identifier isEqualToString:@"timap-image"])
-        {
+        if ([identifier isEqualToString:@"timap-customView"]) {
+            [((TiMapCustomAnnotationView*)annView) setProxy:customView];
+        }
+        else if ([identifier isEqualToString:@"timap-image"]) {
             annView.image = image;
         }
-        else
-		{
-			MKPinAnnotationView *pinview = (MKPinAnnotationView*)annView;
-			pinview.pinColor = [ann pinColor];
-			pinview.animatesDrop = [ann animatesDrop] && ![(TiMapAnnotationProxy *)annotation placed];
-			annView.calloutOffset = CGPointMake(-8, 0);
-		}
-		annView.canShowCallout = YES;
-		annView.enabled = YES;
-		UIView *left = [ann leftViewAccessory];
-		UIView *right = [ann rightViewAccessory];
-		if (left!=nil)
-		{
-			annView.leftCalloutAccessoryView = left;
-		}
-		if (right!=nil)
-		{
-			annView.rightCalloutAccessoryView = right;
-		}
+        else {
+            MKPinAnnotationView *pinview = (MKPinAnnotationView*)annView;
+            pinview.pinColor = [ann pinColor];
+            pinview.animatesDrop = [ann animatesDrop] && ![(TiMapAnnotationProxy *)annotation placed];
+            annView.calloutOffset = CGPointMake(-8, 0);
+        }
+        annView.canShowCallout = YES;
+        annView.enabled = YES;
+        UIView *left = [ann leftViewAccessory];
+        UIView *right = [ann rightViewAccessory];
+        if (left!=nil) {
+            annView.leftCalloutAccessoryView = left;
+        }
+        if (right!=nil) {
+            annView.rightCalloutAccessoryView = right;
+        }
 
-		BOOL draggable = [TiUtils boolValue: [ann valueForUndefinedKey:@"draggable"]];
-		if (draggable && [[MKAnnotationView class] instancesRespondToSelector:NSSelectorFromString(@"isDraggable")])
-			[annView performSelector:NSSelectorFromString(@"setDraggable:") withObject:[NSNumber numberWithBool:YES]];
+        BOOL draggable = [TiUtils boolValue: [ann valueForUndefinedKey:@"draggable"]];
+        if (draggable && [[MKAnnotationView class] instancesRespondToSelector:NSSelectorFromString(@"isDraggable")])
+            [annView performSelector:NSSelectorFromString(@"setDraggable:") withObject:[NSNumber numberWithBool:YES]];
 
-		annView.userInteractionEnabled = YES;
-		annView.tag = [ann tag];
-		return annView;
-	}
-	return nil;
+        annView.userInteractionEnabled = YES;
+        annView.tag = [ann tag];
+        return annView;
+    }
+    return nil;
 }
 
 
@@ -749,7 +761,7 @@ - (void)mapView:(MKMapView *)mapView didAddAnnotationViews:(NSArray *)views
         /*Image Annotation don't have any animation of its own. 
          *So in this case we do a custom animation, to place the 
          *image annotation on top of the mapview.*/
-        if([thisView isKindOfClass:[TiMapImageAnnotationView class]])
+        if([thisView isKindOfClass:[TiMapImageAnnotationView class]] || [thisView isKindOfClass:[TiMapCustomAnnotationView class]])
         {
             TiMapAnnotationProxy *anntProxy = [self proxyForAnnotation:thisView];
             if([anntProxy animatesDrop] && ![anntProxy placed])

iphone/Classes/TiViewProxy.m

@@ -996,7 +996,8 @@ - (TiUIView *)barButtonViewForSize:(CGSize)bounds
     [self windowWillOpen];
     [self setParentVisible:YES];
     [self layoutChildren:NO];
-
+    [self refreshSize];
+    [self refreshPosition];
 	return barButtonView;
 }