Package io.github.projectunified.unihologram.api.paged

Interface PagedHologram<T>

Type Parameters:

T - the type of the location

All Superinterfaces:

Hologram<T>

All Known Implementing Classes:

DHHologram

public interface PagedHologram<T>
extends Hologram<T>

A Hologram that supports multiple pages

Method Summary

Modifier and Type	Method	Description
void	addLine(int page, @NotNull HologramLine line)	Add a line to the hologram
default void	addLine(@NotNull HologramLine line)	Add a line to the hologram
default int	getFirstPage()	Get the first page
default Optional<HologramLine>	getLine(int index)	Get the line at the index
default Optional<HologramLine>	getLine(int page, int index)	Get the line at the index
default @NotNull List<HologramLine>	getLines()	Get the lines of the hologram
@NotNull List<HologramLine>	getLines(int page)	Get the lines of the hologram
int	getPages()	Get the amount of pages
void	insertLine(int page, int index, @NotNull HologramLine line)	Insert a line to the hologram at the index and move the rest down
default void	insertLine(int index, @NotNull HologramLine line)	Insert a line to the hologram at the index and move the rest down
default void	removeLine(int index)	Remove a line at the index from the hologram
void	removeLine(int page, int index)	Remove a line at the index from the hologram
default void	setLine(int page, int index, @NotNull HologramLine line)	Set the line at the index to the new line
default void	setLine(int index, @NotNull HologramLine line)	Set the line at the index to the new line
void	setLines(int page, @NotNull List<HologramLine> lines)	Set the lines of the hologram
default void	setLines(@NotNull List<HologramLine> lines)	Set the lines of the hologram
default int	size()	Get the amount of lines
default int	size(int page)	Get the amount of lines

Methods inherited from interface io.github.projectunified.unihologram.api.Hologram

clear, getLocation, getName, init, isInitialized, setLocation

Method Details

getFirstPage

default int getFirstPage()

Get the first page

Returns:

the first page

getPages

int getPages()

Get the amount of pages

Returns:

the amount

getLines

@NotNull
@NotNull List<HologramLine> getLines(int page)

Get the lines of the hologram

Parameters:

page - the page

Returns:

the lines

setLines

void setLines(int page,
 @NotNull
 @NotNull List<HologramLine> lines)

Set the lines of the hologram

Parameters:

page - the page

lines - the lines

addLine

void addLine(int page,
 @NotNull
 @NotNull HologramLine line)

Add a line to the hologram

Parameters:

page - the page

line - the line

insertLine

void insertLine(int page,
 int index,
 @NotNull
 @NotNull HologramLine line)

Insert a line to the hologram at the index and move the rest down

Parameters:

page - the page

index - the index

line - the line

removeLine

void removeLine(int page,
 int index)

Remove a line at the index from the hologram

Parameters:

page - the page

index - the index

setLine

default void setLine(int page,
 int index,
 @NotNull
 @NotNull HologramLine line)

Set the line at the index to the new line

Parameters:

page - the page

index - the index

line - the new line

getLine

default Optional<HologramLine> getLine(int page,
 int index)

Get the line at the index

Parameters:

page - the page

index - the index

Returns:

the line

size

default int size(int page)

Get the amount of lines

Parameters:

page - the page

Returns:

the amount

getLines

@NotNull
default @NotNull List<HologramLine> getLines()

Description copied from interface: Hologram

Get the lines of the hologram

Specified by:

getLines in interface Hologram<T>

Returns:

the lines

setLines

default void setLines(@NotNull
 @NotNull List<HologramLine> lines)

Description copied from interface: Hologram

Set the lines of the hologram

Specified by:

setLines in interface Hologram<T>

Parameters:

lines - the lines

addLine

default void addLine(@NotNull
 @NotNull HologramLine line)

Description copied from interface: Hologram

Add a line to the hologram

Specified by:

addLine in interface Hologram<T>

Parameters:

line - the line

insertLine

default void insertLine(int index,
 @NotNull
 @NotNull HologramLine line)

Description copied from interface: Hologram

Insert a line to the hologram at the index and move the rest down

Specified by:

insertLine in interface Hologram<T>

Parameters:

index - the index

line - the line

removeLine

default void removeLine(int index)

Description copied from interface: Hologram

Remove a line at the index from the hologram

Specified by:

removeLine in interface Hologram<T>

Parameters:

index - the index

setLine

default void setLine(int index,
 @NotNull
 @NotNull HologramLine line)

Description copied from interface: Hologram

Set the line at the index to the new line

Specified by:

setLine in interface Hologram<T>

Parameters:

index - the index

line - the new line

getLine

default Optional<HologramLine> getLine(int index)

Description copied from interface: Hologram

Get the line at the index

Specified by:

getLine in interface Hologram<T>

Parameters:

index - the index

Returns:

the line

size

default int size()

Description copied from interface: Hologram

Get the amount of lines

Specified by:

size in interface Hologram<T>

Returns:

the amount