forestry.book

Class BookCategory

java.lang.Object

forestry.book.BookCategory

All Implemented Interfaces:

IBookCategory

public class BookCategory
extends java.lang.Object
implements IBookCategory

Constructor Summary

Constructors

Constructor and Description
BookCategory(java.lang.String name)

Method Summary

Modifier and Type	Method and Description
IBookCategory	addEntry(IBookEntry entry) Adds an custom entry to the category.
IBookCategory	addEntry(java.lang.String name, net.minecraft.item.ItemStack stack) Adds an entry with the given name and the given icon to the category.
IBookEntryBuilder	createEntry(java.lang.String name) Creates a entry builder with the given name.
IBookEntryBuilder	createEntry(java.lang.String name, net.minecraft.item.ItemStack stack) Creates a entry builder with the given name and the given icon.
java.util.Collection<IBookEntry>	getEntries()
IBookEntry	getEntry(java.lang.String name)
java.lang.String	getLocalizedName()
java.lang.String	getName()
net.minecraft.item.ItemStack	getStack()
java.lang.String	getTooltip() Currently unused
IBookCategory	setStack(net.minecraft.item.ItemStack stack)

Methods inherited from class java.lang.Object

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

Constructor Detail

BookCategory

public BookCategory(java.lang.String name)

Method Detail

getStack

public net.minecraft.item.ItemStack getStack()

Specified by:

getStack in interface IBookCategory

Returns:

the ItemStack that represents this category at the front page.

setStack

public IBookCategory setStack(net.minecraft.item.ItemStack stack)

Specified by:

setStack in interface IBookCategory

addEntry

public IBookCategory addEntry(IBookEntry entry)

Description copied from interface: IBookCategory

Adds an custom entry to the category.

Specified by:

addEntry in interface IBookCategory

addEntry

public IBookCategory addEntry(java.lang.String name,
                              net.minecraft.item.ItemStack stack)

Description copied from interface: IBookCategory

Adds an entry with the given name and the given icon to the category.

Specified by:

addEntry in interface IBookCategory

Parameters:

name - A unique name for this entry.

stack - The stack that will be displayed next to the entry title at the category page.

createEntry

public IBookEntryBuilder createEntry(java.lang.String name)

Description copied from interface: IBookCategory

Creates a entry builder with the given name.

At the end of your creation you have to call IBookEntryBuilder.addToCategory() to add the entry to this category.

Specified by:

createEntry in interface IBookCategory

Parameters:

name - A unique name for this entry.

createEntry

public IBookEntryBuilder createEntry(java.lang.String name,
                                     net.minecraft.item.ItemStack stack)

Description copied from interface: IBookCategory

Creates a entry builder with the given name and the given icon.

At the end of your creation you have to call IBookEntryBuilder.addToCategory() to add the entry to this category.

Specified by:

createEntry in interface IBookCategory

Parameters:

name - A unique name for this entry.

stack - The stack that will be displayed next to the entry title at the category page.

getEntries

public java.util.Collection<IBookEntry> getEntries()

Specified by:

getEntries in interface IBookCategory

Returns:

a collection that contains all entries of this category.

getEntry

@Nullable
public IBookEntry getEntry(java.lang.String name)

Specified by:

getEntry in interface IBookCategory

Returns:

the entry with the given unique name.

getLocalizedName

public java.lang.String getLocalizedName()

Specified by:

getLocalizedName in interface IBookCategory

Returns:

the localized name of this category.

getTooltip

public java.lang.String getTooltip()

Description copied from interface: IBookCategory

Currently unused

Specified by:

getTooltip in interface IBookCategory

getName

public java.lang.String getName()

Specified by:

getName in interface IBookCategory

Returns:

the unique name of this category