Class sap.ui.commons.ToggleButtonModule: sap/ui/commons/ToggleButton
extends Button
The ToggleButton Control is a Button that can be toggled between pressed and normal state
Deprecated API:Since version 1.38. Instead, use the sap.m.ToggleButton control.
Constructor Summary
Events borrowed from class sap.ui.commons.Button
Events borrowed from class sap.ui.core.Control
Events borrowed from class sap.ui.base.ManagedObject
Method Summary
sap.ui.commons.ToggleButton.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.commons.ToggleButton with name
sClassName and enriches it with the information contained in oClassInfo.sap.ui.commons.ToggleButton.getMetadata()Returns a metadata object for class sap.ui.commons.ToggleButton.
Methods borrowed from class sap.ui.commons.Button
addAriaDescribedBy, addAriaLabelledBy, attachPress, detachPress, firePress, focus, getAriaDescribedBy, getAriaLabelledBy, getEnabled, getHeight, getHelpId, getIcon, getIconFirst, getIconHovered, getIconSelected, getLite, getStyle, getStyled, getText, getWidth, removeAllAriaDescribedBy, removeAllAriaLabelledBy, removeAriaDescribedBy, removeAriaLabelledBy, setEnabled, setHeight, setHelpId, setIcon, setIconFirst, setIconHovered, setIconSelected, setLite, setStyle, setStyled, setText, setWidth
Methods borrowed from class sap.ui.core.Control
addStyleClass, allowTextSelection, attachBrowserEvent, attachValidateFieldGroup, checkFieldGroupIds, clone, detachBrowserEvent, detachValidateFieldGroup, fireValidateFieldGroup, getBusy, getBusyIndicatorDelay, getControlsByFieldGroupId, getFieldGroupIds, getIdForLabel, getRenderer, getVisible, hasStyleClass, invalidate, isBusy, onAfterRendering, onBeforeRendering, placeAt, removeStyleClass, rerender, setBusy, setBusyIndicatorDelay, setFieldGroupIds, setVisible, toggleStyleClass, triggerValidateFieldGroup
Methods borrowed from class sap.ui.core.Element
$, addCustomData, addDependent, addEventDelegate, applyFocusInfo, bindElement, data, destroy, destroyCustomData, destroyDependents, destroyLayoutData, destroyTooltip, enhanceAccessibilityState, exit, findElements, fireEvent, getCustomData, getDependents, getDomRef, getElementBinding, getFocusDomRef, getFocusInfo, getInterface, getLayoutData, getMetadata, getTooltip, getTooltip_AsString, getTooltip_Text, indexOfCustomData, indexOfDependent, init, insertCustomData, insertDependent, prop, removeAllCustomData, removeAllDependents, removeCustomData, removeDependent, removeEventDelegate, setLayoutData, setTooltip, toString, unbindElement
Methods borrowed from class sap.ui.base.ManagedObject
addAggregation, addAssociation, applySettings, attachFormatError, attachModelContextChange, attachParseError, attachValidationError, attachValidationSuccess, bindAggregation, bindContext, bindObject, bindProperty, destroyAggregation, detachFormatError, detachModelContextChange, detachParseError, detachValidationError, detachValidationSuccess, findAggregatedObjects, fireFormatError, fireModelContextChange, fireParseError, fireValidationError, fireValidationSuccess, getAggregation, getAssociation, getBinding, getBindingContext, getBindingInfo, getBindingPath, getEventingParent, getId, getModel, getObjectBinding, getOriginInfo, getParent, getProperty, hasModel, indexOfAggregation, insertAggregation, isBound, isInvalidateSuppressed, isTreeBinding, propagateMessages, removeAggregation, removeAllAggregation, removeAllAssociation, removeAssociation, setAggregation, setAssociation, setBindingContext, setModel, setProperty, unbindAggregation, unbindContext, unbindObject, unbindProperty, validateAggregation, validateProperty
Methods borrowed from class sap.ui.base.EventProvider
Constructor Detail
new sap.ui.commons.ToggleButton(sId?, mSettings?)
Constructor for a new ToggleButton.
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
- pressed : boolean (default: false)
In addition, all settings applicable to the base type sap.ui.commons.Button can be used as well.
Parameters:
| {string} | sId? | id for the new control, generated automatically if no id is given |
| {object} | mSettings? | initial settings for the new control |
- Deprecated:
- Since version 1.38. Instead, use the
sap.m.ToggleButtoncontrol.
Method Detail
sap.ui.commons.ToggleButton.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.ui.commons.ToggleButton 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.commons.Button.extend.
Parameters:
| {string} | sClassName | Name of the class being created |
| {object} | oClassInfo? | Object literal with information about the class |
| {function} | FNMetaImpl? | Constructor function for the metadata object; if not given, it defaults to sap.ui.core.ElementMetadata |
Returns:
| {function} | Created class / constructor function |
sap.ui.commons.ToggleButton.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.commons.ToggleButton.
Returns:
| {sap.ui.base.Metadata} | Metadata object describing this class |
getPressed(): boolean
Gets current value of property
pressed. The property is “true” when the control is toggled. The default state of this property is "false".
Default value is false.
Returns:
| {boolean} | Value of property pressed |
setPressed(bPressed): sap.ui.commons.ToggleButton
Sets a new value for property
pressed. The property is “true” when the control is toggled. The default state of this property is "false".
When called with a value of null or undefined, the default value of the property will be restored.
Default value is false.
Parameters:
| {boolean} | bPressed | New value for property pressed |
Returns:
| {sap.ui.commons.ToggleButton} | Reference to this in order to allow method chaining |