jcontrol.ui.wombat
Class RockerSwitch

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

All Implemented Interfaces:

EventListener, ActionProducer, KeyListener, TouchListener, IFocusable

public class RockerSwitch
extends AbstractFocusComponent

The RockerSwitch 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 ActionEvent.STATE_CHANGED is fired.

(c) Copyright 2005-2007 DOMOLOGIC GmbH

Field Summary

Fields inherited from class jcontrol.ui.wombat.AbstractFocusComponent

BORDER_WIDTH, listener

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, eventQueue, font, foregroundColor, frame, height, parent, RESERVED1, RESERVED2, RESERVED3, RESERVED4, RESERVED5, RESERVED6, state, STATE_ABORT_UPDATE, STATE_ANIMATED, STATE_BG_COLOR_SET, STATE_COVERED, STATE_DIRTY_MASK, STATE_DIRTY_PAINTALL, STATE_DIRTY_REPAINT, STATE_DIRTY_UPDATE, STATE_DISABLED, STATE_DISPOSED, STATE_FG_COLOR_SET, STATE_FOCUS, STATE_HEIGHT_FIXED, STATE_NO_REDRAW, STATE_REVALIDATE, STATE_SELECTED, STATE_SIZE_FIXED, STATE_UPDATED, STATE_VISIBLE, STATE_WIDTH_FIXED, 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

RockerSwitch(int x, int y)
Create a new RockerSwitch.

Method Summary

boolean	isSelected() Get the current state of this RockerSwitch.
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(XGraphics g) Paint the rocker switch.
void	setSelected(boolean onoff) Set the state of this RockerSwitch.

Methods inherited from class jcontrol.ui.wombat.AbstractFocusComponent

clearCorners, drawBevelRect, drawButton, drawDottedRect, drawFocusRect, getActionListener, onActionEvent, requestFocus, setActionListener, setEnabled, setVisible

Methods inherited from class jcontrol.ui.wombat.Component

drawDisabledImage, getFrame, isEnabled, isVisible, isVisibleInternal, redrawInternalAndParent, repaint, repaintAll, safeExec, setBackgroundColor, setBackgroundColorInternal, setBounds, setDirty, setFont, setForegroundColor, setForegroundColorInternal, setParametersInternal, setRedraw, setTransparentColor, unsafeExec, update

Methods inherited from class java.lang.Object

clone, equals, getClass, notifyAll, toString, wait

Constructor Detail

RockerSwitch

public RockerSwitch(int x,
                    int y)

Create a new RockerSwitch.

Parameters:

x - The x-coordinate of this RockerSwitch.

y - The y-coordinate of this RockerSwitch.

Method Detail

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.

setSelected

public void setSelected(boolean onoff)

Set the state of this RockerSwitch. No ActionEvent will be fired.

Parameters:

onoff - The new state of the RockerSwitch.

isSelected

public boolean isSelected()

Get the current state of this RockerSwitch.

Returns:

The current state of the RockerSwitch.

paint

public void paint(XGraphics g)

Paint the rocker switch. Don't call this method directly.

Overrides:

paint in class Component

Parameters:

g - the application's graphics object.

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.