UICollectionViewLayoutAttributes
父类:NSObject
一个UICollectionViewLayoutAttributes
对象管理着一个Collection View
中给定的一个Item的布局有关的属性。当被Collection View
要求时布局对象创建这个类的实例。反之,Collection View
使用布局信息在它的bounds
中放置Cell和Supplementary View。
一、概述
子类化注意
大多数情况下,你像这样使用这个类。如果你想要使用自定义布局属性来补充基本的布局属性,你可以声明一个子类,并且定义任何你想要存储额外的布局数据的属性。由于布局属性对象可能会被Collection View
复制,请确保你的子类遵循NSCopying
协议的方法的实现,以便于恰当的复制你的自定义属性到一个新的你自定义的子类中。除了定义你的子类之外,你的UICollectionReusableView
对象需要实现- (void)applyLayoutAttributes:(UICollectionViewLayoutAttributes *)layoutAttributes;
方法,以便于它们可以布局阶段在展示任何自定义属性。
如果你子类化并且实现任何自定义布局属性,你也必须重写继承的isEqual:
方法来比较你的自定义属性的值。在iOS 7以及之后的版本中,如果布局属性没有被改变那么Collection View
就不显示这些布局属性。这个取决于通过isEqual:
方法比较新旧两个属性对象是否发生改变。由于这个方法的默认实现只会检查这个类原本存在的属性,你必须执行你自己的写的这个方法来比较你额外添加的属性。如果你的自定义属性都是相等的,那么在你的实现的最后要调用super
并且返回super
返回的结果。
二、内容
1. 创建布局属性
+ (instancetype)layoutAttributesForCellWithIndexPath:(NSIndexPath *)indexPath;
创建并返回一个表示给定索引值对应的Cell的布局属性对象。
使用这个方法为Collection View
中的一个Cell创建一个布局属性对象。Cell是一个通过Collection View
视图展现的主要类型。一个Cell的索引通常包含了一个Section的索引和一个Item的索引,这个索引是这个Cell的内容在Collection View
的数据源中的位置。
+ (instancetype)layoutAttributesForSupplementaryViewOfKind:(NSString *)elementKind withIndexPath:(NSIndexPath *)indexPath;
创建并返回一个表示给定索引值对应的Supplementary View的布局属性对象。
使用这个方法为Collection View
中的一个Supplementary View创建一个布局属性对象。和Cell一样,Supplementary View当前的数据是被Collection View
数据源所管理的。但是和Cell不同的是,Supplementary View通常是为特殊目的而设计的。例如,Header和Footer与Cell的放置位置不同,是提供给在单个的Section或者整个Collection View
的。
由你来决定如何使用indexPath
参数来识别一个给定的Supplementary View。通常,你使用elementKind
属性来确定Supplementary View的类型,然后使用indexPath
的信息来识别不同Supplementary View实例。
+ (instancetype)layoutAttributesForDecorationViewOfKind:(NSString *)decorationViewKind withIndexPath:(NSIndexPath *)indexPath;
创建并返回一个表示给定索引值对应的Decoration View的布局属性对象。
使用这个方法为Collection View
中的一个Decoration View创建一个布局属性对象。Decoration View是Supplementary View的一种,但是不会展示被Collection View
数据源所管理的数据。相反,它们大多数为一个Section或者整个Collection View
呈现视觉装饰效果。
由你来决定如何使用indexPath
参数来识别一个给定的Decoration View。通常,你使用decorationViewKind
属性来确定Decoration View的类型,然后使用indexPath
的信息来识别不同Decoration View实例。
2. Identifying the Referenced Item
@property(nonatomic, strong) NSIndexPath *indexPath;
Collection View
中Item的索引值。
索引包含了一个Section的索引和一个Item在这个Section中的索引。这两个值标示在Collection View
唯一的对应的Item的位置。
@property(nonatomic, readonly) UICollectionElementCategory representedElementCategory;
Item的类型。
你可以使用这个属性的值来区分这个布局属性是用于一个Cell还是Supplementary View还是Decoration View。
UICollectionElementCategory
typedef NS_ENUM(NSUInteger, UICollectionElementCategory) {
UICollectionElementCategoryCell, // Cell
UICollectionElementCategorySupplementaryView, // Supplementary View
UICollectionElementCategoryDecorationView // Decoration View
};
@property(nonatomic, readonly) NSString *representedElementKind;
目标视图的布局指定标识符。
你可以使用这个属性的值来标识Supplementary View或者Decoration View相关联的属性给定的目的。如果representedElementCategory
属性为UICollectionElementCategoryCell
,那么这个属性为nil
。
3. 访问布局属性
@property (nonatomic) CGRect frame;
Item的矩形边框。
这个矩形边框是测量在给定的Collection View
坐标系中的点。设置这个属性的值也等于设置center
属性。
@property (nonatomic) CGRect bounds;
Item的bounds
。
当设置bounds
属性时,bounds
属性中的origin
必须被设置为(0, 0)
。改变bounds
属性也会使用新的bounds
中的size
来匹配改变size
属性。
@property (nonatomic) CGPoint center;
Item的中心点。
这个中心点是在给定的Collection View
坐标系中的点。设置这个属性的值也会更新frame
属性中的origin
的值。
@property (nonatomic) CGSize size;
Item的大小。
设置这个属性的值也会更新frame
属性中的size
的值。
@property (nonatomic) CATransform3D transform3D;
Item的三维变换。
使用你指定的3D转换的仿射版本赋值给这个属性来替换transform
属性的值。
@property (nonatomic) CGAffineTransform transform;
Item的仿射变换。
使用你指定的仿射变换赋值给这个属性来替换transform3D
属性的值。
@property (nonatomic) CGFloat alpha;
Item的透明度。
值在0.0
(透明)到1.0
(不透明)之间。默认为1.0
。
@property (nonatomic) NSInteger zIndex;
指定Item在z轴上的位置。
这个属性被用来确定在布局时Item的前后顺序。大的zIndex
值的Item会被显示在小的zIndex
值的Item上面。这个属性使用相同的值的Item的顺序是不确定的。
这个属性的值默认为0
。
@property(nonatomic, getter=isHidden) BOOL hidden;
决定Item是否在当前情况下显示。
这个属性的默认值为NO
。为了优化,Collection View
可能不会创建这个属性设置为YES
的Item。