Radio (TotalCrossSDK 6.1.0 API)

java.lang.Object
- totalcross.ui.gfx.GfxSurface
- - totalcross.ui.Control
  - - totalcross.ui.Radio

All Implemented Interfaces:: MaterialEffect.SideEffect, TextControl

public class Radio
extends Control
implements TextControl, MaterialEffect.SideEffect

Radio is a radio control. Radios can be grouped together using a RadioGroupController.

Here is an example showing a radio being used:

 public class MyProgram extends MainWindow
 {
    RadioGroupController rgGender;

    public void initUI()
    {
       rgGender = new RadioGroupController();
       add(new Radio("Male", rgGender), LEFT, AFTER);
       add(new Radio("Female", rgGender), AFTER+2, SAME);
       rgGender.setSelectedIndex(radioMale); // activate the specified one.
    }

    public void onEvent(Event event)
    {
       if (event.type == ControlEvent.PRESSED && (event.target instanceof Radio) && ((Radio)event.target).getRadioGroup() == rgGender)
       {
          boolean male = rgGender.getSelectedIndex() == 0;
          ... handle radio Male being pressed

See Also:: RadioGroupController

Nested Class Summary
- Nested classes/interfaces inherited from class totalcross.ui.Control
  Control.TranslucentShape

Field Summary

Fields
Modifier and Type	Field and Description
`boolean`	`autoSplit`
`int`	`checkColor` Set to the color of the check, if you want to make it different of the foreground color.
`boolean`	`leftJustify` Set to true to left justify this control if the width is above the preferred one.
`int`	`textColor` Sets the text color of the check.

Fields inherited from class totalcross.ui.Control
AFTER, alphaValue, appId, appObj, asContainer, asWindow, backColor, BEFORE, BOTTOM, BOTTOM_OF, BRIGHTER_BACKGROUND, callListenersOnAllTargets, CENTER, CENTER_OF, clearValueInt, clearValueStr, DARKER_BACKGROUND, DP, effect, enableUpdateScreen, esce, eventsEnabled, FILL, fillColor, FIT, floating, fm, fmH, focusHandler, focusLess, focusOnPenDown, focusTraversable, font, FONTSIZE, foreColor, height, ignoreInsets, isHighlighting, isTablet, KEEP, keepDisabled, keepEnabled, LEFT, next, nextTabControl, npParts, offscreen, offscreen0, onEventFirst, parent, PARENTSIZE, PARENTSIZEMAX, PARENTSIZEMIN, PREFERRED, prev, RANGE, repositionAllowed, RIGHT, RIGHT_OF, SAME, SCREENSIZE, SCREENSIZEMAX, SCREENSIZEMIN, setFont, setH, setRel, setW, setX, SETX_NOT_SET, setY, tempW, textShadowColor, TOP, translucentShape, transparentBackground, uiAdjustmentsBasedOnFontHeightIsSupported, uiAndroid, UICONST, uiFlat, uiHolo, uiMaterial, uiVista, visible, width, WILL_RESIZE, x, y

Constructor Summary

Constructors
Constructor and Description
`Radio(java.lang.String text)` Creates a radio control displaying the given text.
`Radio(java.lang.String text, RadioGroupController radioGroup)` Creates a radio control with the given text attached to the given RadioGroupController

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`clear()` Clears this control, checking it if clearValueInt is 1.
`int`	`getPreferredHeight()` returns the preferred height of this control.
`int`	`getPreferredWidth()` returns the preferred width of this control.
`RadioGroupController`	`getRadioGroup()` Returns the RadioGroupController that this radio belongs to, or null if none.
`int`	`getRadioTextGap()` The gap between the radio and the text.
`java.lang.String`	`getText()` Gets the text displayed in the radio.
`boolean`	`isChecked()` Returns the checked state of the control.
`protected void`	`onBoundsChanged(boolean screenChanged)` Called after a setRect.
`protected void`	`onColorsChanged(boolean colorsChanged)` Called after a setEnabled, setForeColor and setBackColor and when a control has been added to a Container.
`void`	`onEvent(Event event)` Called by the system to pass events to the radio control.
`protected void`	`onFontChanged()` Called after a setFont
`void`	`onPaint(Graphics g)` Called by the system to draw the radio control.
`void`	`setChecked(boolean checked)` Sets the checked state of the control.
`void`	`setChecked(boolean checked, boolean sendPress)` Sets the checked state of the control, and send the press event if desired.
`void`	`setRadioTextGap(int gap)` The gap between the radio and the text when the leftJustify is set to true.
`void`	`setText(java.lang.String text)` Sets the text.
`void`	`sidePaint(Graphics g, int alpha)`
`void`	`sideStart()`
`void`	`sideStop()`
`void`	`split(int maxWidth)` Splits the text to the given width.

Methods inherited from class totalcross.ui.Control
_onEvent, addEnabledStateListener, addFocusListener, addFontChangeHandler, addGridListener, addHandler, addHighlightListener, addKeyListener, addListContainerListener, addMouseListener, addMultiTouchListener, addPenListener, addPressListener, addPushNotificationListener, addSizeChangeHandler, addTimer, addTimer, addTimerListener, addValueChangeHandler, addWindowListener, bringToFront, changeHighlighted, contains, drawTranslucentBackground, getAbsoluteRect, getBackColor, getDoEffect, getEffectH, getEffectW, getEffectX, getEffectY, getEventListeners, getFont, getForeColor, getGap, getGraphics, getHeight, getNext, getParent, getParentWindow, getPos, getPressedEvent, getPrev, getRect, getSize, getTextShadowColor, getWidth, getX, getX2, getY, getY2, hadParentScrolled, handleGeographicalFocusChangeKeys, hasFocus, internalSetEnabled, intXYWH, isActionEvent, isChildOf, isDisplayed, isEnabled, isFloating, isInsideOrNear, isObscured, isTopMost, isVisible, isVisibleAndInside, onWindowPaintFinished, post, postEvent, postPressedEvent, releaseScreenShot, removeEnabledStateListener, removeFocusListener, removeGridListener, removeHandler, removeHighlightListener, removeKeyListener, removeListContainerListener, removeMouseListener, removeMultiTouchListener, removePenListener, removePressListener, removePushNotificationListener, removeTimer, removeTimerListener, removeWindowListener, repaint, repaintNow, reposition, reposition, repositionChildren, requestFocus, resetSetPositions, resetStyle, safeRepaintNow, safeUpdateScreen, sendToBack, setBackColor, setBackForeColors, setDoEffect, setEnabled, setFloating, setFocusLess, setFont, setForeColor, setNinePatch, setNinePatch, setRect, setRect, setRect, setRect, setSet, setTextShadowColor, setTranslucent, setVisible, showTip, takeInitialScreenShot, takeScreenShot, translateFromOrigin, uiStyleChanged, updateScreen, updateTemporary, willOpenKeyboard

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - autoSplit
```
public boolean autoSplit
```
  - textColor
```
public int textColor
```
    Sets the text color of the check. Defaults to the foreground color.
    
    Since:
    
    TotalCross 2.0.
  - checkColor
```
public int checkColor
```
    Set to the color of the check, if you want to make it different of the foreground color.
    
    Since:
    
    TotalCross 1.3
  - leftJustify
```
public boolean leftJustify
```
    Set to true to left justify this control if the width is above the preferred one.
    Attention: You can change the gap between the radio and the text by changing the variable "radioTextGap" by calling setRadioTextGap(int gap)
- Constructor Detail
  - Radio
```
public Radio(java.lang.String text)
```
    Creates a radio control displaying the given text.
  - Radio
```
public Radio(java.lang.String text,
             RadioGroupController radioGroup)
```
    Creates a radio control with the given text attached to the given RadioGroupController
- Method Detail
  - getRadioGroup
```
public RadioGroupController getRadioGroup()
```
    Returns the RadioGroupController that this radio belongs to, or null if none.
  - setText
```
public void setText(java.lang.String text)
```
    Sets the text.
    
    Specified by:
    
    setText in interface TextControl
  - getText
```
public java.lang.String getText()
```
    Gets the text displayed in the radio.
    
    Specified by:
    
    getText in interface TextControl
  - isChecked
```
public boolean isChecked()
```
    Returns the checked state of the control.
  - setChecked
```
public void setChecked(boolean checked)
```
    Sets the checked state of the control.
  - setChecked
```
public void setChecked(boolean checked,
                       boolean sendPress)
```
    Sets the checked state of the control, and send the press event if desired.
  - getPreferredWidth
```
public int getPreferredWidth()
```
    returns the preferred width of this control.
    
    Overrides:
    
    getPreferredWidth in class Control
  - getPreferredHeight
```
public int getPreferredHeight()
```
    returns the preferred height of this control.
    
    Overrides:
    
    getPreferredHeight in class Control
  - onEvent
```
public void onEvent(Event event)
```
    Called by the system to pass events to the radio control.
    
    Overrides:
    
    onEvent in class Control
    
    Parameters:
    
    event - the event to process
    
    See Also:
    
    Event, KeyEvent, PenEvent
  - onColorsChanged
```
protected void onColorsChanged(boolean colorsChanged)
```
    Description copied from class: Control
    
    Called after a setEnabled, setForeColor and setBackColor and when a control has been added to a Container. If colorsChanged is true, it was called from setForeColor/setBackColor/Container.add; otherwise, it was called from setEnabled
    
    Overrides:
    
    onColorsChanged in class Control
  - onFontChanged
```
protected void onFontChanged()
```
    Description copied from class: Control
    
    Called after a setFont
    
    Overrides:
    
    onFontChanged in class Control
  - onPaint
```
public void onPaint(Graphics g)
```
    Called by the system to draw the radio control.
    
    Overrides:
    
    onPaint in class Control
    
    Parameters:
    
    g - the graphics object for drawing
    
    See Also:
    
    Graphics
  - clear
```
public void clear()
```
    Clears this control, checking it if clearValueInt is 1.
    
    Overrides:
    
    clear in class Control
  - sideStart
```
public void sideStart()
```
    Specified by:
    
    sideStart in interface MaterialEffect.SideEffect
  - sideStop
```
public void sideStop()
```
    Specified by:
    
    sideStop in interface MaterialEffect.SideEffect
  - onBoundsChanged
```
protected void onBoundsChanged(boolean screenChanged)
```
    Description copied from class: Control
    
    Called after a setRect.
    
    Overrides:
    
    onBoundsChanged in class Control
    
    Parameters:
    
    screenChanged - If the bounds were changed due to a screen change (rotation, collapse)
  - split
```
public void split(int maxWidth)
```
    Splits the text to the given width.
    
    Since:
    
    TotalCross 4.2.0
    
    See Also:
    
    autoSplit
  - sidePaint
```
public void sidePaint(Graphics g,
                      int alpha)
```
    Specified by:
    
    sidePaint in interface MaterialEffect.SideEffect
  - setRadioTextGap
```
public void setRadioTextGap(int gap)
```
    The gap between the radio and the text when the leftJustify is set to true.
  - getRadioTextGap
```
public int getRadioTextGap()
```
    The gap between the radio and the text.

Class Radio

Nested Class Summary

Nested classes/interfaces inherited from class totalcross.ui.Control

Field Summary

Fields inherited from class totalcross.ui.Control

Constructor Summary

Method Summary

Methods inherited from class totalcross.ui.Control

Methods inherited from class java.lang.Object

Field Detail

autoSplit

textColor

checkColor

leftJustify

Constructor Detail

Radio

Radio

Method Detail

getRadioGroup

setText

getText

isChecked

setChecked

setChecked

getPreferredWidth

getPreferredHeight

onEvent

onColorsChanged

onFontChanged

onPaint

clear

sideStart

sideStop

onBoundsChanged

split

sidePaint

setRadioTextGap

getRadioTextGap