com.lukflug.panelstudio.component

Class ComponentBase

java.lang.Object

com.lukflug.panelstudio.component.ComponentBase

All Implemented Interfaces:

IComponent

Direct Known Subclasses:

Container, EmptySpace, FocusableComponent, TabItem

public abstract class ComponentBase
extends java.lang.Object
implements IComponent

Base class for components.

Field Summary

Fields

Modifier and Type	Field and Description
protected ILabeled	label The label of the component.

Constructor Summary

Constructors

Constructor and Description
ComponentBase(ILabeled label) Constructor.

Method Summary

Modifier and Type	Method and Description
void	enter() Should be called by the parent when the component is shown.
void	exit() Should be called by the parent when the component is hidden.
protected abstract int	getHeight() Return height of component.
void	getHeight(Context context) Get the current height via Context.setHeight(int).
java.lang.String	getTitle() Get the caption of the component.
void	handleButton(Context context, int button) Should be called by the parent when a mouse button state changes.
void	handleChar(Context context, char character) Should be called by the parent when a key is typed.
void	handleKey(Context context, int scancode) Should be called by the parent when a key is typed.
void	handleScroll(Context context, int diff) Should be called by the parent when the mouse wheel is scrolled.
boolean	isVisible() Check if component should be visible.
void	render(Context context) Redraw component on screen.

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

releaseFocus

Field Detail

label

protected final ILabeled label

The label of the component.

Constructor Detail

ComponentBase

public ComponentBase(ILabeled label)

Constructor.

Parameters:

label - the label for the component

Method Detail

getTitle

public java.lang.String getTitle()

Description copied from interface: IComponent

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

Specified by:

getTitle in interface IComponent

Returns:

the caption of the component

render

public void render(Context context)

Description copied from interface: IComponent

Redraw component on screen. The current height of the component should be set by this method via Context.setHeight(int).

Specified by:

render in interface IComponent

Parameters:

context - the Context for the component

handleButton

public void handleButton(Context context,
                         int button)

Description copied from interface: IComponent

Should be called by the parent when a mouse button state changes. The current height of the component should be set by this method via Context.setHeight(int).

Specified by:

handleButton in interface IComponent

Parameters:

context - the Context for the component

button - the button that changed its state

See Also:

IInterface.LBUTTON, IInterface.RBUTTON

handleKey

public void handleKey(Context context,
                      int scancode)

Description copied from interface: IComponent

Should be called by the parent when a key is typed. The current height of the component should be set by this method via Context.setHeight(int).

Specified by:

handleKey in interface IComponent

Parameters:

context - the Context for the component

scancode - the scancode for the key that was typed

handleChar

public void handleChar(Context context,
                       char character)

Description copied from interface: IComponent

Should be called by the parent when a key is typed. The current height of the component should be set by this method via Context.setHeight(int).

Specified by:

handleChar in interface IComponent

Parameters:

context - the Context for the component

character - the character that was typed

handleScroll

public void handleScroll(Context context,
                         int diff)

Description copied from interface: IComponent

Should be called by the parent when the mouse wheel is scrolled. The current height of the component should be set by this method via Context.setHeight(int).

Specified by:

handleScroll in interface IComponent

Parameters:

context - the Context for the component

diff - the amount by which the wheel was moved

getHeight

public void getHeight(Context context)

Description copied from interface: IComponent

Get the current height via Context.setHeight(int).

Specified by:

getHeight in interface IComponent

Parameters:

context - the Context for the component

enter

public void enter()

Description copied from interface: IComponent

Should be called by the parent when the component is shown.

Specified by:

enter in interface IComponent

exit

public void exit()

Description copied from interface: IComponent

Should be called by the parent when the component is hidden.

Specified by:

exit in interface IComponent

isVisible

public boolean isVisible()

Description copied from interface: IComponent

Check if component should be visible.

Specified by:

isVisible in interface IComponent

Returns:

whether the component is visible

getHeight

protected abstract int getHeight()

Return height of component.

Returns:

the height of the component