Package com.marcusslover.plus.lib.item

Class Canvas.PopulatorContext<T>

java.lang.Object

com.marcusslover.plus.lib.item.Canvas.PopulatorContext<T>

Type Parameters:

T - the type of the elements

Enclosing class:

Canvas

public static class Canvas.PopulatorContext<T>
extends Object

Represents the context of the population. It holds the elements and the canvas. It also holds the view strategy.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Canvas.PopulatorContext.DefaultViewStrategy	Default view strategies.
static interface	Canvas.PopulatorContext.Populator<T>	Populates one element and provides the player with the button.
static interface	Canvas.PopulatorContext.ViewStrategy	Holds the strategy on how to populate the elements on the canvas.

Constructor Summary

Constructors

Constructor	Description
PopulatorContext()

Method Summary

Modifier and Type	Method	Description
@NotNull Canvas.PopulatorContext<T>	content(@NotNull org.bukkit.entity.Player player, @NotNull Canvas.PopulatorContext.Populator<T> populator)	Modify how the elements are populated on the canvas.
@NotNull Canvas	end()	Return to the canvas.
void	updateContent(@NotNull org.bukkit.entity.Player player, Canvas.PopulatorContext.Populator<?> populator)
@NotNull Canvas.PopulatorContext<T>	viewStrategy(@Nullable Canvas.PopulatorContext.DefaultViewStrategy defaultViewStrategy)	Set the view strategy.
@NotNull Canvas.PopulatorContext<T>	viewStrategy(@Nullable Canvas.PopulatorContext.ViewStrategy viewStrategy)	Set the view strategy.

Methods inherited from class java.lang.Object

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

Constructor Details

PopulatorContext

public PopulatorContext()

Method Details

viewStrategy

@NotNull
public @NotNull Canvas.PopulatorContext<T> viewStrategy(@Nullable
 @Nullable Canvas.PopulatorContext.DefaultViewStrategy defaultViewStrategy)

Set the view strategy. Works only with the default view strategies.

Parameters:

defaultViewStrategy - the view strategy

Returns:

the populator context

viewStrategy

@NotNull
public @NotNull Canvas.PopulatorContext<T> viewStrategy(@Nullable
 @Nullable Canvas.PopulatorContext.ViewStrategy viewStrategy)

Set the view strategy.

Parameters:

viewStrategy - A custom view strategy.

Returns:

The populator context.

updateContent

public void updateContent(@NotNull
 @NotNull org.bukkit.entity.Player player,
 Canvas.PopulatorContext.Populator<?> populator)

content

@NotNull
public @NotNull Canvas.PopulatorContext<T> content(@NotNull
 @NotNull org.bukkit.entity.Player player,
 @NotNull
 @NotNull Canvas.PopulatorContext.Populator<T> populator)

Modify how the elements are populated on the canvas. The populator is called for each element. Additionally, add the page manipulation buttons.

Parameters:

player - the player

populator - the populator

Returns:

the populator context

end

@NotNull
public @NotNull Canvas end()

Return to the canvas.

Returns:

the canvas