How to subclass UICollectionViewLayoutAttributes

Question

I am trying to subclass UICollectionViewLayoutAttributes so that I can add an extra attribute points (an array of CGPoints).

The subclass is designed to only be used as attributes for decoration views so I need to set the member representedElementCategory to .Decoration. But representedElementCategory is readonly and the only way to set it is through the convenience initialiser:

convenience init(forDecorationViewOfKind decorationViewKind: String, withIndexPath indexPath: NSIndexPath)

Looking at the Objective-C headers I see this convenience initialiser is actually defined as a factory method:

+ (instancetype)layoutAttributesForDecorationViewOfKind:(NSString *)decorationViewKind withIndexPath:(NSIndexPath*)indexPath;

I would like my subclass' initialiser to look like:

CustomLayoutAttributes(points: [CGPoint], representedElementKind: String, withIndexPath: NSIndexPath)

But as subclasses aren't able to call the convenience initialisers of their parents I can't see how this would be possible.

Am I correct in thinking that the only way to subclass this is:

class CustomLayoutAttributes: UICollectionViewLayoutAttributes {
   var points = [CGPoint]()
}

let attribs = UICollectionViewLayoutAttributes(
     forDecorationViewOfKind: "x", 
     withIndexPath: NSIndexPath(forItem: 0, inSection: 0)
) as! CustomLayoutAttributes
attribs.points = [CGPoint(x: 1.0, y: 2.0), CGPoint(x: 4.0, y: 5.0)]

Actually this won't work because the 'as!' cast will fail....

I should add that I am using these layout attributes in a custom *UICollectionViewLayout* which needs to be able to create them hence the question. — toriaezunama, Jul 22 '15 at 22:39

toriaezunama · Accepted Answer · 2015-09-14T19:45:24.087

It turns out that a sub class can call a super class' convenience initialiser which can in turn call the sub class' initialiser. For example:

CustomLayoutAttributes(forDecorationViewOfKind: "decoration1", withIndexPath: indexPath)

Here: init(forDecorationViewOfKind: String, withIndexPath: NSIndexPath) isn't defined in the CustomLayoutAttributes class but can still be used to construct an instance of the subclass.

Implementation example:

// CustomLayoutAttributes.swift

class CustomLayoutAttributes: UICollectionViewLayoutAttributes {

   // Additional attribute to test our custom layout
   var points = [CGPoint]()

   // MARK: NSCopying
   override func copyWithZone(zone: NSZone) -> AnyObject {

      let copy = super.copyWithZone(zone) as! CustomLayoutAttributes
      copy.points = self.points
      return copy
   }

    override func isEqual(object: AnyObject?) -> Bool {

      if let rhs = object as? CustomLayoutAttributes {
         if points != rhs.points {
            return false
         }
         return super.isEqual(object)
      } else {
         return false
      }
   }
}

// CustomLayout.swift

override func layoutAttributesForItemAtIndexPath(path: NSIndexPath) -> UICollectionViewLayoutAttributes? {  


    let attributes = CustomLayoutAttributes(forDecorationViewOfKind: "decoration1", withIndexPath: indexPath)
    attributes.points = [...]

    return attributes  
}

And if you are also subclassing `UICollectionViewLayout`, don't forget to override `layoutAttributesClass` in your subclass to return the `Class` of your custom attributes. — Tjalsma, Jun 16 '18 at 18:23

score 7 · Answer 2 · answered Jul 22 '15 at 22:34

UICollectionViewLayoutAttributes subclassing require some peculiars. Have you check subclassing not at https://developer.apple.com/library/ios/documentation/UIKit/Reference/UICollectionViewLayoutAttributes_class/

In most cases, you use this class as-is. If you want to supplement the base layout attributes with custom layout attributes, you can subclass and define whatever properties you want to store the additional layout data. Because layout attribute objects may be copied by the collection view, make sure your subclass conforms to the NSCopying protocol by implementing any methods appropriate for copying your custom attributes to new instances of your subclass. In addition to defining your subclass, your UICollectionReusableView objects need to implement the applyLayoutAttributes: method so that they can apply any custom attributes at layout time.

If you subclass and implement any custom layout attributes, you must also override the inherited isEqual: method to compare the values of your properties. In iOS 7 and later, the collection view does not apply layout attributes if those attributes have not changed. It determines whether the attributes have changed by comparing the old and new attribute objects using the isEqual: method. Because the default implementation of this method checks only the existing properties of this class, you must implement your own version of the method to compare any additional properties. If your custom properties are all equal, call super and return the resulting value at the end of your implementation.

Yes I have thanks, but I don't see how that answers my question. — toriaezunama, Jul 22 '15 at 22:37
Ok, so it might be related to the fact that `layoutAttributesClass` is not define on the `UICollectionViewLayout` class but on an extension of it. This may relate to this unanswered — Hugues BR, Jul 23 '15 at 08:24

score 0 · Answer 3 · answered Feb 17 '21 at 12:41

Method names changed so converted to Swift 5:

    class SceneSelectorAttributes: UICollectionViewLayoutAttributes {

    var value = CGFloat()

    override func copy(with zone: NSZone? = nil) -> Any {
        let copy = super.copy(with: zone) as! SceneSelectorAttributes
        copy.value = self.value
        return copy
    }

    override func isEqual(_ object: Any?) -> Bool {
        if let rhs = object as? SceneSelectorAttributes {
            if value != rhs.value {
                return false
            }
            return super.isEqual(object)
        } else {
            return false
        }
    }
}

How to subclass UICollectionViewLayoutAttributes

3 Answers3