DLStarRatingControl Class Reference

#import <DLStarRatingControl.h>

Inheritance diagram for DLStarRatingControl:

Collaboration diagram for DLStarRatingControl:

Instance Methods
(id)	- initWithFrame:
(id)	- initWithFrame:andStars:isFractional:
(void)	- setStar:highlightedStar:
(void)	- setStar:highlightedStar:atIndex:
(void)	- setupView [implementation]
(id)	- initWithCoder: [implementation]
(void)	- layoutSubviews [implementation]
(UIButton *)	- starForPoint: [implementation]
(void)	- disableStarsDownToExclusive: [implementation]
(void)	- disableStarsDownTo: [implementation]
(void)	- enableStarsUpTo: [implementation]
(BOOL)	- beginTrackingWithTouch:withEvent: [implementation]
(void)	- cancelTrackingWithEvent: [implementation]
(BOOL)	- continueTrackingWithTouch:withEvent: [implementation]
(void)	- endTrackingWithTouch:withEvent: [implementation]
(void)	- setRating: [implementation]
(void)	- dealloc [implementation]

Protected Attributes
int	numberOfStars
int	currentIdx

Properties
UIImage *	star
UIImage *	highlightedStar
float	rating
id< DLStarRatingDelegate >	delegate
BOOL	isFractionalRatingEnabled

Detailed Description

Definition at line 20 of file DLStarRatingControl.h.

Method Documentation

beginTrackingWithTouch:withEvent:()

- (BOOL) beginTrackingWithTouch: (UITouch *)  touch withEvent: (UIEvent *)  event

implementation

Definition at line 134 of file DLStarRatingControl.m.

                              :(UITouch *)touch withEvent:(UIEvent *)event {
    CGPoint point = [touch locationInView:self];    
    UIButton *pressedButton = [self starForPoint:point];
    if (pressedButton) {
        int idx = (int)pressedButton.tag;
        if (pressedButton.highlighted) {
            [self disableStarsDownToExclusive:idx];
        } else {
            [self enableStarsUpTo:idx];
        }       
        currentIdx = idx;
    } 
    return YES;     
}

cancelTrackingWithEvent:()

- (void) cancelTrackingWithEvent: (UIEvent *)  event

implementation

Definition at line 149 of file DLStarRatingControl.m.

                               :(UIEvent *)event {
    [super cancelTrackingWithEvent:event];
}

continueTrackingWithTouch:withEvent:()

- (BOOL) continueTrackingWithTouch: (UITouch *)  touch withEvent: (UIEvent *)  event

implementation

Definition at line 153 of file DLStarRatingControl.m.

                                 :(UITouch *)touch withEvent:(UIEvent *)event {
    CGPoint point = [touch locationInView:self];
    
    UIButton *pressedButton = [self starForPoint:point];
    if (pressedButton) {
        int idx = (int)pressedButton.tag;
        UIButton *currentButton = (UIButton*)[self subViewWithTag:currentIdx];
        
        if (idx < currentIdx) {
            currentButton.highlighted = NO;
            currentIdx = idx;
            [self disableStarsDownToExclusive:idx];
        } else if (idx > currentIdx) {
            currentButton.highlighted = YES;
            pressedButton.highlighted = YES;
            currentIdx = idx;
            [self enableStarsUpTo:idx];
        }
    } else if (point.x < [self subViewWithTag:0].frame.origin.x) {
        ((UIButton*)[self subViewWithTag:0]).highlighted = NO;
        currentIdx = -1;
        [self disableStarsDownToExclusive:0];
    }
    return YES;
}

dealloc()

- (void) dealloc

implementation

Definition at line 207 of file DLStarRatingControl.m.

                {
    self.star = nil;
    self.highlightedStar = nil;
    self.delegate = nil;
    // [super dealloc];
}

disableStarsDownTo:()

- (void) disableStarsDownTo: (int)  idx

implementation

Definition at line 119 of file DLStarRatingControl.m.

                          :(int)idx {
    for (int i=numberOfStars; i >= idx; --i) {
        UIButton *b = (UIButton*)[self subViewWithTag:i];
        b.highlighted = NO;
    }
}

disableStarsDownToExclusive:()

- (void) disableStarsDownToExclusive: (int)  idx

implementation

Definition at line 112 of file DLStarRatingControl.m.

                                   :(int)idx {
    for (int i=numberOfStars; i > idx; --i) {
        UIButton *b = (UIButton*)[self subViewWithTag:i];
        b.highlighted = NO;
    }
}

enableStarsUpTo:()

- (void) enableStarsUpTo: (int)  idx

implementation

Definition at line 127 of file DLStarRatingControl.m.

                       :(int)idx {
    for (int i=0; i <= idx; i++) {
        UIButton *b = (UIButton*)[self subViewWithTag:i];
        b.highlighted = YES;
    }
}

endTrackingWithTouch:withEvent:()

- (void) endTrackingWithTouch: (UITouch *)  touch withEvent: (UIEvent *)  event

implementation

Definition at line 179 of file DLStarRatingControl.m.

                            :(UITouch *)touch withEvent:(UIEvent *)event {
    [self.delegate newRating:self :self.rating];
    [super endTrackingWithTouch:touch withEvent:event];
}

initWithCoder:()

- (id) initWithCoder: (NSCoder *)  aDecoder

implementation

