Package space.maxus.flare.ui.compose

Interface Slideshow

All Superinterfaces:

Composable, ComposableLike, Configurable<Slideshow>, Disable

public interface Slideshow
extends Disable, Composable, Configurable<Slideshow>

A slideshow is a periodically changing component.
See more in Flare docs: Slideshow

Nested Class Summary

Nested classes/interfaces inherited from interface space.maxus.flare.ui.compose.Configurable

Configurable.Configurator<S>

Method Summary

Modifier and Type	Method	Description
int	getPeriod()	Returns the period between the slides switching
List<ItemProvider>	getSlides()	Returns all possible slides on this slideshow
ReactiveState<ItemProvider>	itemState()	Returns the reactive state of the currently selected item provider
static @NotNull Slideshow	of(List<ItemProvider> items, int period)	Constructs a new slideshow out of a list of items
static @NotNull Slideshow	of(List<ItemProvider> items, int period, boolean disabled)	Constructs a new slideshow out of a list of items

Methods inherited from interface space.maxus.flare.ui.Composable

asComposable, bind, click, context, contextOrNull, destroy, drag, injectRoot, inside, into, leftClick, markDirty, renderAt, restore, rightClick, root, shiftFrom, shiftInto, viewer

Methods inherited from interface space.maxus.flare.ui.compose.Configurable

configure, configureTyped

Methods inherited from interface space.maxus.flare.ui.compose.Disable

disabledState, isDisabled, isNotDisabled, setDisabled

Method Details

of

@NotNull
static @NotNull Slideshow of(List<ItemProvider> items,
 int period)

Constructs a new slideshow out of a list of items

Parameters:

items - Items to be used

period - Period between switching in ticks

Returns:

A new slideshow

of

@NotNull
static @NotNull Slideshow of(List<ItemProvider> items,
 int period,
 boolean disabled)

Constructs a new slideshow out of a list of items

Parameters:

items - Items to be used

period - Period between switching in ticks

disabled - Whether the slideshow should be disabled

Returns:

A new slideshow

getSlides

List<ItemProvider> getSlides()

Returns all possible slides on this slideshow

Returns:

All possible slides on this slideshow

itemState

ReactiveState<ItemProvider> itemState()

Returns the reactive state of the currently selected item provider

Returns:

The reactive state of the currently selected item provider

getPeriod

int getPeriod()

Returns the period between the slides switching

Returns:

The period between the slides switching