jcontrol.ui.wombat
Class Button

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

All Implemented Interfaces:

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

public class Button
extends AbstractFocusComponent

Instances of this class represent a keyboard/touchpad selectable user interface object that issues notification when pressed and released.

(c) Copyright 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

Button(java.lang.String text, int x, int y)
Constructs a new button.

Button(java.lang.String text, int x, int y, int width, int height)
Constructs a new button with fixed size.

Method Summary

KeyEvent	onKeyEvent(KeyEvent e) If a KeyEvent accurs, this method is called.
int	onTouchEvent(TouchEvent e) If a TouchEvent accurs, this method is called.
void	paint(jcontrol.graphics.XGraphics g) Paint the button.
void	press(boolean onoff) This method can be used to change the pressed state of the button from outside.
void	setImage(jcontrol.io.Resource image) Change the button's image.
void	setText(java.lang.String label) Change the button's text.

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

Button

public Button(java.lang.String text,
              int x,
              int y)

Constructs a new button. The size will be calculated as big as is fits the given text.

Parameters:

text - the text to display on the button.

x - the x-coordinate of the button's top-left corner

y - the y-coordinate of the button's top-left corner

Button

public Button(java.lang.String text,
              int x,
              int y,
              int width,
              int height)

Constructs a new button with fixed size.

Parameters:

text - the label to display on the button.

x - the x-coordinate of the button's top-left corner

y - the y-coordinate of the button's top-left corner

width - the width of the button

height - the height of the button

Method Detail

onKeyEvent

public KeyEvent onKeyEvent(KeyEvent e)

If a KeyEvent accurs, this method is called.

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)

If a TouchEvent accurs, this method is called.

Specified by:

onTouchEvent in interface TouchListener

Specified by:

onTouchEvent in class AbstractFocusComponent

Parameters:

e - the TouchEvent.

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 button. Don't call this method directly.

Overrides:

paint in class Component

Parameters:

g - the global graphics object

press

public void press(boolean onoff)

This method can be used to change the pressed state of the button from outside. No ActionEvent is fired when this method is called.

Parameters:

onoff - press or release.

setImage

public void setImage(jcontrol.io.Resource image)

Change the button's image. The size will be re-calculated if it has not been specified with the setBounds()-method or in the constructor.

Parameters:

image - the new image to set.

setText

public void setText(java.lang.String label)

Change the button's text. The size will be re-calculated if it has not been specified with the setBounds()-method or in the constructor.

Parameters:

text - the new text to set.