forestry.api.book

Class BookContent<D>

java.lang.Object

forestry.api.book.BookContent<D>

Direct Known Subclasses:

CarpenterContent, CraftingContent, FabricatorContent, ImageContent, IndexContent, MutationContent, StructureContent, TextContent

public abstract class BookContent<D>
extends java.lang.Object

The deserialized content data of a book page. It creates a gui element at the moment the entry gets opened.

Field Summary

Fields

Modifier and Type	Field and Description
D	data A data object that was deserialized from the json object of this content.
java.lang.String	type

Constructor Summary

Constructors

Constructor and Description
BookContent()

Method Summary

Modifier and Type	Method and Description
abstract boolean	addElements(IElementGroup page, IGuiElementFactory factory, BookContent previous, IGuiElement previousElement, int pageHeight) Adds the content to the page by adding a IGuiElement or at the content to the previous element.
abstract java.lang.Class<? extends D>	getDataClass() The class of the data field.
void	onDeserialization() Called after the deserialization.

Methods inherited from class java.lang.Object

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

Field Detail

type

public java.lang.String type

data

@Nullable
public D data

A data object that was deserialized from the json object of this content. Can be everything from an image to a crafting recipe.

Constructor Detail

BookContent

public BookContent()

Method Detail

getDataClass

@Nullable
public abstract java.lang.Class<? extends D> getDataClass()

The class of the data field. Used for the deserialization. If the result of this method is null the data field will be null too.

onDeserialization

public void onDeserialization()

Called after the deserialization.

addElements

public abstract boolean addElements(IElementGroup page,
                                    IGuiElementFactory factory,
                                    @Nullable
                                    BookContent previous,
                                    @Nullable
                                    IGuiElement previousElement,
                                    int pageHeight)

Adds the content to the page by adding a IGuiElement or at the content to the previous element.

Parameters:

page - The gui element that represents a book page

previous - The content of the previous element.

previousElement - The element that was previously added to the page.

pageHeight - The max height of the current page.

Returns:

True if you added an element.