Instance Method

layoutAttributesForElementsInRect:

Returns the layout attributes for all of the cells and views in the specified rectangle.

Declaration

- (NSArray<__kindof UICollectionViewLayoutAttributes *> *)layoutAttributesForElementsInRect:(CGRect)rect;

Parameters

rect

The rectangle (specified in the collection view’s coordinate system) containing the target views.

Return Value

An array of UICollectionViewLayoutAttributes objects representing the layout information for the cells and views. The default implementation returns nil.

Discussion

Subclasses must override this method and use it to return layout information for all items whose view intersects the specified rectangle. Your implementation should return attributes for all visual elements, including cells, supplementary views, and decoration views.

When creating the layout attributes, always create an attributes object that represents the correct element type (cell, supplementary, or decoration). The collection view differentiates between attributes for each type and uses that information to make decisions about which views to create and how to manage them.

See Also

Providing Layout Attributes

layoutAttributesClass

Returns the class to use when creating layout attributes objects.

- prepareLayout

Tells the layout object to update the current layout.

- layoutAttributesForItemAtIndexPath:

Returns the layout attributes for the item at the specified index path.

- layoutAttributesForInteractivelyMovingItemAtIndexPath:withTargetPosition:

Returns the layout attributes of an item when it is being moved interactively by the user.

- layoutAttributesForSupplementaryViewOfKind:atIndexPath:

Returns the layout attributes for the specified supplementary view.

- layoutAttributesForDecorationViewOfKind:atIndexPath:

Returns the layout attributes for the specified decoration view.

- targetContentOffsetForProposedContentOffset:

Returns the content offset to use after an animated layout update or change.

- targetContentOffsetForProposedContentOffset:withScrollingVelocity:

Returns the point at which to stop scrolling.