com.lukflug.panelstudio.hud

Class HUDComponent

java.lang.Object

com.lukflug.panelstudio.hud.HUDComponent

All Implemented Interfaces:

Component, FixedComponent

Direct Known Subclasses:

ListComponent

public abstract class HUDComponent
extends java.lang.Object
implements FixedComponent

Base class for HUD elements.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.awt.Point	position Current position;
protected Renderer	renderer The Renderer for this component.
protected java.lang.String	title The caption of this component.

Constructor Summary

Constructors

Constructor and Description
HUDComponent(java.lang.String title, Renderer renderer, java.awt.Point position)

Method Summary

Modifier and Type	Method and Description
void	enter(Context context) Do nothing.
void	exit(Context context) Do nothing.
java.awt.Point	getPosition(Interface inter) Get the component position.
java.lang.String	getTitle() Get the caption of the component.
void	handleButton(Context context, int button) Do nothing.
void	handleKey(Context context, int scancode) Do nothing.
void	handleScroll(Context context, int diff) Do nothing.
void	loadConfig(Interface inter, PanelConfig config) Loads the component state
void	releaseFocus() Do nothing.
void	render(Context context) Set component height.
void	saveConfig(Interface inter, PanelConfig config) Saves the component state
void	setPosition(Interface inter, java.awt.Point position) Set the component position.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.lukflug.panelstudio.FixedComponent

getWidth

Methods inherited from interface com.lukflug.panelstudio.Component

getHeight

Field Detail

title

protected java.lang.String title

The caption of this component.

renderer

protected Renderer renderer

The Renderer for this component.

position

protected java.awt.Point position

Current position;

Constructor Detail

HUDComponent

public HUDComponent(java.lang.String title,
                    Renderer renderer,
                    java.awt.Point position)

Method Detail

getTitle

public java.lang.String getTitle()

Description copied from interface: Component

Get the caption of the component. String may also be empty.

Specified by:

getTitle in interface Component

Returns:

the caption of the component

render

public void render(Context context)

Set component height.

Specified by:

render in interface Component

Parameters:

context - the Context for the component

handleButton

public void handleButton(Context context,
                         int button)

Do nothing.

Specified by:

handleButton in interface Component

Parameters:

context - the Context for the component

button - the button that changed its state

See Also:

Interface.LBUTTON, Interface.RBUTTON

handleKey

public void handleKey(Context context,
                      int scancode)

Do nothing.

Specified by:

handleKey in interface Component

Parameters:

context - the Context for the component

scancode - the scancode for the key that was typed

handleScroll

public void handleScroll(Context context,
                         int diff)

Do nothing.

Specified by:

handleScroll in interface Component

Parameters:

context - the Context for the component

diff - the amount by which the wheel was moved

enter

public void enter(Context context)

Do nothing.

Specified by:

enter in interface Component

Parameters:

context - the Context for the component

exit

public void exit(Context context)

Do nothing.

Specified by:

exit in interface Component

Parameters:

context - the Context for the component

releaseFocus

public void releaseFocus()

Do nothing.

Specified by:

releaseFocus in interface Component

getPosition

public java.awt.Point getPosition(Interface inter)

Get the component position.

Specified by:

getPosition in interface FixedComponent

Parameters:

inter - current interface

Returns:

current position

setPosition

public void setPosition(Interface inter,
                        java.awt.Point position)

Set the component position.

Specified by:

setPosition in interface FixedComponent

Parameters:

inter - current interface

position - new position

saveConfig

public void saveConfig(Interface inter,
                       PanelConfig config)

Description copied from interface: FixedComponent

Saves the component state

Specified by:

saveConfig in interface FixedComponent

Parameters:

inter - current interface

config - configuration to use

loadConfig

public void loadConfig(Interface inter,
                       PanelConfig config)

Description copied from interface: FixedComponent

Loads the component state

Specified by:

loadConfig in interface FixedComponent

Parameters:

inter - current interface

config - configuration to use