buildcraft.lib.client.guide.parts

Class GuidePageBase

java.lang.Object

buildcraft.lib.client.guide.parts.GuidePart

buildcraft.lib.client.guide.parts.GuidePageBase

Direct Known Subclasses:

GuidePage, GuidePageContents

public abstract class GuidePageBase
extends GuidePart

Nested Class Summary

Nested classes/interfaces inherited from class buildcraft.lib.client.guide.parts.GuidePart

GuidePart.PagePosition

Field Summary

Fields

Modifier and Type	Field and Description
protected int	numPages

Fields inherited from class buildcraft.lib.client.guide.parts.GuidePart

gui, INDENT_WIDTH, LINE_HEIGHT, wasHovered, wasIconHovered

Constructor Summary

Constructors

Constructor and Description
GuidePageBase(GuiGuide gui)

Method Summary

Modifier and Type	Method and Description
GuidePageBase	createReloaded() Called when the GuideManager is reloaded.
abstract java.util.List<GuideChapter>	getChapters()
protected GuidePart	getClicked(java.lang.Iterable<GuidePart> iterable, int x, int y, int width, int height, int mouseX, int mouseY, int index)
protected int	getIndex()
int	getPage()
abstract java.lang.String	getTitle()
protected void	goToPage(int page)
GuidePart.PagePosition	handleMouseClick(int x, int y, int width, int height, GuidePart.PagePosition current, int index, int mouseX, int mouseY) Like GuidePart.renderIntoArea(int, int, int, int, PagePosition, int) but for a mouse click.
void	handleMouseClick(int x, int y, int width, int height, int mouseX, int mouseY, int mouseButton, int index, boolean isEditing)
void	handleMouseDragFinish(int startX, int startY, int endX, int endY, int button)
void	handleMouseDragPartial(int startX, int startY, int currentX, int currentY, int button)
boolean	keyTyped(char typedChar, int keyCode)
void	lastPage()
void	nextPage()
void	renderFirstPage(int x, int y, int width, int height)
GuidePart.PagePosition	renderIntoArea(int x, int y, int width, int height, GuidePart.PagePosition current, int index)
protected void	renderPage(int x, int y, int width, int height, int index)
void	renderSecondPage(int x, int y, int width, int height)
boolean	shouldPersistHistory()
void	tick()

Methods inherited from class buildcraft.lib.client.guide.parts.GuidePart

getFontRenderer, renderLine, renderLines, renderLines, renderTextLine, renderTooltip, setFontRenderer, updateScreen, wasHovered

Methods inherited from class java.lang.Object

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

Field Detail

numPages

protected int numPages

Constructor Detail

GuidePageBase

public GuidePageBase(GuiGuide gui)

Method Detail

getIndex

protected final int getIndex()

nextPage

public final void nextPage()

lastPage

public final void lastPage()

goToPage

protected final void goToPage(int page)

getPage

public int getPage()

tick

public void tick()

renderIntoArea

public final GuidePart.PagePosition renderIntoArea(int x,
                                                   int y,
                                                   int width,
                                                   int height,
                                                   GuidePart.PagePosition current,
                                                   int index)

Specified by:

renderIntoArea in class GuidePart

current - The current position to render from

index - The current page index to render on

Returns:

The new position for the next part to render from

getTitle

public abstract java.lang.String getTitle()

shouldPersistHistory

public boolean shouldPersistHistory()

createReloaded

@Nullable
public GuidePageBase createReloaded()

Called when the GuideManager is reloaded.

Returns:

A page that can be shown and is valid after the reload, or null if this page cannot continue through a reload.

getChapters

public abstract java.util.List<GuideChapter> getChapters()

getClicked

protected GuidePart getClicked(java.lang.Iterable<GuidePart> iterable,
                               int x,
                               int y,
                               int width,
                               int height,
                               int mouseX,
                               int mouseY,
                               int index)

renderFirstPage

public void renderFirstPage(int x,
                            int y,
                            int width,
                            int height)

renderSecondPage

public void renderSecondPage(int x,
                             int y,
                             int width,
                             int height)

renderPage

protected void renderPage(int x,
                          int y,
                          int width,
                          int height,
                          int index)

handleMouseClick

public final GuidePart.PagePosition handleMouseClick(int x,
                                                     int y,
                                                     int width,
                                                     int height,
                                                     GuidePart.PagePosition current,
                                                     int index,
                                                     int mouseX,
                                                     int mouseY)

Description copied from class: GuidePart

Like GuidePart.renderIntoArea(int, int, int, int, PagePosition, int) but for a mouse click.

Specified by:

handleMouseClick in class GuidePart

handleMouseClick

public void handleMouseClick(int x,
                             int y,
                             int width,
                             int height,
                             int mouseX,
                             int mouseY,
                             int mouseButton,
                             int index,
                             boolean isEditing)

handleMouseDragPartial

public final void handleMouseDragPartial(int startX,
                                         int startY,
                                         int currentX,
                                         int currentY,
                                         int button)

Overrides:

handleMouseDragPartial in class GuidePart

handleMouseDragFinish

public final void handleMouseDragFinish(int startX,
                                        int startY,
                                        int endX,
                                        int endY,
                                        int button)

Overrides:

handleMouseDragFinish in class GuidePart

keyTyped

public boolean keyTyped(char typedChar,
                        int keyCode)
                 throws java.io.IOException

Throws:

java.io.IOException