Merge pull request #1038 from binl/bl_button_states

[ASButtonNode] Use ASControlState instead of declaring a unique ASButtonState type.

Author: appleguy

AsyncDisplayKit/ASButtonNode.h

@@ -9,12 +9,6 @@
 #import <AsyncDisplayKit/ASTextNode.h>
 #import <AsyncDisplayKit/ASImageNode.h>
 
-typedef enum : NSUInteger {
-  ASButtonStateNormal,
-  ASButtonStateHighlighted,
-  ASButtonStateDisabled,
-} ASButtonState;
-
 @interface ASButtonNode : ASControlNode
 
 @property (nonatomic, readonly) ASTextNode *titleNode;
@@ -43,10 +37,10 @@ typedef enum : NSUInteger {
 @property (nonatomic, assign) ASVerticalAlignment contentVerticalAlignment;
 
 
-- (NSAttributedString *)attributedTitleForState:(ASButtonState)state;
-- (void)setAttributedTitle:(NSAttributedString *)title forState:(ASButtonState)state;
+- (NSAttributedString *)attributedTitleForState:(ASControlState)state;
+- (void)setAttributedTitle:(NSAttributedString *)title forState:(ASControlState)state;
 
-- (UIImage *)imageForState:(ASButtonState)state;
-- (void)setImage:(UIImage *)image forState:(ASButtonState)state;
+- (UIImage *)imageForState:(ASControlState)state;
+- (void)setImage:(UIImage *)image forState:(ASControlState)state;
 
 @end

AsyncDisplayKit/ASButtonNode.mm

@@ -17,10 +17,12 @@ @interface ASButtonNode ()
 
   NSAttributedString *_normalAttributedTitle;
   NSAttributedString *_highlightedAttributedTitle;
+  NSAttributedString *_selectedAttributedTitle;
   NSAttributedString *_disabledAttributedTitle;
 
   UIImage *_normalImage;
   UIImage *_highlightedImage;
+  UIImage *_selectedImage;
   UIImage *_disabledImage;
 }
 
@@ -66,6 +68,8 @@ - (void)updateImage
     newImage = _disabledImage;
   } else if (self.highlighted && _highlightedImage) {
     newImage = _highlightedImage;
+  } else if (self.selected && _selectedImage) {
+    newImage = _selectedImage;
   } else {
     newImage = _normalImage;
   }
@@ -84,6 +88,8 @@ - (void)updateTitle
     newTitle = _disabledAttributedTitle;
   } else if (self.highlighted && _highlightedAttributedTitle) {
     newTitle = _highlightedAttributedTitle;
+  } else if (self.selected && _selectedAttributedTitle) {
+    newTitle = _selectedAttributedTitle;
   } else {
     newTitle = _normalAttributedTitle;
   }
@@ -126,70 +132,96 @@ - (void)setLaysOutHorizontally:(BOOL)laysOutHorizontally
   [self setNeedsLayout];
 }
 
-- (NSAttributedString *)attributedTitleForState:(ASButtonState)state
+- (NSAttributedString *)attributedTitleForState:(ASControlState)state
 {
   ASDN::MutexLocker l(_propertyLock);
   switch (state) {
-    case ASButtonStateNormal:
+    case ASControlStateNormal:
       return _normalAttributedTitle;
 
-    case ASButtonStateHighlighted:
+    case ASControlStateHighlighted:
       return _highlightedAttributedTitle;
 
-    case ASButtonStateDisabled:
+    case ASControlStateSelected:
+      return _selectedAttributedTitle;
+      
+    case ASControlStateDisabled:
       return _disabledAttributedTitle;
+          
+    default:
+      return _normalAttributedTitle;
   }
 }
 
-- (void)setAttributedTitle:(NSAttributedString *)title forState:(ASButtonState)state
+- (void)setAttributedTitle:(NSAttributedString *)title forState:(ASControlState)state
 {
   ASDN::MutexLocker l(_propertyLock);
   switch (state) {
-    case ASButtonStateNormal:
+    case ASControlStateNormal:
       _normalAttributedTitle = [title copy];
       break;
 
-    case ASButtonStateHighlighted:
+    case ASControlStateHighlighted:
       _highlightedAttributedTitle = [title copy];
       break;
 
-    case ASButtonStateDisabled:
+    case ASControlStateSelected:
+      _selectedAttributedTitle = [title copy];
+      break;
+      
+    case ASControlStateDisabled:
       _disabledAttributedTitle = [title copy];
       break;
+      
+    default:
+      break;
   }
   [self updateTitle];
 }
 
