io.github.portlek.smartinventory.content

Class BasicPagination

java.lang.Object

io.github.portlek.smartinventory.content.BasicPagination

All Implemented Interfaces:

Pagination

public final class BasicPagination
extends Object
implements Pagination

an implementation for Pagination.

Constructor Summary

Constructors

Constructor and Description
BasicPagination()

Method Summary

Modifier and Type	Method and Description
@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.

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.github.portlek.smartinventory.Pagination

addToIterator

Constructor Detail

BasicPagination

public BasicPagination()

Method Detail

getPageIcons

@NotNull
public @NotNull Icon[] getPageIcons()

Description copied from interface: Pagination

gets the icons of the current page.

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

Specified by:

getPageIcons in interface Pagination

Returns:

the current page icons.

getPage

public int getPage()

Description copied from interface: Pagination

gets the current page.

Specified by:

getPage in interface Pagination

Returns:

the current page.

page

@NotNull
public @NotNull Pagination page(int page)

Description copied from interface: Pagination

sets the current page.

Specified by:

page in interface Pagination

Parameters:

page - the current page.

Returns:

this, for chained calls.

isFirst

public boolean isFirst()

Description copied from interface: Pagination

checks if the current page is the first page.

this is equivalent to: page == 0.

Specified by:

isFirst in interface Pagination

Returns:

true if this page is the first page.

isLast

public boolean isLast()

Description copied from interface: Pagination

checks if the current page is the last page.

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

Specified by:

isLast in interface Pagination

Returns:

true if this page is the last page.

first

@NotNull
public @NotNull Pagination first()

Description copied from interface: Pagination

Sets the current page to the first page.

this is equivalent to: page(0).

Specified by:

first in interface Pagination

Returns:

this, for chained calls.

previous

@NotNull
public @NotNull Pagination previous()

Description copied from interface: Pagination

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

Specified by:

previous in interface Pagination

Returns:

this, for chained calls.

next

@NotNull
public @NotNull Pagination next()

Description copied from interface: Pagination

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

Specified by:

next in interface Pagination

Returns:

this, for chained calls.

last

@NotNull
public @NotNull Pagination last()

Description copied from interface: Pagination

sets the current page to the last page.

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

Specified by:

last in interface Pagination

Returns:

this, for chained calls.

setIcons

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

Description copied from interface: Pagination

sets all the icons for this Pagination.

Specified by:

setIcons in interface Pagination

Parameters:

icons - the icons.

Returns:

this, for chained calls.

setIconsPerPage

@NotNull
public @NotNull Pagination setIconsPerPage(int iconsPerPage)

Description copied from interface: Pagination

sets the maximum amount of icons per page.

Specified by:

setIconsPerPage in interface Pagination

Parameters:

iconsPerPage - the maximum amount of icons per page.

Returns:

this, for chained calls.