Class sap.ui.suite.VerticalProgressIndicatorModule: sap/ui/suite/VerticalProgressIndicator

extends Control

This control shows a vertical progress bar in dependency of the given percentage. Only values between 0 and 100 are valid.
Experimental API:
Since version 1.2. The API may change. User with care.
Constructor Summary
new sap.ui.suite.VerticalProgressIndicator(sId?, mSettings?)Constructor for a new VerticalProgressIndicator.
Event Summary
press(oControlEvent)Event is fired when the user clicks the control.
Events borrowed from class sap.ui.core.Control
Method Summary
sap.ui.suite.VerticalProgressIndicator.extend(sClassName, oClassInfo?, FNMetaImpl?)Creates a new subclass of class sap.ui.suite.VerticalProgressIndicator with name sClassName and enriches it with the information contained in oClassInfo.
sap.ui.suite.VerticalProgressIndicator.getMetadata()Returns a metadata object for class sap.ui.suite.VerticalProgressIndicator.
addAriaDescribedBy(vAriaDescribedBy)Adds some ariaDescribedBy into the association ariaDescribedBy.
addAriaLabelledBy(vAriaLabelledBy)Adds some ariaLabelledBy into the association ariaLabelledBy.
attachPress(oData?, fnFunction, oListener?)Attaches event handler fnFunction to the press event of this sap.ui.suite.VerticalProgressIndicator.
detachPress(fnFunction, oListener)Detaches event handler fnFunction from the press event of this sap.ui.suite.VerticalProgressIndicator.
firePress(mParameters?)Fires event press to attached listeners.
focus()Puts the focus to the control.
getAriaDescribedBy()Returns array of IDs of the elements which are the current targets of the association ariaDescribedBy.
getAriaLabelledBy()Returns array of IDs of the elements which are the current targets of the association ariaLabelledBy.
getPercentage()Gets current value of property percentage.
removeAllAriaDescribedBy()Removes all the controls in the association named ariaDescribedBy.
removeAllAriaLabelledBy()Removes all the controls in the association named ariaLabelledBy.
removeAriaDescribedBy(vAriaDescribedBy)Removes an ariaDescribedBy from the association named ariaDescribedBy.
removeAriaLabelledBy(vAriaLabelledBy)Removes an ariaLabelledBy from the association named ariaLabelledBy.
setPercentage(iPercentage)Property setter for the Percentage, which determines the height of the vertical bar.
Constructor Detail
new sap.ui.suite.VerticalProgressIndicator(sId?, mSettings?)

Constructor for a new VerticalProgressIndicator.

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

  • Associations

  • Events

    • press : 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
press(oControlEvent)
Event is fired when the user clicks the control.
Parameters:
sap.ui.base.EventoControlEvent
sap.ui.base.EventProvideroControlEvent.getSource
objectoControlEvent.getParameters
Method Detail
sap.ui.suite.VerticalProgressIndicator.extend(sClassName, oClassInfo?, FNMetaImpl?): function

Creates a new subclass of class sap.ui.suite.VerticalProgressIndicator 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.suite.VerticalProgressIndicator.getMetadata(): sap.ui.base.Metadata
Returns a metadata object for class sap.ui.suite.VerticalProgressIndicator.
Returns:
sap.ui.base.MetadataMetadata object describing this class
addAriaDescribedBy(vAriaDescribedBy): sap.ui.suite.VerticalProgressIndicator
Adds some ariaDescribedBy into the association ariaDescribedBy.
Parameters:
sap.ui.core.ID|sap.ui.core.ControlvAriaDescribedBythe ariaDescribedBy to add; if empty, nothing is inserted
Returns:
sap.ui.suite.VerticalProgressIndicatorReference to this in order to allow method chaining
addAriaLabelledBy(vAriaLabelledBy): sap.ui.suite.VerticalProgressIndicator
Adds some ariaLabelledBy into the association ariaLabelledBy.
Parameters:
sap.ui.core.ID|sap.ui.core.ControlvAriaLabelledBythe ariaLabelledBy to add; if empty, nothing is inserted
Returns:
sap.ui.suite.VerticalProgressIndicatorReference to this in order to allow method chaining
attachPress(oData?, fnFunction, oListener?): sap.ui.suite.VerticalProgressIndicator

Attaches event handler fnFunction to the press event of this sap.ui.suite.VerticalProgressIndicator.

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.suite.VerticalProgressIndicator itself.

Event is fired when the user clicks the control.

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.suite.VerticalProgressIndicator itself
Returns:
sap.ui.suite.VerticalProgressIndicatorReference to this in order to allow method chaining
detachPress(fnFunction, oListener): sap.ui.suite.VerticalProgressIndicator

Detaches event handler fnFunction from the press event of this sap.ui.suite.VerticalProgressIndicator.

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.suite.VerticalProgressIndicatorReference to this in order to allow method chaining
firePress(mParameters?): sap.ui.suite.VerticalProgressIndicator
Fires event press to attached listeners.
Parameters:
objectmParameters?Parameters to pass along with the event
Returns:
sap.ui.suite.VerticalProgressIndicatorReference to this in order to allow method chaining
focus(): void
Puts the focus to the control.
getAriaDescribedBy(): sap.ui.core.ID[]
Returns array of IDs of the elements which are the current targets of the association ariaDescribedBy.
Returns:
sap.ui.core.ID[]
getAriaLabelledBy(): sap.ui.core.ID[]
Returns array of IDs of the elements which are the current targets of the association ariaLabelledBy.
Returns:
sap.ui.core.ID[]
getPercentage(): int

Gets current value of property percentage.

The numerical value between 0 and 100 which determines the height of the vertical bar. Values higher than 100 will be displayed as 100%, values lower than zero will be displayed as 0%.

Returns:
intValue of property percentage
removeAllAriaDescribedBy(): sap.ui.core.ID[]
Removes all the controls in the association named ariaDescribedBy.
Returns:
sap.ui.core.ID[]An array of the removed elements (might be empty)
removeAllAriaLabelledBy(): sap.ui.core.ID[]
Removes all the controls in the association named ariaLabelledBy.
Returns:
sap.ui.core.ID[]An array of the removed elements (might be empty)
removeAriaDescribedBy(vAriaDescribedBy): sap.ui.core.ID
Removes an ariaDescribedBy from the association named ariaDescribedBy.
Parameters:
int|sap.ui.core.ID|sap.ui.core.ControlvAriaDescribedByThe ariaDescribedBy to be removed or its index or ID
Returns:
sap.ui.core.IDThe removed ariaDescribedBy or null
removeAriaLabelledBy(vAriaLabelledBy): sap.ui.core.ID
Removes an ariaLabelledBy from the association named ariaLabelledBy.
Parameters:
int|sap.ui.core.ID|sap.ui.core.ControlvAriaLabelledByThe ariaLabelledBy to be removed or its index or ID
Returns:
sap.ui.core.IDThe removed ariaLabelledBy or null
setPercentage(iPercentage): sap.ui.suite.VerticalProgressIndicator
Property setter for the Percentage, which determines the height of the vertical bar. Values higher than 100 will be displayed as 100%, values lower than zero will be displayed as 0%. A new rendering is not necessary, only the bar will be moved
Parameters:
intiPercentage
Returns:
sap.ui.suite.VerticalProgressIndicatorthis to allow method chaining