CalStorePageItem Class Reference
Inherits from | CalStoreObject : NSObject |
---|---|
Declared in | CalStorePageItem.h |
Overview
A PageItem is building block of each PageSection. It’s either a link to another Page or a Calendar.
Each item has an itemId, a (localized) name and optionally an icon. Other information, such as sport or countr is also optionally available.
This class is the base class for each CalStorePageItem subclass, items are actually one of the concrete subclasses of this class.
Basic Info
itemId
The unique itemId for this object.
@property (nonatomic, readonly) NSString *itemId
Declared In
CalStorePageItem.h
name
The localized name for this item
@property (nonatomic, readonly) NSString *name
Declared In
CalStorePageItem.h
Icon
icon
The icon associated with this item. Nil if there is no icon.
@property (nonatomic, readonly) CalStoreIcon *icon
Declared In
CalStorePageItem.h
Typing
category
The category for this item.
@property (nonatomic, readonly) CalStoreCategory category
Declared In
CalStorePageItem.h
isWeatherCalendar
Returns YES iff this item is a weather calendar item.
@property (nonatomic, readonly, getter=isWeatherCalendar) BOOL isWeatherCalendar
Declared In
CalStorePageItem.h
isCalendar
Returns YES iff this item is a calendar item.
@property (nonatomic, readonly, getter=isCalendar) BOOL isCalendar
Declared In
CalStorePageItem.h
isPage
Returns YES iff this item is a page item.
@property (nonatomic, readonly, getter=isPage) BOOL isPage
Declared In
CalStorePageItem.h
Optional Extra Information
sport
Optional, localized name of the sport this item is about. Will be nil if the item is not about a sport.
@property (nonatomic, readonly) NSString *sport
Declared In
CalStorePageItem.h
gender
Optional, localized name of the gender this item is for. E.g. Woman’s Football. Will be nil if the item is not associated with a gender.
@property (nonatomic, readonly) NSString *gender
Declared In
CalStorePageItem.h
country
Optional, localized name of the country this item is about. Will be nil if the item is not associated with a country.
@property (nonatomic, readonly) NSString *country
Declared In
CalStorePageItem.h
season
Optional, localized name of the season this item is about. Will be nil if the item is not associated with a season.
@property (nonatomic, readonly) NSString *season
Declared In
CalStorePageItem.h
categoryName
Optional, localized name of the category this item is about. Will be nil if the item is not associated with a category.
@property (nonatomic, readonly) NSString *categoryName
Discussion
This property is congruent to the category property, only in localized string form.
See Also
Declared In
CalStorePageItem.h
Comparing items
– isEqualToPageItem:
Compares two CalStorePageItem objects with each other for being equal.
- (BOOL)isEqualToPageItem:(CalStorePageItem *)other
Parameters
other |
the CalStorePageItem object to compare against. |
---|
Return Value
YES iff this object and the other object have the same itemId.
Discussion
Compares itemIds only. Due to the nature of the API, objects of the same type with the same itemId are equal.
Declared In
CalStorePageItem.h