me.devnatan.inventoryframework.component

Class PaginationStateBuilder<Context extends IFContext,Builder extends ItemComponentBuilder<Builder,Context> & ComponentFactory,V>

java.lang.Object

me.devnatan.inventoryframework.component.PaginationStateBuilder<Context,Builder,V>

public final class PaginationStateBuilder<Context extends IFContext,Builder extends ItemComponentBuilder<Builder,Context> & ComponentFactory,V>
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
PaginationStateBuilder(ElementFactory internalElementFactory, java.lang.Object sourceProvider, java.util.function.Function<PaginationStateBuilder<Context,Builder,V>,State<Pagination>> internalStateFactory, boolean async, boolean computed)

Method Summary

Modifier and Type	Method and Description
State<Pagination>	build() Builds a pagination state based on this builder values.
PaginationStateBuilder<Context,Builder,V>	elementFactory(@NotNull PaginationValueConsumer<Context,Builder,V> elementConsumer) Sets the item factory for pagination.
char	getLayoutTarget()
java.util.function.BiConsumer<Context,Pagination>	getPageSwitchHandler()
PaginationElementFactory<V>	getPaginationElementFactory()
java.lang.Object	getSourceProvider()
boolean	isAsync()
boolean	isComputed()
PaginationStateBuilder<Context,Builder,V>	itemFactory(@NotNull java.util.function.BiConsumer<Builder,V> itemFactory) Sets the item factory for pagination.
PaginationStateBuilder<Context,Builder,V>	layoutTarget(char layoutTarget) Defines a target character in the layout whose pagination will be rendered.
PaginationStateBuilder<Context,Builder,V>	onPageSwitch(@NotNull java.util.function.BiConsumer<Context,Pagination> pageSwitchHandler) Handles the page switching action.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PaginationStateBuilder

public PaginationStateBuilder(ElementFactory internalElementFactory,
                              java.lang.Object sourceProvider,
                              java.util.function.Function<PaginationStateBuilder<Context,Builder,V>,State<Pagination>> internalStateFactory,
                              boolean async,
                              boolean computed)

Method Detail

itemFactory

public PaginationStateBuilder<Context,Builder,V> itemFactory(@NotNull
                                                             @NotNull java.util.function.BiConsumer<Builder,V> itemFactory)

Sets the item factory for pagination.

It consists of a function whose first parameter is a derivation of the ItemComponentBuilder that must be used to configure the item, and the second parameter is the current element being paginated.

This function is called for every single paginated element.

Parameters:

itemFactory - The item factory.

Returns:

This pagination state builder.

elementFactory

public PaginationStateBuilder<Context,Builder,V> elementFactory(@NotNull
                                                                @NotNull PaginationValueConsumer<Context,Builder,V> elementConsumer)

Sets the item factory for pagination.

It consists of a function whose first parameter is a derivation of the ItemComponentBuilder that must be used to configure the item, and the second parameter is the current element being paginated.

This function is called for every single paginated element.

Parameters:

elementConsumer - The element consumer.

Returns:

This pagination state builder.

layoutTarget

public PaginationStateBuilder<Context,Builder,V> layoutTarget(char layoutTarget)

Defines a target character in the layout whose pagination will be rendered.

By default, if there is a layout available and a target character has not been explicitly defined in the layout, the layout's rendering target character will be the reserved layout character.

If there is no layout configured, pagination will be rendered throughout the view container.

Parameters:

layoutTarget - The target layout character.

Returns:

This pagination state builder.

onPageSwitch

public PaginationStateBuilder<Context,Builder,V> onPageSwitch(@NotNull
                                                              @NotNull java.util.function.BiConsumer<Context,Pagination> pageSwitchHandler)

Handles the page switching action.

The first parameter is the previous page and the current page can be obtained through Pagination.currentPage().

Parameters:

pageSwitchHandler - The page switch handler.

Returns:

This pagination state builder.

build

public State<Pagination> build()

Builds a pagination state based on this builder values.

Returns:

A new Pagination state.

Throws:

java.lang.IllegalStateException - If the element factory wasn't set.

getLayoutTarget

public char getLayoutTarget()

getSourceProvider

public java.lang.Object getSourceProvider()

isAsync

public boolean isAsync()

isComputed

public boolean isComputed()

getPageSwitchHandler

public java.util.function.BiConsumer<Context,Pagination> getPageSwitchHandler()

getPaginationElementFactory

public PaginationElementFactory<V> getPaginationElementFactory()