Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD

## jcontrol.ui.wombat
Class RadioButton

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

All Implemented Interfaces:
  EventListener, ActionProducer, KeyListener, TouchListener, IFocusable

    public class RadioButton

extends AbstractFocusComponent

A radio button is a graphical component that can be in either an "on" (true) or "off" (false) state. When a radio button's state is changed to "on", all other radio buttons in the same container are set to "off". When the user changes the state, an `ActionEvent` of type `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
`RadioButton(String label, int x, int y)` Create a new labeled `RadioButton` which is initially "off".
`RadioButton(String label, int x, int y, int width, int height)` Create a new labeled `RadioButton` with specified bounds which is initially "off".

Method Summary
`boolean` | `isSelected()` Get the current state of this `RadioButton`.
`KeyEvent` | `onKeyEvent(KeyEvent e)` This method is called when a keyboard action has been performed.
`int` | `onTouchEvent(TouchEvent e)` Every time a touch event is fired, this method will be called.
`void` | `paint(XGraphics g)` Paint the radio button.
`void` | `setSelected(boolean onoff)` Set the state of this `RadioButton`.
`void` | `setText(String label)` Change the label of this radio button.

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

### RadioButton

    public RadioButton(String label,
                       int x,
                       int y)

  Create a new labeled `RadioButton` 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 `RadioButton`.
    `x` - The x-coordinate of this `RadioButton`.
    `y` - The y-coordinate of this `RadioButton`.

### RadioButton

    public RadioButton(String label,
                       int x,
                       int y,
                       int width,
                       int height)

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

  Parameters:
    `label` - A `String` that is written on the `RadioButton`.
    `x` - The x-coordinate of this `RadioButton`.
    `y` - The y-coordinate of this `RadioButton`.
    `width` - The width of this `RadioButton`.
    `height` - The height of this `RadioButton`.

Method Detail

### setSelected

    public void setSelected(boolean onoff)

  Set the state of this `RadioButton`.

  Parameters:
    `onoff` - The new state of the RadioButton.

### isSelected

    public boolean isSelected()

  Get the current state of this `RadioButton`.

  Returns:
    The current state of the RadioButton.

### setText

    public void setText(String label)

  Change the label of this radio button.

  Parameters:
    `label` - The new label.

### paint

    public void paint(XGraphics g)

  Paint the radio button. Don't call this method directly.

  Overrides:
    `paint` in class `Component`
  Parameters:
    `g` - the application's graphics object.

### onKeyEvent

    public KeyEvent onKeyEvent(KeyEvent e)

  Description copied from class: `AbstractFocusComponent`
  This method is called when a keyboard action has been performed.

  Specified by:
    `onKeyEvent` in interface `KeyListener`
  Specified by:
    `onKeyEvent` in class `AbstractFocusComponent`
  Parameters:
    `e` - the event that contains information about the key.
  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.

Overview | Package | Class | Tree | Deprecated | Index | Help
PREV CLASS NEXT CLASS | FRAMES NO FRAMES
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD