com.lukflug.panelstudio

Class Container

java.lang.Object

com.lukflug.panelstudio.FocusableComponent

com.lukflug.panelstudio.Container

All Implemented Interfaces:

Component

public class Container
extends FocusableComponent

Base class for components containing other components (i.e. containers).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static interface	Container.LoopFunction Interface used by the loop.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.List<Component>	components List of child component.

Fields inherited from class com.lukflug.panelstudio.FocusableComponent

description, renderer, title

Constructor Summary

Constructors

Constructor and Description
Container(java.lang.String title, java.lang.String description, Renderer renderer) Constructor for a container.

Method Summary

Modifier and Type	Method and Description
void	addComponent(Component component) Add a component to the container.
protected void	doComponentLoop(Context context, Container.LoopFunction function) Loop through all components in reverse order and check for focus requests.
void	enter(Context context) Handle the GUI being closed.
void	exit(Context context) Handle the GUI being closed.
void	getHeight(Context context) Returns the total height of the container, accounting for the height of its child components.
protected Context	getSubContext(Context context, int posy) Create sub-context for child component.
void	handleButton(Context context, int button) Handle a mouse button state change.
protected void	handleFocus(Context context, boolean focus) Releases focus of children when called.
void	handleKey(Context context, int scancode) Handle a key being typed.
void	handleScroll(Context context, int diff) Handle mouse wheel being scrolled.
void	releaseFocus() Reset focus state of self and children.
void	render(Context context) Render the container.

Methods inherited from class com.lukflug.panelstudio.FocusableComponent

getTitle, hasFocus, updateFocus

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

List of child component.

Constructor Detail

Container

public Container(java.lang.String title,
                 java.lang.String description,
                 Renderer renderer)

Constructor for a container.

Parameters:

title - the caption of the container

description - the description for this component

renderer - the renderer used by the container

Method Detail

addComponent

public void addComponent(Component component)

Add a component to the container.

Parameters:

component - the component to be added

render

public void render(Context context)

Render the container. Components are rendered in a column based on the height they specify via Context.setHeight(int). The horizontal border is defined by Renderer.getBorder(). The vertical space between to components is defined by Renderer.getOffset().

Specified by:

render in interface Component

Overrides:

render in class FocusableComponent

Parameters:

context - the Context for the component

handleButton

public void handleButton(Context context,
                         int button)

Handle a mouse button state change.

Specified by:

handleButton in interface Component

Overrides:

handleButton in class FocusableComponent

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)

Handle a key being typed.

Specified by:

handleKey in interface Component

Overrides:

handleKey in class FocusableComponent

Parameters:

context - the Context for the component

scancode - the scancode for the key that was typed

handleScroll

public void handleScroll(Context context,
                         int diff)

Handle mouse wheel being scrolled.

Specified by:

handleScroll in interface Component

Overrides:

handleScroll in class FocusableComponent

Parameters:

context - the Context for the component

diff - the amount by which the wheel was moved

getHeight

public void getHeight(Context context)

Returns the total height of the container, accounting for the height of its child components.

Specified by:

getHeight in interface Component

Overrides:

getHeight in class FocusableComponent

Parameters:

context - the Context for the component

enter

public void enter(Context context)

Handle the GUI being closed.

Specified by:

enter in interface Component

Overrides:

enter in class FocusableComponent

Parameters:

context - the Context for the component

exit

public void exit(Context context)

Handle the GUI being closed.

Specified by:

exit in interface Component

Overrides:

exit in class FocusableComponent

Parameters:

context - the Context for the component

releaseFocus

public void releaseFocus()

Reset focus state of self and children.

Specified by:

releaseFocus in interface Component

Overrides:

releaseFocus in class FocusableComponent

handleFocus

protected void handleFocus(Context context,
                           boolean focus)

Releases focus of children when called.

Overrides:

handleFocus in class FocusableComponent

Parameters:

context - the Context for the component

focus - the new focus state

getSubContext

protected Context getSubContext(Context context,
                                int posy)

Create sub-context for child component.

Parameters:

context - the current context

posy - the vertical position of the child component

Returns:

the context for the child component

doComponentLoop

protected void doComponentLoop(Context context,
                               Container.LoopFunction function)

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

Parameters:

context - for the container

function - the function to execute in the loop