Class sap.ui.commons.SegmentedButtonModule: sap/ui/commons/SegmentedButton

extends Control

The SegmentedButton provides a group of multiple buttons. Only one button can be active. The behaviour is more ore less like a radio button group.
Deprecated API:
Since version 1.38. Instead, use the sap.m.SegmentedButton control.
Constructor Summary
new sap.ui.commons.SegmentedButton(sId?, mSettings?)Constructor for a new SegmentedButton.
Event Summary
select(oControlEvent)Event fired when button selected
Events borrowed from class sap.ui.core.Control
Method Summary
sap.ui.commons.SegmentedButton.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.commons.SegmentedButton with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.commons.SegmentedButton.getMetadata()Returns a metadata object for class sap.ui.commons.SegmentedButton.
_rerenderButtons()Rerendering of the Buttons
addButton(oButton)Adds some button to the aggregation buttons.
attachSelect(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the select event of this sap.ui.commons.SegmentedButton.
destroyButtons()Destroys all the buttons in the aggregation buttons.
detachSelect(fnFunction, oListener)Detaches event handler fnFunction from the select event of this sap.ui.commons.SegmentedButton.
fireSelect(mParameters?)Fires event select to attached listeners.
getButtons()Gets content of aggregation buttons.
getEnabled()Gets current value of property enabled.
getSelectedButton()ID of the element which is the current target of the association selectedButton, or null.
indexOfButton(oButton)Checks for the provided sap.ui.commons.Button in the aggregation buttons.
insertButton(oButton, iIndex)Inserts a button into the aggregation buttons.
removeAllButtons()Removes all the controls from the aggregation buttons.
removeButton(vButton)Removes a button from the aggregation buttons.
setEnabled(bEnabled)Sets a new value for property enabled.
setSelectedButton(oSelectedButton)Sets the associated selectedButton.
Constructor Detail
new sap.ui.commons.SegmentedButton(sId?, mSettings?)

Constructor for a new SegmentedButton.

Accepts an object literal mSettings that defines initial property values, aggregated and associated objects as well as event handlers. See sap.ui.base.ManagedObject for a general description of the syntax of the settings object.

The supported settings are:

  • Properties

  • Aggregations

  • Associations

  • Events

    • select : fnListenerFunction or [fnListenerFunction, oListenerObject] or [oData, fnListenerFunction, oListenerObject]

In addition, all settings applicable to the base type sap.ui.core.Control can be used as well.

Parameters:
stringsId?id for the new control, generated automatically if no id is given
objectmSettings?initial settings for the new control
Event Detail
select(oControlEvent)
Event fired when button selected
Parameters:
sap.ui.base.EventoControlEvent
sap.ui.base.EventProvideroControlEvent.getSource
objectoControlEvent.getParameters
stringoControlEvent.getParameters.selectedButtonIdId of selected ToggleButton
Method Detail
sap.ui.commons.SegmentedButton.extend(sClassName, oClassInfo?, FNMetaImpl?): function

Creates a new subclass of class sap.ui.commons.SegmentedButton with name sClassName and enriches it with the information contained in oClassInfo.

oClassInfo might contain the same kind of information as described in sap.ui.core.Control.extend.

Parameters:
stringsClassNameName of the class being created
objectoClassInfo?Object literal with information about the class
functionFNMetaImpl?Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata
Returns:
functionCreated class / constructor function
sap.ui.commons.SegmentedButton.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.commons.SegmentedButton.
Returns:
sap.ui.base.MetadataMetadata object describing this class
_rerenderButtons()
Rerendering of the Buttons
addButton(oButton): sap.ui.commons.SegmentedButton
Adds some button to the aggregation buttons.
Parameters:
sap.ui.commons.ButtonoButtonthe button to add; if empty, nothing is inserted
Returns:
sap.ui.commons.SegmentedButtonReference to this in order to allow method chaining
attachSelect(oData?, fnFunction, oListener?): sap.ui.commons.SegmentedButton

Attaches event handler fnFunction to the select event of this sap.ui.commons.SegmentedButton.

When called, the context of the event handler (its this) will be bound to oListener if specified, otherwise it will be bound to this sap.ui.commons.SegmentedButton itself.

Event fired when button selected

Parameters:
objectoData?An application-specific payload object that will be passed to the event handler along with the event object when firing the event
functionfnFunctionThe function to be called when the event occurs
objectoListener?Context object to call the event handler with. Defaults to this sap.ui.commons.SegmentedButton itself
Returns:
sap.ui.commons.SegmentedButtonReference to this in order to allow method chaining
Destroys all the buttons in the aggregation buttons.
Returns:
sap.ui.commons.SegmentedButtonReference to this in order to allow method chaining
detachSelect(fnFunction, oListener): sap.ui.commons.SegmentedButton

Detaches event handler fnFunction from the select event of this sap.ui.commons.SegmentedButton.

The passed function and listener object must match the ones used for event registration.

Parameters:
functionfnFunctionThe function to be called, when the event occurs
objectoListenerContext object on which the given function had to be called
Returns:
sap.ui.commons.SegmentedButtonReference to this in order to allow method chaining
fireSelect(mParameters?): sap.ui.commons.SegmentedButton
Fires event select to attached listeners.
Parameters:
objectmParameters?Parameters to pass along with the event
stringmParameters.selectedButtonId?Id of selected ToggleButton
Returns:
sap.ui.commons.SegmentedButtonReference to this in order to allow method chaining
getButtons(): sap.ui.commons.Button[]

Gets content of aggregation buttons.

Buttons

Returns:
sap.ui.commons.Button[]
getEnabled(): boolean

Gets current value of property enabled.

enabled

Default value is true.

Returns:
booleanValue of property enabled
getSelectedButton(): sap.ui.core.ID
ID of the element which is the current target of the association selectedButton, or null.
Returns:
sap.ui.core.ID
indexOfButton(oButton): int
Checks for the provided sap.ui.commons.Button in the aggregation buttons. and returns its index if found or -1 otherwise.
Parameters:
sap.ui.commons.ButtonoButtonThe button whose index is looked for
Returns:
intThe index of the provided control in the aggregation if found, or -1 otherwise
insertButton(oButton, iIndex): sap.ui.commons.SegmentedButton
Inserts a button into the aggregation buttons.
Parameters:
sap.ui.commons.ButtonoButtonthe button to insert; if empty, nothing is inserted
intiIndexthe 0-based index the button should be inserted at; for a negative value of iIndex, the button is inserted at position 0; for a value greater than the current size of the aggregation, the button is inserted at the last position
Returns:
sap.ui.commons.SegmentedButtonReference to this in order to allow method chaining
removeAllButtons(): sap.ui.commons.Button[]

Removes all the controls from the aggregation buttons.

Additionally, it unregisters them from the hosting UIArea.

Returns:
sap.ui.commons.Button[]An array of the removed elements (might be empty)
removeButton(vButton): sap.ui.commons.Button
Removes a button from the aggregation buttons.
Parameters:
int|string|sap.ui.commons.ButtonvButtonThe button to remove or its index or id
Returns:
sap.ui.commons.ButtonThe removed button or null
setEnabled(bEnabled): sap.ui.commons.SegmentedButton

Sets a new value for property enabled.

enabled

When called with a value of null or undefined, the default value of the property will be restored.

Default value is true.

Parameters:
booleanbEnabledNew value for property enabled
Returns:
sap.ui.commons.SegmentedButtonReference to this in order to allow method chaining
setSelectedButton(oSelectedButton): sap.ui.commons.SegmentedButton
Sets the associated selectedButton.
Parameters:
sap.ui.core.ID|sap.ui.commons.ButtonoSelectedButtonID of an element which becomes the new target of this selectedButton association; alternatively, an element instance may be given
Returns:
sap.ui.commons.SegmentedButtonReference to this in order to allow method chaining