Maps API for JavaScript Developer's Guide

H.ui.base.RadioGroup

Class Summary

Extends: H.ui.base.Container

This class represents a group of push buttons of which only one can be active at a time.

[ For full details, see the Class Details ]

Method Summary

Table 1. Methods
Methods

setTitle (title, opt_force) : {H.ui.base.RadioGroup}

This method sets the title of the given group.

getTitle () : {string}

This method retrieves the current title string of the given group.

addButton (button) : {H.ui.base.RadioGroup}

This method adds a button element to the given group.

removeButton (button) : {H.ui.base.RadioGroup}

This method removes a button element from the given group.

getButtons () : {Array<H.ui.base.PushButton>}

This method retrieves the buttons currently registered with the given group.

setActiveButton (button, opt_suppressEvent)

This method sets the active button of the given radio group.

addChild (child) : {H.ui.base.Container}

This method adds a child element to be rendered within the given container element.

getChildren () : {Array<H.ui.base.Element>}

This method retrieves the child element collection of the given container.

removeChild (child)

This method removes a child element from the given container's child element collection.

addEventListener (type, handler, opt_capture, opt_scope)

This method sets a listener for a specific event triggered by the given element.

removeEventListener (type, handler, opt_capture, opt_scope)

This method removes a previously added listener from the event target.

renderInternal (element, doc)

This method is the concrete implementation of the UI element. It receives the pre-rendered HTML element which may be modified by deriving classes.

isDisabled () : {boolean}

This method retrieves a value indicating if the given UI element is disabled.

setDisabled (disabled, opt_force) : {H.ui.base.Element}

This method sets a value indicating if the given UI element is disabled.

getData () : {*}

This method retrieves previously stored arbitrary data from the given element.

setData (data)

This method stores arbitrary data with the given UI element.

getElement () : {?HTMLElement}

This method retrieves the HTML element the given UI element renders.

setVisibility (visibility)

This method sets a value indicating if the given element is visible.

getVisibility () : {boolean}

This method retrieves a value indicating if the given element is visibile.

addClass (className) : {H.ui.base.Element}

This method adds a CSS class to the given UI element (if it is not already present).

removeClass (className) : {H.ui.base.Element}

This method removes a CSS class from the given UI element (if it is present).

Events Summary

Table 2. Events
Events

activebuttonchange : {H.util.Event}

This event is fired when a radio button becomes active.

statechange : {H.util.Event}

This event is fired when a RadioGroup's state changes.

Class Description

This class represents a group of push buttons of which only one can be active at a time.

Constructor Details

H.ui.base.RadioGroup(opt_options)

Parameters:
 
opt_options:
{H.ui.base.RadioGroup.Options=} [optional]
 
An optional configuration options

Method Details

setTitle (title, opt_force) : {H.ui.base.RadioGroup}

This method sets the title of the given group.

Parameters:
 
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:
 
{H.ui.base.RadioGroup}
An object representing the given group

getTitle () : {string}

This method retrieves the current title string of the given group.

Returns:
 
{string}
The title of the group

addButton (button) : {H.ui.base.RadioGroup}

This method adds a button element to the given group.

Parameters:
 
button:
{H.ui.base.PushButton}
 
The button to add
Returns:
 
{H.ui.base.RadioGroup}
An object representing the given group

removeButton (button) : {H.ui.base.RadioGroup}

This method removes a button element from the given group.

Parameters:
 
button:
{H.ui.base.PushButton}
 
The button to remove
Returns:
 
{H.ui.base.RadioGroup}
An object representing the given group

getButtons () : {Array<H.ui.base.PushButton>}

This method retrieves the buttons currently registered with the given group.

Returns:
 
{Array<H.ui.base.PushButton>}
An array of buttons associated with the given group

setActiveButton (button, opt_suppressEvent)

This method sets the active button of the given radio group.

Parameters:
 
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

addChild (child) : {H.ui.base.Container}

This method adds a child element to be rendered within the given container element.

Parameters:
 
child:
{H.ui.base.Element}
 
