com.lukflug.panelstudio.widget

Class ToggleButton

java.lang.Object

com.lukflug.panelstudio.component.ComponentBase

com.lukflug.panelstudio.component.FocusableComponent

com.lukflug.panelstudio.widget.ToggleButton

All Implemented Interfaces:

IComponent

public class ToggleButton
extends FocusableComponent

Button with two values that can be toggled by the left mouse button.

Field Summary

Fields

Modifier and Type	Field and Description
protected IButtonRenderer<java.lang.Boolean>	renderer Renderer for this component.
protected IToggleable	toggle Setting to be toggled by left click.

Fields inherited from class com.lukflug.panelstudio.component.ComponentBase

label

Constructor Summary

Constructors

Constructor and Description
ToggleButton(IBooleanSetting setting, IButtonRenderer<java.lang.Boolean> renderer) Constructor using boolean setting.
ToggleButton(ILabeled label, IToggleable toggle, IButtonRenderer<java.lang.Boolean> renderer) Constructor.

Method Summary

Modifier and Type	Method and Description
protected int	getHeight() Return height of component.
void	handleButton(Context context, int button) Should be called by the parent when a mouse button state changes.
void	render(Context context) Redraw component on screen.

Methods inherited from class com.lukflug.panelstudio.component.FocusableComponent

exit, handleFocus, hasFocus, releaseFocus, updateFocus

Methods inherited from class com.lukflug.panelstudio.component.ComponentBase

enter, getHeight, getTitle, handleChar, handleKey, handleScroll, isVisible

Methods inherited from class java.lang.Object

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

Field Detail

toggle

protected IToggleable toggle

Setting to be toggled by left click.

renderer

protected IButtonRenderer<java.lang.Boolean> renderer

Renderer for this component.

Constructor Detail

ToggleButton

public ToggleButton(ILabeled label,
                    IToggleable toggle,
                    IButtonRenderer<java.lang.Boolean> renderer)

Constructor.

Parameters:

label - the label for the component

toggle - the toggle

renderer - the renderer for this component

ToggleButton

public ToggleButton(IBooleanSetting setting,
                    IButtonRenderer<java.lang.Boolean> renderer)

Constructor using boolean setting.

Parameters:

setting - the setting in question

renderer - the renderer for this component

Method Detail

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

Overrides:

render in class ComponentBase

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

Overrides:

handleButton in class FocusableComponent

Parameters:

context - the Context for the component

button - the button that changed its state

See Also:

IInterface.LBUTTON, IInterface.RBUTTON

getHeight

protected int getHeight()

Description copied from class: ComponentBase

Return height of component.

Specified by:

getHeight in class ComponentBase

Returns:

the height of the component