me.devnatan.inventoryframework

Class ViewConfigBuilder

java.lang.Object

me.devnatan.inventoryframework.ViewConfigBuilder

public final class ViewConfigBuilder
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
ViewConfigBuilder()

Method Summary

Modifier and Type	Method and Description
ViewConfig	build()
ViewConfigBuilder	cancelOnClick()
ViewConfigBuilder	cancelOnDrag() Cancels any item drag into the view.
ViewConfigBuilder	cancelOnDrop() Cancels any item drops by the player while the view is open.
ViewConfigBuilder	cancelOnPickup() Cancels any item pickup by the player while the view is open.
(package private) long	getInteractionDelayInMillis()
(package private) java.lang.String[]	getLayout()
(package private) java.util.Set<ViewConfig.Modifier>	getModifiers()
(package private) java.util.Set<ViewConfig.Option<?>>	getOptions()
(package private) int	getSize()
(package private) java.lang.Object	getTitle()
(package private) ViewType	getType()
(package private) long	getUpdateIntervalInTicks()
ViewConfigBuilder	inheritFrom(@NotNull ViewConfigBuilder other) Inherits all configuration from another ViewConfigBuilder value.
ViewConfigBuilder	interactionDelay(java.time.Duration interactionDelay) Waits a fixed delay before any player interaction.
static boolean	isTitleAsComponentSupported()
boolean	isTransitiveInitialData()
ViewConfigBuilder	layout(java.lang.String... layout) Defines the layout that will be used.
ViewConfigBuilder	maxSize()
ViewConfigBuilder	options(ViewConfig.Option<?>... options)
ViewConfigBuilder	scheduleUpdate(long intervalInTicks) Schedules the view to update every fixed interval.
ViewConfigBuilder	size(int size) Defines the size of the container.
ViewConfigBuilder	title(java.lang.Object title) Defines the title of the container.
ViewConfigBuilder	transitiveInitialData(boolean transitiveInitialData) When navigating between views data from "A" to "B" is not carried so trying to access some data from "A" in "B" will throw a NullPointerException.
ViewConfigBuilder	type(ViewType type) Defines the type of the container.
ViewConfigBuilder	use(ViewConfig.Modifier... modifiers) Uses a modifier in this config.
ViewConfigBuilder	use(ViewConfig.Modifier modifier) Uses a modifier in this config.
ViewConfigBuilder	with(ViewConfig.Modifier... modifiers) Adds a modifier to this config.
ViewConfigBuilder	with(ViewConfig.Modifier modifier) Adds a modifier to this config.

Methods inherited from class java.lang.Object

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

Constructor Detail

ViewConfigBuilder

public ViewConfigBuilder()

Method Detail

inheritFrom

public ViewConfigBuilder inheritFrom(@NotNull
                                     @NotNull ViewConfigBuilder other)

Inherits all configuration from another ViewConfigBuilder value.

Note that the values will be merged and not replaced, however, the values of the setting to be inherited take precedence over those of that setting.

Parameters:

other - The configuration that will be inherited.

Returns:

This config.

type

public ViewConfigBuilder type(ViewType type)

Defines the type of the container.

If applied in view scope, it will be the default value for all contexts originated from it.

Parameters:

type - The container type.

Returns:

This config.

title

public ViewConfigBuilder title(java.lang.Object title)

Defines the title of the container.

Kyori's Adventure Text Component is supported if your platform is PaperSpigot in a non-legacy version. Non-String titles will be converted to a plain text.

Parameters:

title - The container title.

Returns:

This configuration builder.

size

public ViewConfigBuilder size(int size)

Defines the size of the container.

If applied in view scope, it will be the default value for all contexts originated from it.

Parameters:

size - The container size.

Returns:

This configuration builder.

maxSize

public ViewConfigBuilder maxSize()

with

public ViewConfigBuilder with(@NotNull
                              ViewConfig.Modifier modifier)

Adds a modifier to this config.

Parameters:

modifier - The modifier that'll be added.

Returns:

This configuration builder.

with

public ViewConfigBuilder with(ViewConfig.Modifier... modifiers)

Adds a modifier to this config.

Parameters:

modifiers - Modifiers to add.

Returns:

This configuration builder.

use

public ViewConfigBuilder use(@NotNull
                             ViewConfig.Modifier modifier)

Uses a modifier in this config.

Parameters:

modifier - The modifiers to use.

Returns:

This configuration builder.

use

public ViewConfigBuilder use(ViewConfig.Modifier... modifiers)

Uses a modifier in this config.

Parameters:

modifiers - Modifiers to use.

Returns:

This configuration builder.

layout

public ViewConfigBuilder layout(java.lang.String... layout)

Defines the layout that will be used.

Parameters:

layout - The layout.

Returns:

This configuration builder.

Throws:

InvalidLayoutException - If the layout does not respect the container contracts of the context in which it was applied (e.g. if the layout size differs from the container size).

options

public ViewConfigBuilder options(ViewConfig.Option<?>... options)

cancelOnClick

public ViewConfigBuilder cancelOnClick()

cancelOnPickup

public ViewConfigBuilder cancelOnPickup()

Cancels any item pickup by the player while the view is open.

Returns:

This configuration builder.

cancelOnDrop

public ViewConfigBuilder cancelOnDrop()

Cancels any item drops by the player while the view is open.

Returns:

This configuration builder.

cancelOnDrag

public ViewConfigBuilder cancelOnDrag()

Cancels any item drag into the view.

Returns:

This configuration builder.

scheduleUpdate

public ViewConfigBuilder scheduleUpdate(long intervalInTicks)

Schedules the view to update every fixed interval.

Parameters:

intervalInTicks - The interval in ticks.

Returns:

This configuration builder.

See Also:

Scheduled Updates on Wiki

interactionDelay

@ApiStatus.Experimental
public ViewConfigBuilder interactionDelay(java.time.Duration interactionDelay)

Waits a fixed delay before any player interaction.

Interactions called before delay completion are cancelled.

This API is experimental and is not subject to the general compatibility guarantees such API may be changed or may be removed completely in any further release.

Parameters:

interactionDelay - Duration of the interaction delay or null to reset.

Returns:

This configuration builder.

transitiveInitialData

public ViewConfigBuilder transitiveInitialData(boolean transitiveInitialData)

When navigating between views data from "A" to "B" is not carried so trying to access some data from "A" in "B" will throw a NullPointerException.

This behavior can be changed by enabling this option, once enabled, on every navigation between views data will be carried from the view where came from to the view where are going.

Returns:

This configuration builder.

See Also:

Navigating Between Views on Wiki

build

public ViewConfig build()

isTitleAsComponentSupported

public static boolean isTitleAsComponentSupported()

getTitle

java.lang.Object getTitle()

getSize

int getSize()

getType

ViewType getType()

getOptions

java.util.Set<ViewConfig.Option<?>> getOptions()

getLayout

java.lang.String[] getLayout()

getModifiers

java.util.Set<ViewConfig.Modifier> getModifiers()

getUpdateIntervalInTicks

long getUpdateIntervalInTicks()

getInteractionDelayInMillis

long getInteractionDelayInMillis()

isTransitiveInitialData

public boolean isTransitiveInitialData()