io.github.portlek.smartinventory

Interface Pagination

All Known Implementing Classes:

BasicPagination

public interface Pagination

a class which lets you switch pages; easily get icons in the given page, easily manipulate the pages and check if a page is the first or the last one (isFirst() / isLast()).

you must start by setting the setIcons(Icon...) and the setIconsPerPage(int), then you can manipulate the pages by using the page(int) / first() / previous() / next() / last() methods.

then, when you need to get all the icons of the current page, either use the getPageIcons() method, or directly add the icons to your inventory with a SlotIterator and the method addToIterator(SlotIterator).

Method Summary

Modifier and Type	Method and Description
default @NotNull Pagination	addToIterator(@NotNull SlotIterator iterator) adds all the current page icons to the given iterator.
@NotNull Pagination	first() Sets the current page to the first page.
int	getPage() gets the current page.
@NotNull Icon[]	getPageIcons() gets the icons of the current page.
boolean	isFirst() checks if the current page is the first page.
boolean	isLast() checks if the current page is the last page.
@NotNull Pagination	last() sets the current page to the last page.
@NotNull Pagination	next() sets the current page to the next page, if the current page is already the last page, this do nothing.
@NotNull Pagination	page(int page) sets the current page.
@NotNull Pagination	previous() sets the current page to the previous page, if the current page is already the first page, this do nothing.
@NotNull Pagination	setIcons(Icon... icons) sets all the icons for this Pagination.
@NotNull Pagination	setIconsPerPage(int iconsPerPage) sets the maximum amount of icons per page.

Method Detail

addToIterator

@NotNull
default @NotNull Pagination addToIterator(@NotNull
                                                   @NotNull SlotIterator iterator)

adds all the current page icons to the given iterator.

Parameters:

iterator - the iterator.

Returns:

this, for chained calls.

getPageIcons

@NotNull
@NotNull Icon[] getPageIcons()

gets the icons of the current page.

this returns an array of the size of the icons per page.

Returns:

the current page icons.

getPage

int getPage()

gets the current page.

Returns:

the current page.

page

@NotNull
@NotNull Pagination page(int page)

sets the current page.

Parameters:

page - the current page.

Returns:

this, for chained calls.

isFirst

boolean isFirst()

checks if the current page is the first page.

this is equivalent to: page == 0.

Returns:

true if this page is the first page.

isLast

boolean isLast()

checks if the current page is the last page.

this is equivalent to: page == iconsCount / iconsPerPage.

Returns:

true if this page is the last page.

first

@NotNull
@NotNull Pagination first()

Sets the current page to the first page.

this is equivalent to: page(0).

Returns:

this, for chained calls.

previous

@NotNull
@NotNull Pagination previous()

sets the current page to the previous page, if the current page is already the first page, this do nothing.

Returns:

this, for chained calls.

next

@NotNull
@NotNull Pagination next()

sets the current page to the next page, if the current page is already the last page, this do nothing.

Returns:

this, for chained calls.

last

@NotNull
@NotNull Pagination last()

sets the current page to the last page.

this is equivalent to: page(iconsCount / iconsPerPage).

Returns:

this, for chained calls.

setIcons

@NotNull
@NotNull Pagination setIcons(@NotNull
                                      Icon... icons)

sets all the icons for this Pagination.

Parameters:

icons - the icons.

Returns:

this, for chained calls.

setIconsPerPage

@NotNull
@NotNull Pagination setIconsPerPage(int iconsPerPage)

sets the maximum amount of icons per page.

Parameters:

iconsPerPage - the maximum amount of icons per page.

Returns:

this, for chained calls.