LeanbackSpanSizeLookup

public static final int FILL_ALL_SPANS = -2

Value returned by getSpanSize: fill all spans. It's equivalent of returning the spanCount.

public static final int FILL_ALL_SPANS_AND_PADDINGS = -1

Value returned by getSpanSize: fill all spans and padding area, it takes full width of a vertical grid view or full height of a horizontal grid view.

public static @NonNull LeanbackSpanSizeLookup getDefault()

Return the default LeanbackSpanSizeLookup that each item has a span size of 1.

public int getSpanGroupIndex(int adapterPosition, int spanCount)

Returns the index of the group this position belongs.

If VerticalGridView, this is a row value. If HorizontalGridView, this is a column value.

For example, if grid has 3 columns and each item occupies 1 span, span group index for item 1 will be 0, item 5 will be 1.

public int getSpanIndex(int position, int spanCount)

Returns the final span index of the provided position.

If VerticalGridView, this is a column value. If HorizontalGridView, this is a row value.

If you have a faster way to calculate span index for your items, you should override this method. Otherwise, you should enable span index cache (setSpanIndexCacheEnabled) for better performance. When caching is disabled, default implementation traverses all items from 0 to position. When caching is enabled, it calculates from the closest cached value before the position.

If you override this method, you need to make sure it is consistent with getSpanSize. GridLayoutManager does not call this method for each item. It is called only for the reference item and rest of the items are assigned to spans based on the reference item. For example, you cannot assign a position to span 2 while span 1 is empty.

Note that span offsets always start with 0 and are not affected by RTL.

public abstract int getSpanSize(int position)

Returns the number of spans this item will take, or FILL_ALL_SPANS_AND_PADDINGS, FILL_ALL_SPANS.

public int getSpanSize(int position, int spanCount)

Returns the number of spans this item will take, or FILL_ALL_SPANS_AND_PADDINGS. Default implementation calls getSpanSize without spanCount. Subclass may override this method to return span size based on spanCount.

public void invalidateSpanGroupIndexCache()

Clears the span group index cache. GridLayoutManager automatically calls this method when adapter changes occur.

public void invalidateSpanIndexCache()

Clears the span index cache. GridLayoutManager automatically calls this method when adapter changes occur.

public boolean isSpanGroupIndexCacheEnabled()

Returns whether results of getSpanGroupIndex method are cached or not.

public boolean isSpanIndexCacheEnabled()

Returns whether results of getSpanIndex method are cached or not.

public void setSpanGroupIndexCacheEnabled(boolean cacheSpanGroupIndices)

Sets whether the results of getSpanGroupIndex method should be cached or not. By default these values are not cached. If you are not overriding getSpanGroupIndex with something highly performant, and you are using spans to calculate scrollbar offset and range, you should set this to true for better performance.

public void setSpanIndexCacheEnabled(boolean cacheSpanIndices)

Sets whether the results of getSpanIndex method should be cached or not. By default these values are not cached. If you are not overriding getSpanIndex with something highly performant, you should set this to true for better performance.