com.lukflug.panelstudio.hud

Class HUDClickGUI

java.lang.Object

com.lukflug.panelstudio.ClickGUI

com.lukflug.panelstudio.hud.HUDClickGUI

All Implemented Interfaces:

PanelManager, Toggleable

public class HUDClickGUI
extends ClickGUI
implements Toggleable

ClickGUI that only renders HUD components when closed.

Nested Class Summary

Nested classes/interfaces inherited from class com.lukflug.panelstudio.ClickGUI

ClickGUI.LoopFunction

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<FixedComponent>	allComponents List of all components.
protected boolean	guiOpen Whether the GUI components are shown or not.
protected java.util.List<FixedComponent>	hudComponents List of HUD components.

Fields inherited from class com.lukflug.panelstudio.ClickGUI

components, descriptionRenderer, inter, permanentComponents

Constructor Summary

Constructors

Constructor and Description
HUDClickGUI(Interface inter, DescriptionRenderer descriptionRenderer) Constructor.

Method Summary

Modifier and Type	Method and Description
void	addComponent(FixedComponent component) Add component to allComponents instead of the ClickGUI list.
void	addHUDComponent(FixedComponent component) Add component to allComponents and hudComponents.
void	enter() Handle the GUI being opened.
void	exit() Handle the GUI being closed.
Toggleable	getComponentToggleable(FixedComponent component) Get toggleable indicating whether a component is shown or not.
void	hideComponent(FixedComponent component) Hide a component.
boolean	isOn() Returns whether GUI is open.
void	showComponent(FixedComponent component) Add a component to be visible.
void	toggle() Toggles GUI open state and chooses right components to render.

Methods inherited from class com.lukflug.panelstudio.ClickGUI

doComponentLoop, getComponents, getContext, handleButton, handleKey, handleScroll, loadConfig, render, saveConfig

Methods inherited from class java.lang.Object

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

Field Detail

allComponents

protected java.util.List<FixedComponent> allComponents

List of all components.

hudComponents

protected java.util.List<FixedComponent> hudComponents

List of HUD components.

guiOpen

protected boolean guiOpen

Whether the GUI components are shown or not.

Constructor Detail

HUDClickGUI

public HUDClickGUI(Interface inter,
                   DescriptionRenderer descriptionRenderer)

Constructor.

Parameters:

inter - the interface for the ClickGUI

descriptionRenderer - the DescriptionRenderer used by the GUI

Method Detail

addComponent

public void addComponent(FixedComponent component)

Add component to allComponents instead of the ClickGUI list.

Overrides:

addComponent in class ClickGUI

Parameters:

component - component to be added

showComponent

public void showComponent(FixedComponent component)

Description copied from interface: PanelManager

Add a component to be visible.

Specified by:

showComponent in interface PanelManager

Overrides:

showComponent in class ClickGUI

Parameters:

component - the component to be added.

hideComponent

public void hideComponent(FixedComponent component)

Description copied from interface: PanelManager

Hide a component.

Specified by:

hideComponent in interface PanelManager

Overrides:

hideComponent in class ClickGUI

Parameters:

component - the component to be removed.

addHUDComponent

public void addHUDComponent(FixedComponent component)

Add component to allComponents and hudComponents.

Parameters:

component - the new HUD component

enter

public void enter()

Handle the GUI being opened.

Overrides:

enter in class ClickGUI

exit

public void exit()

Handle the GUI being closed.

Overrides:

exit in class ClickGUI

toggle

public void toggle()

Toggles GUI open state and chooses right components to render.

Specified by:

toggle in interface Toggleable

isOn

public boolean isOn()

Returns whether GUI is open.

Specified by:

isOn in interface Toggleable

Returns:

the value

getComponentToggleable

public Toggleable getComponentToggleable(FixedComponent component)

Description copied from interface: PanelManager

Get toggleable indicating whether a component is shown or not.

Specified by:

getComponentToggleable in interface PanelManager

Overrides:

getComponentToggleable in class ClickGUI

Parameters:

component - the component in question

Returns:

the toggleable indicating whether the component is shown