buildcraft.lib.gui.help

Class ElementHelpInfo

java.lang.Object

buildcraft.lib.gui.help.ElementHelpInfo

public class ElementHelpInfo
extends java.lang.Object

Defines some information used when displaying help text about a specific IGuiElement. If you want to display help at a particular position, but the target is not an IGuiElement then you should use DummyHelpElement.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ElementHelpInfo.HelpPosition Stores an ElementHelpInfo information, as well as the target area which the help element relates to.

Field Summary

Fields

Modifier and Type	Field and Description
int	colour
java.lang.String[]	localeKeys
java.lang.String	title

Constructor Summary

Constructors

Constructor and Description
ElementHelpInfo(java.lang.String title, int colour, java.lang.String... localeKeys)

Method Summary

Modifier and Type	Method and Description
void	addGuiElements(GuiElementContainerHelp container)
ElementHelpInfo.HelpPosition	target(IGuiArea target)

Methods inherited from class java.lang.Object

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

Field Detail

title

public final java.lang.String title

colour

public final int colour

localeKeys

public final java.lang.String[] localeKeys

Constructor Detail

ElementHelpInfo

public ElementHelpInfo(java.lang.String title,
                       int colour,
                       java.lang.String... localeKeys)

Method Detail

target

public final ElementHelpInfo.HelpPosition target(IGuiArea target)

addGuiElements

public void addGuiElements(GuiElementContainerHelp container)