Class sap.ui.vk.ProgressIndicatorModule: sap/ui/vk/ProgressIndicator

extends Control

Provides a progress indicator to show the download and rendering status of resources being loaded into a scene.

Experimental API:Since 1.38.0 This class is experimental and might be modified or removed in future versions.

Constructor Summary
new sap.ui.vk.ProgressIndicator()Constructor for a new ProgressIndicator.
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.vk.ProgressIndicator.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.vk.ProgressIndicator with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.vk.ProgressIndicator.getMetadata()Returns a metadata object for class sap.ui.vk.ProgressIndicator.
getNumberOfFiles()Gets current value of property numberOfFiles.
reset()Resets the download and rendering properties of the progress indicator to their default values.
setNumberOfFiles(iNumberOfFiles)Sets a new value for property numberOfFiles.
updateDownloadStatus(fileName, loaded, totalFileSize)Updates the progress bar during the downloading phase.
updateRenderStatus(currentPercentage)Updates the progress bar during the rendering phase.
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.vk.ProgressIndicator()
Constructor for a new ProgressIndicator.

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:

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

Method Detail
sap.ui.vk.ProgressIndicator.extend(sClassName, oClassInfo?, FNMetaImpl?): function
Creates a new subclass of class sap.ui.vk.ProgressIndicator 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.vk.ProgressIndicator.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.vk.ProgressIndicator.
Returns:
{sap.ui.base.Metadata} Metadata object describing this class
getNumberOfFiles(): int
Gets current value of property numberOfFiles.

Default value is 0.

Returns:
{int} Value of property numberOfFiles
reset(): sap.ui.vk.ProgressIndicator
Resets the download and rendering properties of the progress indicator to their default values.
Returns:
{sap.ui.vk.ProgressIndicator}this to allow method chaining.
setNumberOfFiles(iNumberOfFiles): sap.ui.vk.ProgressIndicator
Sets a new value for property numberOfFiles.

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

Default value is 0.

Parameters:
{int}iNumberOfFiles New value for property numberOfFiles
Returns:
{sap.ui.vk.ProgressIndicator} Reference to this in order to allow method chaining
updateDownloadStatus(fileName, loaded, totalFileSize): sap.ui.vk.ProgressIndicator
Updates the progress bar during the downloading phase. When multiple files are being downloaded, the progress bar updates to show the overall download progress for all the files.
Parameters:
{string}fileName The name of the file which sent the download progress event.
{number}loaded The amount of data that has been downloaded so far for this particular file.
{number}totalFileSize The total size of the file currently being downloaded.
Returns:
{sap.ui.vk.ProgressIndicator}this to allow method chaining.
updateRenderStatus(currentPercentage): sap.ui.vk.ProgressIndicator
Updates the progress bar during the rendering phase. When multiple files have been downloaded, the progress bar updates to show the overall rendering progress for all the files.
Parameters:
{number}currentPercentage A percentage showing the rendering progress of the current file or files.
Returns:
{sap.ui.vk.ProgressIndicator}this to allow method chaining.