Skip to content

Latest commit

 

History

History
37 lines (26 loc) · 2.32 KB

ListMixin.md

File metadata and controls

37 lines (26 loc) · 2.32 KB

ListMixin

Class Summary

The ml.listMixin namespace contains functions for creating and configuring a ListContent object to be used in a list component.

To create a ListContent object using the ml.listMixin namespace, you can follow these steps:

  1. Create a ListSettings object using the createListSettings() function. This object defines the general settings for the list, such as the layout, dimensions, and focus settings.
  2. Create a RowSettings object using the createRowSettings() or createGridRowSettings() function. This object defines the settings for the rows in the list, such as the dimensions, focus settings, and cell settings.
  3. Create a HeaderSettings object using the createHeaderSettings() function. This object defines the settings for the headers in the list, such as the label, height, font, and color.
  4. Create a CellSettings object using the createCellSettings() function. This object defines the settings for the cells in the list, such as the dimensions, space, and screen position.
  5. Create a FocusSettings object using the createFocusSettings() function. This object defines the focus settings for the list, such as the animation style, offsets, and feedback style.
  6. Use the createListContent() function to create a ListContent object using the settings objects created in steps 1-5.

Here is an example of how to create a ListContent object using the ml.listMixin namespace:

' Create a ListSettings object
listSettings = ml.listMixin.createListSettings()

' Create a RowSettings object
rowSettings = ml.listMixin.createRowSettings()

' Create a HeaderSettings object
headerSettings = ml.listMixin.createHeaderSettings()

' Create a CellSettings object
cellSettings = ml.listMixin.createCellSettings()

' Create a FocusSettings object
focusSettings = ml.listMixin.createFocusSettings()

' Create a ListContent object using the settings objects
listContent = ml.listMixin.createListContent(focusSettings, rowSettings, listSettings)

Once you have created a ListContent object, you can use the getRowSettings(), getCellSettings(), and getFocusSettings() functions to retrieve the individual settings for a row, cell, or focus in the list. You can also use the configureRowSettings() and setTileSettings() functions to modify the settings for a row or cell in the list.