Class sap.ui.core.LocalBusyIndicatorModule: sap/ui/core/LocalBusyIndicator

extends Control

The LocalBusyIndicator is a special version of the BusyIndicator. This one doesn't block the whole screen - it just blocks the corresponding control and puts a local animation over the control. To use the functionality of this control the corresponding control needs to be enabled via the 'LocalBusyIndicatorSupport' accordingly to the ListBox control (see the init-function of the ListBox).

Deprecated API:Since version 1.14.2. The LocalBusyIndicator Control is not needed anymore by the new implementation of the LBI. Hence, it is not used anymore.


Since: 1.11.0.
Constructor Summary
new sap.ui.core.LocalBusyIndicator(sId?, mSettings?)Constructor for a new LocalBusyIndicator.
Events borrowed from class sap.ui.core.Control
validateFieldGroup
Events borrowed from class sap.ui.base.ManagedObject
formatError, modelContextChange, parseError, validationError, validationSuccess
Method Summary
sap.ui.core.LocalBusyIndicator.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.core.LocalBusyIndicator with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.core.LocalBusyIndicator.getMetadata()Returns a metadata object for class sap.ui.core.LocalBusyIndicator.
getHeight()Gets current value of property height.
getWidth()Gets current value of property width.
setHeight(sHeight)Sets a new value for property height.
setWidth(sWidth)Sets a new value for property width.
Methods borrowed from class sap.ui.core.Control
addStyleClass, allowTextSelection, attachBrowserEvent, attachValidateFieldGroup, checkFieldGroupIds, clone, detachBrowserEvent, detachValidateFieldGroup, fireValidateFieldGroup, getAccessibilityInfo, 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, focus, 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
attachEvent, attachEventOnce, detachEvent, hasListeners
Constructor Detail
new sap.ui.core.LocalBusyIndicator(sId?, mSettings?)
Constructor for a new LocalBusyIndicator.

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
    • width : sap.ui.core.CSSSize (default: 100px)
    • height : sap.ui.core.CSSSize (default: 100px)

In addition, all settings applicable to the base type sap.ui.core.Control 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.14.2. The LocalBusyIndicator Control is not needed anymore by the new implementation of the LBI. Hence, it is not used anymore.
Method Detail
sap.ui.core.LocalBusyIndicator.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.ui.core.LocalBusyIndicator 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:
{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.core.LocalBusyIndicator.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.core.LocalBusyIndicator.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
getHeight(): sap.ui.core.CSSSize
Gets current value of property height.

This property is the height of the control that has to be covered. With this height the position of the animation can be properly set.

Default value is 100px.

Returns:
{sap.ui.core.CSSSize} Value of property height
getWidth(): sap.ui.core.CSSSize
Gets current value of property width.

This property is the width of the control that has to be covered. With this width the position of the animation can be properly set.

Default value is 100px.

Returns:
{sap.ui.core.CSSSize} Value of property width
setHeight(sHeight): sap.ui.core.LocalBusyIndicator
Sets a new value for property height.

This property is the height of the control that has to be covered. With this height the position of the animation can be properly set.

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

Default value is 100px.

Parameters:
{sap.ui.core.CSSSize}sHeight New value for property height
Returns:
{sap.ui.core.LocalBusyIndicator} Reference to this in order to allow method chaining
setWidth(sWidth): sap.ui.core.LocalBusyIndicator
Sets a new value for property width.

This property is the width of the control that has to be covered. With this width the position of the animation can be properly set.

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

Default value is 100px.

Parameters:
{sap.ui.core.CSSSize}sWidth New value for property width
Returns:
{sap.ui.core.LocalBusyIndicator} Reference to this in order to allow method chaining