class sap.ui.vtm.ProgressDialog

Control sample: sap.ui.vtm.ProgressDialog
Visiblity: public
UX Guidelines:
Implements:
Available since: N/A
Module: sap/ui/vtm/ProgressDialog
Application Component:

A progress control to show viewable download and load progress.


Constructor

Constructor for a new ProgressDialog.

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

new sap.ui.vtm.ProgressDialog(scene)
Param Type Default Value Description
scene sap.ui.vtm.Scene

The scene that is being used to load viewables.


Properties

Name Type Default Value Description
percentComplete int 0

The percentage (0-100) to show in the progress bar (if visible).

Visibility: public
progressBarVisible boolean true

Whether the progress bar is visible.

Visibility: public
progressText string

The text to display in the progress dialog.

Visibility: public

Methods Overview

Method Description
close

Closes the dialog.

sap.ui.vtm.ProgressDialog.extend

Creates a new subclass of class sap.ui.vtm.ProgressDialog 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.

sap.ui.vtm.ProgressDialog.getMetadata

Returns a metadata object for class sap.ui.vtm.ProgressDialog.

getPercentComplete

Gets current value of property percentComplete.

The percentage (0-100) to show in the progress bar (if visible).

Default value is 0.

getProgressBarVisible

Gets current value of property progressBarVisible.

Whether the progress bar is visible.

Default value is "true".

getProgressText

Gets current value of property progressText.

The text to display in the progress dialog.

isOpen

Returns whether the dialog is open.

open

Opens the dialog.

setPercentComplete

Sets a new value for property percentComplete.

The percentage (0-100) to show in the progress bar (if visible).

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

Default value is 0.

setProgressBarVisible

Sets a new value for property progressBarVisible.

Whether the progress bar is visible.

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

Default value is "true".

setProgressText

Sets a new value for property progressText.

The text to display in the progress dialog.

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

close

Closes the dialog.

sap.ui.vtm.ProgressDialog.extend

Creates a new subclass of class sap.ui.vtm.ProgressDialog 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.

Param Type DefaultValue Description
sClassName string

Name of the class being created

oClassInfo object

Object literal with information about the class

FNMetaImpl function

Constructor function for the metadata object; if not given, it defaults to the metadata implementation used by this class

sap.ui.vtm.ProgressDialog.getMetadata

Returns a metadata object for class sap.ui.vtm.ProgressDialog.

getPercentComplete

Gets current value of property percentComplete.

The percentage (0-100) to show in the progress bar (if visible).

Default value is 0.

getProgressBarVisible

Gets current value of property progressBarVisible.

Whether the progress bar is visible.

Default value is "true".

getProgressText

Gets current value of property progressText.

The text to display in the progress dialog.

isOpen

Returns whether the dialog is open.

open

Opens the dialog.

setPercentComplete

Sets a new value for property percentComplete.

The percentage (0-100) to show in the progress bar (if visible).

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

Default value is 0.

Param Type DefaultValue Description
iPercentComplete int 0

New value for property percentComplete

setProgressBarVisible

Sets a new value for property progressBarVisible.

Whether the progress bar is visible.

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

Default value is "true".

Param Type DefaultValue Description
bProgressBarVisible boolean "true"

New value for property progressBarVisible

setProgressText

Sets a new value for property progressText.

The text to display in the progress dialog.

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

Param Type DefaultValue Description
sProgressText string

New value for property progressText