The child element to be added
Returns:
 
{H.ui.base.Container}
This container instance

getChildren () : {Array<H.ui.base.Element>}

This method retrieves the child element collection of the given container.

Returns:
 
{Array<H.ui.base.Element>}
The child elements of the given container

removeChild (child)

This method removes a child element from the given container's child element collection.

Parameters:
 
child:
{H.ui.base.Element}
 
The child element to be removed

addEventListener (type, handler, opt_capture, opt_scope)

This method sets a listener for a specific event triggered by the given element.

Parameters:
 
type:
{string}
 
The name of the event type
handler:
{!Function}
 
An event handler function to be invoked when the event is fired
opt_capture:
{boolean=} [optional]
 
If true, listening is active in the capture phase (bubble otherwise)
opt_scope:
{Object=} [optional]
 
The scope for the handler function

removeEventListener (type, handler, opt_capture, opt_scope)

This method removes a previously added listener from the event target.

Parameters:
 
type:
{string}
 
The name of the event type
handler:
{!Function}
 
The previously added event handler
opt_capture:
{boolean=} [optional]
 
If true, listening is active in the capture phase (bubble otherwise)
opt_scope:
{Object=} [optional]
 
The scope for the handler function

renderInternal (element, doc)

This method is the concrete implementation of the UI element. It receives the pre-rendered HTML element which may be modified by deriving classes.

Parameters:
 
element:
{Element}
 
The HTML representation of the given UI element
doc:
{Document}
 
The HTML document into which the give UI element is rendered

isDisabled () : {boolean}

This method retrieves a value indicating if the given UI element is disabled.

Returns:
 
{boolean}
true if the element is disabled, false otherwise

setDisabled (disabled, opt_force) : {H.ui.base.Element}

This method sets a value indicating if the given UI element is disabled.

Parameters:
 
disabled:
{boolean}
 
true to disable the element, false to enable it
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:
 
{H.ui.base.Element}
An object representing the given element instance

getData () : {*}

This method retrieves previously stored arbitrary data from the given element.

Returns:
 
{*}
The previously stored data object or null if no data was stored.

setData (data)

This method stores arbitrary data with the given UI element.

Parameters:
 
data:
{*}
 
The data to be stored

getElement () : {?HTMLElement}

This method retrieves the HTML element the given UI element renders.

Note: If the UI element has not been rendered, the method retrieves null.

Returns:
 
{?HTMLElement}
An object representing the given element instance or null

setVisibility (visibility)

This method sets a value indicating if the given element is visible.

Parameters:
 
visibility:
{boolean}
 
true if the given element is visible, otherwise false

getVisibility () : {boolean}

This method retrieves a value indicating if the given element is visibile.

Returns:
 
{boolean}
true if the given element is visible, otherwise false

addClass (className) : {H.ui.base.Element}

This method adds a CSS class to the given UI element (if it is not already present).

Parameters:
 
className:
{string}
 
The name of the CSS class to add
Returns:
 
{H.ui.base.Element}
The given UI element instance

removeClass (className) : {H.ui.base.Element}

This method removes a CSS class from the given UI element (if it is present).

Parameters:
 
className:
{string}
 
The CSS class name to add
Returns:
 
{H.ui.base.Element}
The given UI element instance

Event Details

activebuttonchange: {H.util.Event}

This event is fired when a radio button becomes active.

statechange: {H.util.Event}

This event is fired when a RadioGroup's state changes.

You cannot use this account to purchase a commercial plan on Developer Portal, as it is already associated to plans with different payment methods.

To purchase a commercial plan on Developer Portal, please register for or sign in with a different HERE Account.

Something took longer than expected.

The project should be available soon under your projects page.

Sorry, our services are not available in this region.

Something seems to have gone wrong. Please try again later.

We've detected that your account is set to Australian Dollars (AUD).
Unfortunately, we do not offer checkouts in AUD anymore.
You can continue using your current plan as normal, but to subscribe to one of our new plans,
please register for a new HERE account or contact us for billing questions on selfservesupport@here.com.