-- (UIImage *)imageForState:(ASButtonState)state
+- (UIImage *)imageForState:(ASControlState)state
 {
   ASDN::MutexLocker l(_propertyLock);
   switch (state) {
-    case ASButtonStateNormal:
+    case ASControlStateNormal:
       return _normalImage;
 
-    case ASButtonStateHighlighted:
+    case ASControlStateHighlighted:
       return _highlightedImage;
 
-    case ASButtonStateDisabled:
+    case ASControlStateSelected:
+      return _selectedImage;
+      
+    case ASControlStateDisabled:
       return _disabledImage;
+      
+    default:
+      return _normalImage;
   }
 }
 
-- (void)setImage:(UIImage *)image forState:(ASButtonState)state
+- (void)setImage:(UIImage *)image forState:(ASControlState)state
 {
   ASDN::MutexLocker l(_propertyLock);
   switch (state) {
-    case ASButtonStateNormal:
+    case ASControlStateNormal:
       _normalImage = image;
       break;
 
-    case ASButtonStateHighlighted:
+    case ASControlStateHighlighted:
       _highlightedImage = image;
       break;
 
-    case ASButtonStateDisabled:
+    case ASControlStateSelected:
+      _selectedImage = image;
+      break;
+      
+    case ASControlStateDisabled:
       _disabledImage = image;
       break;
+      
+    default:
+      break;
   }
   [self updateImage];
 }

AsyncDisplayKit/ASControlNode.h

@@ -34,6 +34,13 @@ typedef NS_OPTIONS(NSUInteger, ASControlNodeEvent)
   ASControlNodeEventAllEvents         = 0xFFFFFFFF
 };
 
+typedef NS_OPTIONS(NSUInteger, ASControlState) {
+    ASControlStateNormal       = 0,
+    ASControlStateHighlighted  = 1 << 0,                  // used when ASControlNode isHighlighted is set
+    ASControlStateDisabled     = 1 << 1,
+    ASControlStateSelected     = 1 << 2,                  // used when ASControlNode isSeleted is set
+    ASControlStateReserved     = 0xFF000000               // flags reserved for internal framework use
+};
 
 /**
   @abstract ASControlNode is the base class for control nodes (such as buttons), or nodes that track touches to invoke targets with action messages.
@@ -55,6 +62,12 @@ typedef NS_OPTIONS(NSUInteger, ASControlNodeEvent)
  */
 @property (nonatomic, readonly, assign, getter=isHighlighted) BOOL highlighted;
 
+/**
+ @abstract Indicates whether or not the receiver is highlighted.
+ @discussion This is set automatically when the receiver is tapped.
+ */
+@property (nonatomic, assign, getter=isSelected) BOOL selected;
+
 #pragma mark - Tracking Touches
 /**
   @abstract Indicates whether or not the receiver is currently tracking touches related to an event.

AsyncDisplayKit/ASControlNode.m

@@ -186,6 +186,10 @@ - (void)touchesEnded:(NSSet *)touches withEvent:(UIEvent *)event
   // Send the appropriate touch-up control event.
   CGRect expandedBounds = CGRectInset(self.view.bounds, kASControlNodeExpandedInset, kASControlNodeExpandedInset);
   BOOL touchUpIsInsideExpandedBounds = CGRectContainsPoint(expandedBounds, touchLocation);
+  
+  if (touchUpIsInsideExpandedBounds) {
+    self.selected = !self.selected;
+  }
 
   [self sendActionsForControlEvents:(touchUpIsInsideExpandedBounds ? ASControlNodeEventTouchUpInside : ASControlNodeEventTouchUpOutside)
                           withEvent:event];

examples/Multiplex/Sample/ScreenNode.m

@@ -60,7 +60,7 @@ - (void)setText:(NSString *)text
   NSDictionary *attributes = @{NSFontAttributeName: [UIFont fontWithName:@"HelveticaNeue-Light" size:22.0f]};
   NSAttributedString *string = [[NSAttributedString alloc] initWithString:text
                                                                attributes:attributes];
-  [_buttonNode setAttributedTitle:string forState:ASButtonStateNormal];
+  [_buttonNode setAttributedTitle:string forState:ASControlStateNormal];
   [self setNeedsLayout];
 }