GridAdapterTParams, TCellVH Class

An optimized adapter for a GridView

Implements OSATParams, TItemViewsHolder to simulate a grid by using

a runtime-generated "row" prefab (or "colum" prefab, if horizontal ScrollView), having a Horizontal (or Vertical, respectively) LayoutGroup component, inside which its corresponding cells will lie.

This prefab is represented by a CellGroupViewsHolderTCellVH, which nicely abstractizes the mechanism to using cell prefabs. This views holder is managed internally and is no concern for most users.

The cell prefab is used the same way as the "item prefab", for those already familiarized with the ListView examples. It is represented

by a CellViewsHolder, which are the actual views holders you need to create/update and nothing else.

Inheritance Hierarchy

SystemObject
  Object
    Component
      Behaviour
        MonoBehaviour
          Com.ForbiddenByte.OSA.CoreOSATParams, CellGroupViewsHolderTCellVH
            Com.ForbiddenByte.OSA.CustomAdapters.GridViewGridAdapterTParams, TCellVH
              Com.ForbiddenByte.OSA.Demos.GridGridExample
              Com.ForbiddenByte.OSA.Demos.NestedScrollViewsChildGridExample
              Com.ForbiddenByte.OSA.Demos.SelectAndDeleteSelectAndDeleteExample

Namespace: Com.ForbiddenByte.OSA.CustomAdapters.GridView
Assembly: Assembly-CSharp (in Assembly-CSharp.dll) Version: 0.0.0.0

Syntax

Copy

public abstract class GridAdapter<TParams, TCellVH> : OSA<TParams, CellGroupViewsHolder<TCellVH>>
where TParams : GridParams
where TCellVH : new(), CellViewsHolder

Type Parameters

TParams: Must inherit from GridParams. See also Parameters
TCellVH: The views holder type to use for the cell. Must inherit from CellViewsHolder

The GridAdapterTParams, TCellVH type exposes the following members.

Constructors

	Name	Description
	GridAdapterTParams, TCellVH

Top

Properties

	Name	Description
	CellsCount	The "items count". Same value is returned in GetItemsCount

Top

Methods

	Name	Description
	Awake	(Overrides OSATParams, TItemViewsHolderAwake.)
	ChangeItemsCount	Overridden in order to convert the cellsCount to groupsCount before passing it to the base's implementation (Overrides OSATParams, TItemViewsHolderChangeItemsCount(ItemCountChangeMode, Int32, Int32, Boolean, Boolean).)
	CreateViewsHolder	Creates the Group viewsholder which instantiates the group prefab using the provided params in Init (Overrides OSATParams, TItemViewsHolderCreateViewsHolder(Int32).)
	GetCellGroupsCount
	GetCellViewsHolder	Retrieve the views holder of a cell with speciffic index in view. For example, one can iterate from 0 to GetNumVisibleCells in order to do something with each visible cell. Not to be mistaken for GetCellViewsHolderIfVisible(Int32), which retrieves a cell by the index of its corresponding model in your data list (ItemIndex)
	GetCellViewsHolderIfVisible	Retrieve the views holder of a cell whose associated model's index in your data list is withCellItemIndex. Not to be mistaken for GetCellViewsHolder(Int32) which retrieves a cell by its index _VisibleItems
	GetItemsCount	Overriding base's implementation to return the cells count, instead of the groups count (Overrides OSATParams, TItemViewsHolderGetItemsCount.)
	GetNumVisibleCells	The number of visible cells
	GetViewsHolderClosestToViewportLongitudinalNormalizedAbstractPoint	Tha base implementation finds the group. Here, we're narrowing the search in the group iself in order to return the CellViewsHolder (Overrides OSATParams, TItemViewsHolderGetViewsHolderClosestToViewportLongitudinalNormalizedAbstractPoint(Canvas, RectTransform, Single, Single, Single).)
	InsertItems	Not currently implemented for GridAdapters (Overrides OSATParams, TItemViewsHolderInsertItems(Int32, Int32, Boolean, Boolean).)
	OnBeforeRecycleOrDisableCellViewsHolder	The only important callback for inheritors. It provides cell's views holder which has just become visible and whose views should be updated from its corresponding data model. viewsHolder.ItemIndex(ItemIndex) can be used to know what data model is associated with.
	OnBeforeRecycleOrDisableViewsHolder	Overridden in order to call OnBeforeRecycleOrDisableCellViewsHolder(TCellVH, Int32) for each active cell in the group (Overrides OSATParams, TItemViewsHolderOnBeforeRecycleOrDisableViewsHolder(TItemViewsHolder, Int32).)
	OnCellGroupsRefreshed
	OnItemIndexChangedDueInsertOrRemove	This is not needed yet in case of grid adapters (Overrides OSATParams, TItemViewsHolderOnItemIndexChangedDueInsertOrRemove(TItemViewsHolder, Int32, Boolean, Int32).)
	RebuildLayoutDueToScrollViewSizeChange	(Overrides OSATParams, TItemViewsHolderRebuildLayoutDueToScrollViewSizeChange.)
	Refresh	Overriding base's implementation so that we pass the cells count to our own implementation which converts them to group count before further passing it to the base impl. (Overrides OSATParams, TItemViewsHolderRefresh(Boolean, Boolean).)
	RemoveItems	Not currently implemented fir GridAdapters (Overrides OSATParams, TItemViewsHolderRemoveItems(Int32, Int32, Boolean, Boolean).)
	ScrollTo	Scrolls to the specified cell. Use ScrollToGroup(Int32, Single, Single) if that was intended instead (Overrides OSATParams, TItemViewsHolderScrollTo(Int32, Single, Single).)
	ScrollToGroup	Scroll to the specified GROUP. Use ScrollTo(Int32, Single, Single) if scrolling to a CELL was intended instead
	SmoothScrollTo	Scrolls to the specified cell. Use SmoothScrollToGroup(Int32, Single, Single, Single, FuncSingle, Boolean, Boolean) if that was intended instead (Overrides OSATParams, TItemViewsHolderSmoothScrollTo(Int32, Single, Single, Single, FuncSingle, Boolean, Boolean).)
	SmoothScrollToGroup	See ScrollToGroup(Int32, Single, Single)
	UpdateCellViewsHolder	The only important callback for inheritors. It provides cell's views holder which has just become visible and whose views should be updated from its corresponding data model. viewsHolder.ItemIndex(ItemIndex) can be used to know what data model is associated with.
	UpdateViewsHolder	Here the grid adapter checks if new groups need to be created or if old ones need to be disabled or destroyed, after which it calls UpdateCellViewsHolder(TCellVH) for each remaining cells (Overrides OSATParams, TItemViewsHolderUpdateViewsHolder(TItemViewsHolder).)