Olympe SDK

Class: ForEach

olympe.ui.std. ForEach

<abstract> new ForEach(dimension, data, renderer, forEachLayout [, growMode] [, selectable] [, multipleSelection] [, themeClass])

Parameters:
Name Type Argument Default Description
dimension olympe.df.PVector2 | undefined

Dimension of the list (when undefined => auto grow is set to width and height)
data olympe.df.Proxy.<olympe.df.SortedEnumerable> | olympe.df.SortedEnumerable
renderer olympe.df.Proxy.<olympe.ui.std.ForEach.ForEachRenderer> | olympe.ui.std.ForEach.ForEachRenderer
forEachLayout olympe.df.Proxy.<olympe.ui.std.ForEachLayout> | olympe.ui.std.ForEachLayout
growMode olympe.df.Proxy.<olympe.ui.common.GrowMode> | olympe.ui.common.GrowMode <optional>
selectable olympe.df.POBoolean | boolean <optional>
 false
multipleSelection olympe.df.POBoolean | boolean <optional>
 false
themeClass olympe.df.POString | string <optional>
Deprecated:

Members

growMode :olympe.df.Proxy.<olympe.ui.common.GrowMode>|olympe.ui.common.GrowMode

Type:

Methods

applyTheme()

clearSelection()

Clear selection

Returns:
Type
olympe.ui.std.ForEach

getSelectedIndex()

Returns:

First selected index

Type
olympe.df.Proxy.<string> | string

getSelectedIndexes()

Returns:

List of selected indexes

Type
olympe.df.Map.<string>

getSelectedValue()

Returns:

First selected value

Type
olympe.df.Proxy.<T> | T

getSelectedValues()

Returns:

List of selected values

Type
olympe.df.Enumerable.<T>

selectAll()

Select all elements of the ForEach (if multiple selection is allowed)

Returns:
Type
olympe.ui.std.ForEach

setData(data)

Sets the list data

Parameters:
Name Type Description
data olympe.df.SortedEnumerable
Returns:
Type
olympe.ui.std.ForEach

setDimension()

Returns:
Type
olympe.ui.std.ForEach

setEvenItemThemeClass(themeClass)

Parameters:
Name Type Description
themeClass olympe.df.POString | string
Returns:
Type
olympe.ui.std.ForEach

setGrowMode(growMode)

Sets the grow mode

Parameters:
Name Type Description
growMode olympe.df.Proxy.<olympe.ui.common.GrowMode> | olympe.ui.common.GrowMode
Returns:
Type
olympe.ui.std.ForEach

setListLayout(forEachLayout)

Set the layout of this list

Parameters:
Name Type Description
forEachLayout olympe.df.Proxy.<olympe.ui.std.ForEachLayout> | olympe.ui.std.ForEachLayout
Returns:
Type
olympe.ui.std.ForEach

setMultipleSelection(multipleSelection)

Parameters:
Name Type Description
multipleSelection olympe.df.POBoolean | boolean
Returns:
Type
olympe.ui.std.ForEach

setOddItemThemeClass(themeClass)

Parameters:
Name Type Description
themeClass olympe.df.POString | string
Returns:
Type
olympe.ui.std.ForEach

setRenderer(renderer)

Sets the row renderer function

Parameters:
Name Type Description
renderer olympe.df.Proxy.<olympe.ui.std.ForEach.ForEachRenderer> | olympe.ui.std.ForEach.ForEachRenderer
Returns:
Type
olympe.ui.std.ForEach

setSelectable(selectable)

Parameters:
Name Type Description
selectable olympe.df.POBoolean | boolean
Returns:
Type
olympe.ui.std.ForEach

setSelectedItemThemeClass(themeClass)

Parameters:
Name Type Description
themeClass olympe.df.POString | string
Returns:
Type
olympe.ui.std.ForEach

Type Definitions

ForEachRenderer(value, index, rank, map, themeClass)

Parameters:
Name Type Description
value *
index string
rank olympe.df.PONumber
map olympe.df.SortedEnumerable
themeClass olympe.df.POString
Returns:
Type
olympe.ui.std.DockableElement