com.lukflug.panelstudio.hud

Class HUDPanel

java.lang.Object

com.lukflug.panelstudio.FocusableComponent

com.lukflug.panelstudio.CollapsibleContainer

com.lukflug.panelstudio.DraggableContainer

com.lukflug.panelstudio.hud.HUDPanel

All Implemented Interfaces:

Component, FixedComponent, Toggleable

public class HUDPanel
extends DraggableContainer

Panel holding an HUD component.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	HUDPanel.HUDRenderer Proxy for a Renderer, doesn't display container, when GUI is off.

Field Summary

Fields

Modifier and Type	Field and Description
protected FixedComponent	component The HUD component.
protected Toggleable	guiOpen Whether GUI is open.

Fields inherited from class com.lukflug.panelstudio.DraggableContainer

attachPoint, bodyDrag, dragging, position, width

Fields inherited from class com.lukflug.panelstudio.CollapsibleContainer

childHeight, container, containerHeight, open, scroll, scrollPosition, toggle

Fields inherited from class com.lukflug.panelstudio.FocusableComponent

description, renderer, title

Constructor Summary

Constructors

Constructor and Description
HUDPanel(FixedComponent component, Renderer renderer, Toggleable open, Animation animation, Toggleable guiOpen, int minBorder) Constructor.

Method Summary

Modifier and Type	Method and Description
protected java.awt.Rectangle	getClipRect(Context context, int height) Disable clipping, if container fully open.
java.awt.Point	getPosition(Interface inter) Gets position from child component.
int	getWidth(Interface inter) Get the child component width.
void	handleButton(Context context, int button) Mask out input, if GUI is turned off.
void	handleScroll(Context context, int diff) Mask out input, if GUI is turned off.
void	loadConfig(Interface inter, PanelConfig config) Loads the component state
void	saveConfig(Interface inter, PanelConfig config) Saves the component state
void	setPosition(Interface inter, java.awt.Point position) Sets position of child component.

Methods inherited from class com.lukflug.panelstudio.DraggableContainer

handleFocus

Methods inherited from class com.lukflug.panelstudio.CollapsibleContainer

addComponent, enter, exit, getContainerOffset, getHeight, getRenderHeight, getScrollHeight, getSubContext, handleKey, isActive, isOn, render, toggle

Methods inherited from class com.lukflug.panelstudio.FocusableComponent

getTitle, hasFocus, releaseFocus, updateFocus

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.Component

enter, exit, getHeight, getTitle, handleKey, releaseFocus, render

Field Detail

guiOpen

protected Toggleable guiOpen

Whether GUI is open.

component

protected FixedComponent component

The HUD component.

Constructor Detail

HUDPanel

public HUDPanel(FixedComponent component,
                Renderer renderer,
                Toggleable open,
                Animation animation,
                Toggleable guiOpen,
                int minBorder)

Constructor.

Parameters:

component - the component

renderer - the renderer for this container

open - toggleable indicating whether the container is open or closed

animation - the animation for opening and closing this container

guiOpen - whether to accept input and render container itself or not

minBorder - the minimum border for the container

Method Detail

handleButton

public void handleButton(Context context,
                         int button)

Mask out input, if GUI is turned off.

Specified by:

handleButton in interface Component

Overrides:

handleButton in class DraggableContainer

Parameters:

context - the Context for the component

button - the button that changed its state

See Also:

Interface.LBUTTON, Interface.RBUTTON

handleScroll

public void handleScroll(Context context,
                         int diff)

Mask out input, if GUI is turned off.

Specified by:

handleScroll in interface Component

Overrides:

handleScroll in class CollapsibleContainer

Parameters:

context - the Context for the component

diff - the amount by which the wheel was moved

getPosition

public java.awt.Point getPosition(Interface inter)

Gets position from child component.

Specified by:

getPosition in interface FixedComponent

Overrides:

getPosition in class DraggableContainer

Parameters:

inter - current interface

Returns:

current position

setPosition

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

Sets position of child component.

Specified by:

setPosition in interface FixedComponent

Overrides:

setPosition in class DraggableContainer

Parameters:

inter - current interface

position - new position

getWidth

public int getWidth(Interface inter)

Get the child component width.

Specified by:

getWidth in interface FixedComponent

Overrides:

getWidth in class DraggableContainer

Parameters:

inter - current interface

Returns:

component width

getClipRect

protected java.awt.Rectangle getClipRect(Context context,
                                         int height)

Disable clipping, if container fully open.

Overrides:

getClipRect in class CollapsibleContainer

Parameters:

context - the context for this component

height - the height of the container

Returns:

the clipping rectangle

saveConfig

public void saveConfig(Interface inter,
                       PanelConfig config)

Description copied from interface: FixedComponent

Saves the component state

Specified by:

saveConfig in interface FixedComponent

Overrides:

saveConfig in class DraggableContainer

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

Overrides:

loadConfig in class DraggableContainer

Parameters:

inter - current interface

config - configuration to use