Class: RadioGroup
- Last UpdatedJun 30, 2025
- 5 minute read
This class represents a group of push buttons of which only one can be active at a time.
Name | Type | Description |
---|---|---|
opt_options |
H.ui.base.RadioGroup.Options |
optional
An optional configuration options |
Extends
Methods
-
addButton (button)H.ui.base.RadioGroup
-
This method adds a button element to the given group.
Name Type Description button
H.ui.base.PushButton The button to add
Returns:
Type Description H.ui.base.RadioGroup An object representing the given group -
addChild (child)H.ui.base.Container inherited
-
This method adds a child element to be rendered within the given container element.
Name Type Description child
H.ui.base.Element The child element to be added
Returns:
Type Description H.ui.base.Container This container instance -
addClass (className)H.ui.base.Element inherited
-
This method adds a CSS class to the given UI element (if it is not already present).
Name Type Description className
string The name of the CSS class to add
Returns:
Type Description H.ui.base.Element The given UI element instance -
addEventListener (type, handler, opt_capture, opt_scope) inherited
-
This method sets a listener for a specific event triggered by the given element.
-
addOnDisposeCallback (callback, opt_scope) inherited
-
This method adds a callback which is triggered when the
EventTarget
object is being disposed.Name Type Description callback
function The callback function.
opt_scope
Object optional An optional scope for the callback function
-
dispatchEvent (evt) inherited
-
This method dispatches an event on the
EventTarget
object.Name Type Description evt
H.util.Event | string An object representing the event or a string with the event name
-
dispose () inherited
-
This method removes listeners from the given object. Classes that extend
EventTarget
may need to override this method in order to remove references to DOM Elements and additional listeners. -
getButtons ()Array.<!H.ui.base.PushButton>
-
This method retrieves the buttons currently registered with the given group.
Returns:
Type Description Array.<!H.ui.base.PushButton> An array of buttons associated with the given group -
getChildren ()Array.<!H.ui.base.Element> inherited
-
This method retrieves the child element collection of the given container.
Returns:
Type Description Array.<!H.ui.base.Element> The child elements of the given container -
getData ()* inherited
-
This method retrieves previously stored arbitrary data from the given element.
Returns:
Type Description * The previously stored data object or null
if no data was stored. -
getElement ()HTMLElement inherited
-
This method retrieves the HTML element that represents the given UI element.
Note: If the UI element has not been rendered, the method retrieves
null
.Returns:
Type Description HTMLElement An object representing the given element instance or null
-
This method retrieves the current title string of the given group.
Returns:
Type Description string The title of the group -
getVisibility ()boolean inherited
-
This method retrieves a value indicating if the given element is visibile.
Returns:
Type Description boolean true
if the given element is visible, otherwisefalse
-
isDisabled ()boolean inherited
-
This method retrieves a value indicating if the given UI element is disabled.
Returns:
Type Description boolean true
if the element is disabled,false
otherwise -
removeButton (button)H.ui.base.RadioGroup
-
This method removes a button element from the given group.
Name Type Description button
H.ui.base.PushButton The button to remove
Returns:
Type Description H.ui.base.RadioGroup An object representing the given group -
removeChild (child) inherited
-
This method removes a child element from the given container's child element collection.
Name Type Description child
H.ui.base.Element The child element to be removed
-
removeClass (className)H.ui.base.Element inherited
-
This method removes a CSS class from the given UI element (if it is present).
Name Type Description className
string The CSS class name to add
Returns:
Type Description H.ui.base.Element The given UI element instance -
removeEventListener (type, handler, opt_capture, opt_scope) inherited
-
This method removes a previously added listener from the event target.
-
This method is the concrete implementation of the UI element. It receives the pre-rendered HTML element which may be modified by deriving classes.
Name Type Description element
Element The HTML representation of the given UI element
doc
Document The HTML document into which the give UI element is rendered
-
This method sets the active button of the given radio group.
Name Type Description button
H.ui.base.PushButton The button to be the active button in the radio group
opt_suppressEvent
boolean optional An optional Boolean flag indicating if no state change event is to be fired
true
-
setData (data) inherited
-
This method stores arbitrary data with the given UI element.
Name Type Description data
* The data to be stored
-
setDisabled (opt_disabled, opt_force)H.ui.base.Element inherited
-
This method sets a value indicating if the given UI element is disabled.
Name Type Description opt_disabled
boolean optional true
to disable the element,false
to enable it. Default isfalse
opt_force
boolean optional An optional Boolean flag indicating that the value should be set and propagated even if it is the same as the current state
Returns:
Type Description H.ui.base.Element An object representing the given element instance -
setTabIndex (tabIndex) inherited
-
This method sets the tabIndex of the element. See https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes/tabindex for more details.
Name Type Description tabIndex
number -
setTitle (title, opt_force)H.ui.base.RadioGroup
-
This method sets the title of the given group.
Name Type Description title
string The new title of this group
opt_force
boolean optional An optional flag indicating that the new value is to be updated and propagated even if it has the same value as the current title
Returns:
Type Description H.ui.base.RadioGroup An object representing the given group -
setVisibility (visibility) inherited
-
This method sets a value indicating if the given element is visible.
Name Type Description visibility
boolean true
if the given element is visible, otherwisefalse
Type Definitions
-
This typedef defines configuration options for a button group.
Properties:
Name Type Argument Description title
string <optional>
An optional title string for the given group
buttons
Array.<H.ui.base.Button.Options> <optional>
An optional set of button options to be added to the group
Events
-
This event is fired when a radio button becomes active.
Type:
-
This event is fired when a
RadioGroup
's state changes.Type: