You are here: Creating a RadioButtonGroup Using a Constructor: kony.ui.RadioButtonGroup

RadioButtonGroup Widget

A RadioButtonGroup widget allows you to make one selection when you have many choices. When you make a selection, a dot appears in the radio button to indicate your selection.

All the properties of the CheckBoxGroup widget apply to RadioButtonGroup widget. However, you can make only one option in case of radio buttons while you can select multiple options in checkboxes.

Following are the real-time use cases of RadioButtonGroup widget:

Widgets are normally added to your application using Quantum Visualizer, but can also be added from code. For general information on using widgets in Quantum Visualizer, see Designing an Application in the Visualizer User Guide.

For general information on the RadioButtonGroup widget see the RadioButtonGroup topic in the Quantum Visualizer User Guide.

The RadioButtonGroup widget capabilities can be broadly categorized into the following:

Layout

Events Description
doLayout Invoked for every widget when the widget position and dimensions are computed.
 
PropertiesDescription
anchorPoint Specifies the anchor point of the widget bounds rectangle using the widget's coordinate space.
bottom Determines the bottom edge of the widget and is measured from the bottom bounds of the parent container.
centerX Determines the center of a widget measured from the left bounds of the parent container.
centerY Determines the center of a widget measured from the top bounds of the parent container.
height Determines the height of the widget and measured along the y-axis.
left Determines the lower left corner edge of the widget and is measured from the left bounds of the parent container.
maxHeight Specifies the maximum height of the widget and is applicable only when the height property is not specified.
maxWidth Specifies the maximum width of the widget and is applicable only when the width property is not specified.
minHeight Specifies the minimum height of the widget and is applicable only when the height property is not specified.
minWidth Specifies the minimum width of the widget and is applicable only when the width property is not specified.
padding Defines the space between the content of the widget and the widget boundaries.
paddingInPixelIndicates if the padding is to be applied in pixels or in percentage.
rightDetermines the lower right corner of the widget and is measured from the right bounds of the parent container.
top Determines the top edge of the widget and measured from the top bounds of the parent container.
zIndex Specifies the stack order of a widget.
  

Animations

MethodsDescription
animate Applies an animation to the widget.
 
PropertiesDescription
transformContains an animation transformation that can be used to animate the widget.
widgetSwipeMoveUsed to enable and configure the left or right swipe actions for a widget.
 

Data Management

MethodsDescription

clone

When this method is used on a container widget, then all the widgets inside the container are cloned.
 
PropertiesDescription
masterData Specifies the set of values that must be displayed for the user to make a selection from the available choices.
masterDataMap Specifies the set of values from which you can make a selection.
 

3D Touch

MethodsDescription
registerForPeekandPop Registers a widget to enable 3D Touch peek and pop gestures.
setOnPeek Sets and overrides the existing onPeekCallback for the widget.
setOnPop Overrides the existing onPopCallback for the widget.
unregisterForPeekandPop Unregisters a widget from 3D Touch peek and pop gestures.
 

User Input Handling

EventsDescription
onSelection Invoked by the platform when an item is selected or deselected.
onScrollWidgetPosition Invoked by the platform when the widget location position gets changed on scrolling.
onTouchEnd Invoked by the platform when the user touch is released from the touch surface.
onTouchMove Invoked by the platform when the touch moves on the touch surface continuously until movement ends.
onTouchStart Invoked by the platform when the user touches the touch surface.
 
MethodsDescription
removeGestureRecognizer Allows you to remove the specified gesture recognizer for the specified widget.
setGestureRecognizer Allows you to set a gesture recognizer for a specified gesture for a specified widget.

 

UI Appearance

PropertiesDescription
backgroundColor Specifies the background color of the widget in hex format.
focusTickedImage Specifies the image to be displayed when you make a selection on non-touch devices.
focusUnTickedImage Specifies the image to be displayed when you clear a selection on non-touch devices.
hoverSkin Specifies the look and feel of a widget when the cursor hovers on the widget.
shadowDepth Defines the depth of the shadow effect applied to the RadioButtonGroup Widget.
shadowType Sets a type of the shadow effect to apply to the RadioButtonGroup Widget.
selectedKey Represents the key that is shown as selected.
tickedImage Specifies the image to be displayed when you make a selection.
unTickedImage Specifies the image to be displayed when a selection is cleared.
viewConfig Specifies the view configuration for different viewtypes.
viewType Specifies the view type of the RadioButtonGroup widget.
wheelBackgroundColor Specifies the background color for the wheel that is displayed when you click the RadioButton group.

 

Enabling RTL

