com.lukflug.panelstudio

Class ClickGUI

java.lang.Object

com.lukflug.panelstudio.ClickGUI

All Implemented Interfaces:

PanelManager

Direct Known Subclasses:

HUDClickGUI

public class ClickGUI
extends java.lang.Object
implements PanelManager

Object representing the entire GUI. All components should be a direct or indirect child of this objects.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static interface	ClickGUI.LoopFunction Interface used by doComponentLoop(LoopFunction).

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<FixedComponent>	components List of direct child components (i.e. panels).
protected DescriptionRenderer	descriptionRenderer The DescriptionRenderer to be used by the GUI.
protected Interface	inter The Interface to be used by the GUI.
protected java.util.List<FixedComponent>	permanentComponents List of permanent components.

Constructor Summary

Constructors

Constructor and Description
ClickGUI(Interface inter, DescriptionRenderer descriptionRenderer) Constructor for the GUI.

Method Summary

Modifier and Type	Method and Description
void	addComponent(FixedComponent component) Add a component to the GUI.
protected void	doComponentLoop(ClickGUI.LoopFunction function) Loop through all components in reverse order and check for focus requests.
void	enter() Handle the GUI being opened.
void	exit() Handle the GUI being closed.
java.util.List<FixedComponent>	getComponents() Get a list of panels in the GUI.
Toggleable	getComponentToggleable(FixedComponent component) Get toggleable indicating whether a component is shown or not.
protected Context	getContext(FixedComponent component, boolean highest) Create a context for a component.
void	handleButton(int button) Handle a mouse button state change.
void	handleKey(int scancode) Handle a key being typed.
void	handleScroll(int diff) Handle the mouse wheel being scrolled
void	hideComponent(FixedComponent component) Hide a component.
void	loadConfig(ConfigList config) Load the GUI state.
void	render() Render the GUI (lowest component first, highest component last).
void	saveConfig(ConfigList config) Store the GUI state.
void	showComponent(FixedComponent component) Add a component to be visible.

Methods inherited from class java.lang.Object

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

Field Detail

components

protected java.util.List<FixedComponent> components

List of direct child components (i.e. panels). The must all be FixedComponent.

permanentComponents

protected java.util.List<FixedComponent> permanentComponents

List of permanent components.

inter

protected Interface inter

The Interface to be used by the GUI.

descriptionRenderer

protected DescriptionRenderer descriptionRenderer

The DescriptionRenderer to be used by the GUI.

Constructor Detail

ClickGUI

public ClickGUI(Interface inter,
                DescriptionRenderer descriptionRenderer)

Constructor for the GUI.

Parameters:

inter - the Interface to be used by the GUI

descriptionRenderer - the DescriptionRenderer used by the GUI

Method Detail

getComponents

public java.util.List<FixedComponent> getComponents()

Get a list of panels in the GUI.

Returns:

list of all permanent panels (direct children)

addComponent

public void addComponent(FixedComponent component)

Add a component to the GUI.

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

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

Parameters:

component - the component to be removed.

render

public void render()

Render the GUI (lowest component first, highest component last).

handleButton

public void handleButton(int button)

Handle a mouse button state change.

Parameters:

button - the button that changed its state

See Also:

Interface.LBUTTON, Interface.RBUTTON

handleKey

public void handleKey(int scancode)

Handle a key being typed.

Parameters:

scancode - the scancode of the key being typed

handleScroll

public void handleScroll(int diff)

Handle the mouse wheel being scrolled

Parameters:

diff - the amount by which the wheel was moved

enter

public void enter()

Handle the GUI being opened.

exit

public void exit()

Handle the GUI being closed.

saveConfig

public void saveConfig(ConfigList config)

Store the GUI state.

Parameters:

config - the configuration list to be used

loadConfig

public void loadConfig(ConfigList config)

Load the GUI state.

Parameters:

config - the configuration list to be used

getContext

protected Context getContext(FixedComponent component,
                             boolean highest)

Create a context for a component.

Parameters:

component - the component

highest - whether this component is on top

Returns:

the context

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

Parameters:

component - the component in question

Returns:

the toggleable indicating whether the component is shown

doComponentLoop

protected void doComponentLoop(ClickGUI.LoopFunction function)

Loop through all components in reverse order and check for focus requests.

Parameters:

function - the function to execute in the loop