jcontrol.ui.wombat
Class CheckBox

java.lang.Object
  jcontrol.ui.wombat.Component
      jcontrol.ui.wombat.AbstractFocusComponent
          jcontrol.ui.wombat.CheckBox

All Implemented Interfaces:

java.util.EventListener, ActionProducer, KeyListener, TouchListener, IFocusable

public class CheckBox
extends AbstractFocusComponent

The CheckBox is a graphical component that can be in either an "on" (true) or "off" (false) state. When the user changes the state, an ActionEvent of type STATE_CHANGED is fired.

(c) Copyright 2003-2005 DOMOLOGIC GmbH

Author:

Marcus Timmermann

Field Summary

Fields inherited from class jcontrol.ui.wombat.Component

backgroundColor, COLOR_COMPONENT_BACKGROUND, COLOR_COMPONENT_BACKGROUND_HIGHLIGHTED, COLOR_COMPONENT_DARK_SHADOW, COLOR_COMPONENT_FOREGROUND, COLOR_COMPONENT_FOREGROUND_INACTIVE, COLOR_COMPONENT_HIGHLIGHT_SHADOW, COLOR_COMPONENT_LIGHT_SHADOW, COLOR_COMPONENT_LIST_BACKGROUND, COLOR_COMPONENT_NORMAL_SHADOW, COLOR_COMPONENT_SELECTION_TEXT, COLOR_COMPONENT_SELECTION_TEXT_BACKGROUND, COLOR_COMPONENT_SELECTION_TEXT_BACKGROUND_INACTIVE, COLOR_COMPONENT_SELECTION_TEXT_INACTIVE, foregroundColor, frame, height, parent, state, transparentColor, width, x, y

Fields inherited from interface jcontrol.ui.wombat.IFocusable

TRANSFER_FOCUS_BACKWARD, TRANSFER_FOCUS_FORWARD

Fields inherited from interface jcontrol.ui.wombat.event.TouchListener

RESULT_ACCEPTED, RESULT_EXECUTED, RESULT_NONE

Constructor Summary

CheckBox(java.lang.String label, int x, int y)
Create a new labeled CheckBox which is initially "off".

CheckBox(java.lang.String label, int x, int y, int width, int height)
Create a new labeled CheckBox with specified bounds which is initially "off".

Method Summary

boolean	isSelected() Get the current state of this CheckBox.
KeyEvent	onKeyEvent(KeyEvent e) Handle key events.
int	onTouchEvent(TouchEvent e) Every time a touch event is fired, this method will be called.
void	paint(jcontrol.graphics.XGraphics g) Paint the checkbox.
void	setSelected(boolean onoff) Set the state of this CheckBox.
void	setText(java.lang.String text) Change the label if this check box.

Methods inherited from class jcontrol.ui.wombat.AbstractFocusComponent

getActionListener, requestFocus, setActionListener, setEnabled, setVisible

Methods inherited from class jcontrol.ui.wombat.Component

getFrame, isEnabled, isVisible, repaint, repaintAll, safeExec, setBackgroundColor, setBounds, setDirty, setFont, setForegroundColor, setRedraw, setTransparentColor, unsafeExec, update

Methods inherited from class java.lang.Object

equals, getClass, notifyAll, toString, wait

Constructor Detail

CheckBox

public CheckBox(java.lang.String label,
                int x,
                int y)

Create a new labeled CheckBox which is initially "off". When no width and height are specified, a preferred size depending on the label dimensions is calculated.

Parameters:

label - A String that is written on the CheckBox.

x - The x-coordinate of this CheckBox.

y - The y-coordinate of this CheckBox.

CheckBox

public CheckBox(java.lang.String label,
                int x,
                int y,
                int width,
                int height)

Create a new labeled CheckBox with specified bounds which is initially "off".

Parameters:

label - A String that is written on the CheckBox.

x - The x-coordinate of this CheckBox.

y - The y-coordinate of this CheckBox.

width - The width of this CheckBox.

height - The height of this CheckBox.

Method Detail

isSelected

public boolean isSelected()

Get the current state of this CheckBox.

Returns:

The current state of the check box.

onKeyEvent

public KeyEvent onKeyEvent(KeyEvent e)

Handle key events.

Specified by:

onKeyEvent in interface KeyListener

Specified by:

onKeyEvent in class AbstractFocusComponent

Parameters:

e - The KeyEvent.

Returns:

null if the KeyEvent has been consumed by the KeyListener,
or the the specified KeyEvent if it should be passed on to the next KeyListener.

onTouchEvent

public int onTouchEvent(TouchEvent e)

Description copied from interface: TouchListener

Every time a touch event is fired, this method will be called.

Specified by:

onTouchEvent in interface TouchListener

Specified by:

onTouchEvent in class AbstractFocusComponent

Parameters:

e - The touch event.

Returns:

RESULT_ACCEPTED if the TouchEvent has been consumed by the TouchListener,
RESULT_EXECUTED if the TouchEvent has been consumed by the TouchListener and some important action has been performed, e.g. an action event has been invoked,
RESULT_NONE if the TouchEvent should be passed on to the next TouchListener.

paint

public void paint(jcontrol.graphics.XGraphics g)

Paint the checkbox. Don't call this method directly.

Overrides:

paint in class Component

Parameters:

g - the application's graphics object.

setSelected

public void setSelected(boolean onoff)

Set the state of this CheckBox. On calling this method, no ActionEvent is fired.

Parameters:

onoff - The new state of the check box.

setText

public void setText(java.lang.String text)

Change the label if this check box.

Parameters:

text - The new label.