Definition at line 37 of file DLStarRatingControl.m.

                   :(NSCoder *)aDecoder {
    self = [super initWithCoder:aDecoder];
    if (self) {
        numberOfStars = kDefaultNumberOfStars;
        if (isFractionalRatingEnabled)
            numberOfStars *=kNumberOfFractions;
        [self setupView];
    }
    return self;
}

initWithFrame:()

- (id) initWithFrame:

(CGRect)

frame

Definition at line 48 of file DLStarRatingControl.m.

                   :(CGRect)frame {
    self = [super initWithFrame:frame];
    if (self) {
        numberOfStars = kDefaultNumberOfStars;
        if (isFractionalRatingEnabled)
            numberOfStars *=kNumberOfFractions;
        [self setupView];

    }
    return self;
}

initWithFrame:andStars:isFractional:()

- (id) initWithFrame:		(CGRect)	frame
andStars:		(NSUInteger)	_numberOfStars
isFractional:		(BOOL)	isFract

Definition at line 60 of file DLStarRatingControl.m.

                   :(CGRect)frame andStars:(NSUInteger)_numberOfStars isFractional:(BOOL)isFract{
    self = [super initWithFrame:frame];
    if (self) {
        isFractionalRatingEnabled = isFract;
        numberOfStars = (int)_numberOfStars;
        if (isFractionalRatingEnabled)
            numberOfStars *=kNumberOfFractions;
        [self setupView];
    }
    return self;
}

layoutSubviews()

- (void) layoutSubviews

implementation

Definition at line 72 of file DLStarRatingControl.m.

                       {
    for (int i=0; i < numberOfStars; i++) {
        [(DLStarView*)[self subViewWithTag:i] centerIn:self.frame with:numberOfStars];
    }
}

setRating:()

- (void) setRating: (float)  _rating

implementation

Definition at line 187 of file DLStarRatingControl.m.

                 :(float)_rating {
    if (isFractionalRatingEnabled) {
        _rating *=kNumberOfFractions;
    }
    [self disableStarsDownTo:0];
    currentIdx = (int)_rating-1;
    [self enableStarsUpTo:currentIdx];
}

setStar:highlightedStar:()

- (void) setStar:		(UIImage*)	defaultStarImage
highlightedStar:		(UIImage*)	highlightedStarImage

Definition at line 81 of file DLStarRatingControl.m.

               :(UIImage*)defaultStarImage highlightedStar:(UIImage*)highlightedStarImage {
  for(NSInteger i = 0; i < numberOfStars; i++){
    [self setStar:defaultStarImage highlightedStar:highlightedStarImage atIndex:(int)i];
  }
}

setStar:highlightedStar:atIndex:()

- (void) setStar:		(UIImage*)	defaultStarImage
highlightedStar:		(UIImage*)	highlightedStarImage
atIndex:		(int)	index

Definition at line 87 of file DLStarRatingControl.m.

               :(UIImage*)defaultStarImage highlightedStar:(UIImage*)highlightedStarImage atIndex:(int)index {
    DLStarView *selectedStar = (DLStarView*)[self subViewWithTag:index];
    
    // check if star exists
    if (!selectedStar) return;
    
    // check images for nil else use default stars
    defaultStarImage = (defaultStarImage) ? defaultStarImage : star;
    highlightedStarImage = (highlightedStarImage) ? highlightedStarImage : highlightedStar;
    
    [selectedStar setStarImage:defaultStarImage highlightedStarImage:highlightedStarImage];
}

setupView()

- (void) setupView

implementation

Definition at line 25 of file DLStarRatingControl.m.

                  {
    self.clipsToBounds = YES;
    currentIdx = -1;
    star = [UIImage imageNamed:@"star.png"];
    highlightedStar = [UIImage imageNamed:@"star_highlighted.png"];

    for (int i=0; i<numberOfStars; i++) {
        DLStarView *v = [[DLStarView alloc] initWithDefault:self.star highlighted:self.highlightedStar position:i allowFractions:isFractionalRatingEnabled];
        [self addSubview:v];
    }
}

starForPoint:()

- (UIButton *) starForPoint: (CGPoint)  point

implementation

Definition at line 103 of file DLStarRatingControl.m.

                         :(CGPoint)point {
    for (int i=0; i < numberOfStars; i++) {
        if (CGRectContainsPoint([self subViewWithTag:i].frame, point)) {
            return (UIButton*)[self subViewWithTag:i];
        }
    }
    return nil;
}

Member Data Documentation

currentIdx

- (int) currentIdx

protected

Definition at line 22 of file DLStarRatingControl.h.

numberOfStars

- (int) numberOfStars

protected

Definition at line 21 of file DLStarRatingControl.h.

Property Documentation

delegate

- (id<DLStarRatingDelegate>) delegate

readwritenonatomicassign

Definition at line 37 of file DLStarRatingControl.h.

highlightedStar

- (UIImage *) highlightedStar

readwritenonatomicretain

Definition at line 24 of file DLStarRatingControl.h.

isFractionalRatingEnabled

- (BOOL) isFractionalRatingEnabled

readwritenonatomicassign

Definition at line 26 of file DLStarRatingControl.h.

rating

- (float) rating

readwritenonatomicassign

Definition at line 36 of file DLStarRatingControl.h.

star

- (UIImage *) star

readwritenonatomicretain

Definition at line 23 of file DLStarRatingControl.h.

---

The documentation for this class was generated from the following files:

• TodaysMenu/starrate/DLStarRatingControl.h
• TodaysMenu/starrate/DLStarRatingControl.m