Class: ListForEachLayout

olympe .ui .std. ListForEachLayout

Vertical and Horizontal List Layout for ForEach

new ListForEachLayout(widthOrHeight [, horizontal] [, themeClass])

Parameters:

Name	Type	Argument	Default	Description
`widthOrHeight`	olympe.df.PONumber			Width of items if layout is vertical, height if layout is horitontal
`horizontal`	boolean \| olympe.df.POBoolean	<optional>	false	List direction
`themeClass`	olympe.df.POString \| string	<optional>

Implements:

olympe.ui.std.ForEachLayout

Methods

addItem(container, renderer, value, index, map, forEach, itemThemeClass)

Parameters:

Name	Type	Description
`container`	olympe.ui.std.AbsoluteLayout
`renderer`	olympe.ui.std.ForEach.ForEachRenderer
`value`	T
`index`	string
`map`	olympe.df.SortedEnumerable
`forEach`	olympe.ui.std.ForEach
`itemThemeClass`	olympe.df.POString

Implements:

olympe.ui.std.ForEachLayout#addItem

Returns:

element

Type: olympe.ui.std.DockableElement

<protected> applyTheme(theme)

Parameters:

Name	Type	Description
`theme`	olympe.ui.std.theme.ListForEachLayoutTheme

getDimension()

Implements:

olympe.ui.std.ForEachLayout#getDimension

Returns:

dimension of the layout

Type: olympe.df.PVector2

getEndIndex()

Implements:

olympe.ui.std.ForEachLayout#getEndIndex

Returns:

last index of visible element (for lazy loading). If lazy is not supported by the layout, this method should return Number.MAX_SAFE_INTEGER

Type: olympe.df.PONumber

getStartIndex()

Implements:

olympe.ui.std.ForEachLayout#getStartIndex

Returns:

number of visible elements (for lazy loading). If lazy loading is not supported by the layout, this method should return 0

Type: olympe.df.PONumber

setAnimation(animation)

Parameters:

Name	Type	Description
`animation`	olympe.ui.std.TransitionAnimation

Returns:

Type: olympe.ui.std.ListForEachLayout

setAnimationDelayBetweenItems(delay)

Parameters:

Name	Type	Description
`delay`	olympe.df.PONumber \| number

Returns:

Type: olympe.ui.std.ListForEachLayout

setDividerSize(size)

Parameters:

Name	Type	Description
`size`	olympe.df.PONumber \| number

Returns:

Type: olympe.ui.std.ListForEachLayout

setDividerTheme(theme)

Parameters:

Name	Type	Description
`theme`	olympe.df.Proxy.<olympe.ui.std.theme.DockableElementTheme> \| olympe.ui.std.theme.DockableElementTheme

Returns:

Type: olympe.ui.std.ListForEachLayout

setHasDivider(hasDivider)

Parameters:

Name	Type	Description
`hasDivider`	olympe.df.POBoolean \| boolean

Returns:

Type: olympe.ui.std.ListForEachLayout