PropertiesDescription
retainContentAlignmentHelps to retain the content alignment of the widget while applying RTL.
retainFlexPositionPropertiesHelps to retain the left, right and padding properties while applying RTL.
retainFlowHorizontalAlignmentEnables you to change the horizontal flow of the widget from left to right.

Miscellaneous

PropertiesDescription
cursorTypeSpecifies the type of the mouse pointer used.
enableHapticFeedback Allows you to enable or disable haptic feedback on the RadioButton widget.
inputAccessoryViewType Helps in defining the the Previous, Next, and Done buttons to the applicable input controls.
dropDownImage Specifies the image to be used for the drop-down box indicator (inverted triangle by default).
groupCells Specifies if all the rows in the RadioButton widget should be grouped using a rounded corner background and border.
placeholder Specifies the temporary or substitute text (a hint provided as a word or phrase) that must be displayed on the RadioButton until the actual selection is made.
toolTip Specifies the hint text when the cursor hovers over a widget, without clicking it.
selectedKeyValue Returns the array of selected key-value pair.

 

MethodsDescription
getBadge Enables you to read the badge value (if any) attached to the specified widget.
setBadge Enables you to set the badge value to the given widget at the upper, right corner of the widget.

Configurations Common To All Widgets

MethodsDescription
convertPointFromWidget Allows you to convert the coordinate system from a widget to a point (receiver's coordinate system).
convertPointToWidget Allows you to convert the coordinate system from a point (receiver's coordinate system) to a widget.
removeFromParent Allows you to remove a child widget from a parent widget.
setEnabled Specifies the widget that must be enabled or disabled.
setFocus Specifies the widget on which there must be focus.
setVisibility Use this method to set the visibility of the widget.

 

Properties Description
accessibilityConfig Enables you to control accessibility behavior and alternative text for the widget.
enableAllows you to make a widget visible but not actionable.
enableCache Enables you to improve the performance of Positional Dimension Animations.
info A custom JSObject with the key value pairs that a developer can use to store the context with the widget.
isVisible Controls the visibility of a widget on the form.

 

EventsDescription
postOnclickJS Allows the developer to execute custom javascript function after the onSelection callback of the RadioButton is invoked.
preOnclickJS Allows the developer to execute custom javascript function before the onSelection callback of the RadioButton is invoked.

 

RadioButtonGroup Widget Basics

RadioButtonGroup is a widget that allows you to define a set of radio buttons and the user can choose one of it as an option.

A radio button usually contains a small circle with text next to it. When you make a selection, a dot appears in the circle to indicate your selection.

If you select one button in the set, the previously selected button is deselected. Only one of the options is selected at a time.

You can use a RadioButtonGroup widget to choose one option from a set of mutually exclusive choices.

The data model for RadioButtonGroup widget is a key value pair. The key is hidden part of the model while value is displayed to the user.

Note: To provide a multiple selection option, use the CheckBoxGroup Widget.

Creating a RadioButtonGroup Using a Constructor: kony.ui.RadioButtonGroup

Creating RadioButtonGroup object instance:

var radiobutton1 = new kony.ui.RadioButtonGroup (basicConf, layoutConf, pspConf);

Note: The configuration properties should be passed only in the respective configuration objects otherwise they are ignored.

Example

//Defining properties for RadioButtonGroup
var radioBasic = {
    id: "RadioButton",
    isVisible: true,
    masterData: [
        ["key1", "value1"],
        ["key2", "value2"],
        ["key3", "value3"]
    ],
    skin: "radSkin",
    focusSkin: "radFSkin"
};

var radioLayout = {
    widgetAlignment: constants.WIDGET_ALIGN_TOP_LEFT,
    padding: [0, 0, 0, 0],
    margin: [0, 0, 0, 0],
    containerWeight: 40,
    hExpand: false
};

var radioPSP = {
    tickedImage: "tickdImg.png",
    untickedImage: "unTickdImg.png",
    focusTickedImage: "tickdFImg.png",
    viewType: constants.RADIOGROUP_VIEW_TYPE_TABLEVIEW
};
//Creating the RadioButtonGroup
radioBtn = new kony.ui.RadioButtonGroup(radioBasic, radioLayout, radioPSP);

//Reading the id of the RadioButtonGroup		
alert("RadioButtonGroup Id ::" + radioBtn.id);

Customizing Appearance

You can customize the appearance of the RadioButtonGroup widget using the following properties:

Important Considerations

The following are the important considerations for the RadioButtonGroup widget.

All Platforms

iOS

Android

Windows

SPA

Copyright © 2020 Temenos. All rights reserved.