com.sap.ui.commons.client
Class ProgressIndicator

java.lang.Object
  com.google.gwt.core.client.JavaScriptObject
      com.sap.ui.core.client.Element
          com.sap.ui.core.client.Control
              com.sap.ui.commons.client.ProgressIndicator

public class ProgressIndicator
extends com.sap.ui.core.client.Control

The class ProgressIndicator is the GWT wrapper for the Phoenix control: sap.ui.commons.ProgressIndicator.

This control can be used to e.g. visualize the progress of an activity.

• Properties
  • visible : boolean
    The visibility of the ProgressIndicator. Invisible controls are not rendered.
  • enabled : boolean
    Switches enabled state of the control. Disabled fields have different colors, and can not be focused.
  • barColor : com.sap.ui.core.client.BarColor
    The color of the ProgressIndicator bar.
  • displayValue : String
    The text value to display in the ProgressIndicator. If not set, there will be nothing displayed.
  • percentValue : int
    The numerical value between 0 and 100 which determines the position of the ProgressIndicator bar.
  • showValue : boolean
    Determines whether the current value should be rendered inside the bar.
  • width : String
    The width of the ProgressIndicator.
• Aggregations
• Associations
• Events

Version:

0.18.0-SNAPSHOT

Author:

GENERATOR (JavaScript control: sap.ui.commons.ProgressIndicator)

Constructor Summary

protected

ProgressIndicator() constructs the class ProgressIndicator hidden due to JavaScriptObject restriction

Method Summary

static ProgressIndicator	create() creates a new instance of the class ProgressIndicator
static ProgressIndicator	create(String idOrConfig) creates a new instance of the class ProgressIndicator
static ProgressIndicator	create(String id, String config) creates a new instance of the class ProgressIndicator
com.sap.ui.core.client.BarColor	getBarColor() Getter for property barColor The color of the ProgressIndicator bar.
String	getDisplayValue() Getter for property displayValue The text value to display in the ProgressIndicator.
int	getPercentValue() Getter for property percentValue The numerical value between 0 and 100 which determines the position of the ProgressIndicator bar.
String	getWidth() Getter for property width The width of the ProgressIndicator.
boolean	isEnabled() Getter for property enabled Switches enabled state of the control.
boolean	isShowValue() Getter for property showValue Determines whether the current value should be rendered inside the bar.
boolean	isVisible() Getter for property visible The visibility of the ProgressIndicator.
ProgressIndicator	setBarColor(com.sap.ui.core.client.BarColor value) Setter for property barColor Default value is: NEUTRAL
ProgressIndicator	setDisplayValue(String value) Setter for property displayValue Default value is: 0%
ProgressIndicator	setEnabled(boolean value) Setter for property enabled Default value is: true
ProgressIndicator	setPercentValue(int value) Setter for property percentValue Default value is: 0
ProgressIndicator	setShowValue(boolean value) Setter for property showValue Default value is: true
ProgressIndicator	setVisible(boolean value) Setter for property visible Default value is: true
ProgressIndicator	setWidth(String value) Setter for property width Default value is: 100%

Methods inherited from class com.sap.ui.core.client.Control

addStyleClass, hasStyleClass, invalidate, placeAt, placeAt, removeStyleClass, rerender

Methods inherited from class com.sap.ui.core.client.Element

_convertArray, _convertArray, _convertArray, _convertArray, _convertArray, attachBrowserEvent, attachEvent, bindAggregation, bindContext, bindProperty, bindProperty, destroy, detachBrowserEvent, detachEvent, getDomRef, getElementName, getId, getLibraryName, getModel, getParent, getProperty, getTooltip_AsString, getTooltip_Text, getTooltip, isActive, setModel, setProperty, setTooltip, setTooltip, unbindAggregation, unbindContext, unbindProperty

Methods inherited from class com.google.gwt.core.client.JavaScriptObject

cast, createArray, createFunction, createObject, equals, hashCode, toSource, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ProgressIndicator

protected ProgressIndicator()

constructs the class ProgressIndicator
hidden due to JavaScriptObject restriction

Method Detail

create

public static ProgressIndicator create()

creates a new instance of the class ProgressIndicator

create

public static ProgressIndicator create(String idOrConfig)

creates a new instance of the class ProgressIndicator

Parameters:

id - id of the ProgressIndicator or configuration JSON string

create

public static ProgressIndicator create(String id,
                                       String config)

creates a new instance of the class ProgressIndicator

Parameters:

id - id of the ProgressIndicator

config - configuration JSON string

isVisible

public final boolean isVisible()

Getter for property visible The visibility of the ProgressIndicator. Invisible controls are not rendered.

Returns:

the value of property visible

setVisible

public final ProgressIndicator setVisible(boolean value)

Setter for property visible
Default value is: true

Parameters:

value - boolean

Returns:

this to allow method chaining

isEnabled

public final boolean isEnabled()

Getter for property enabled Switches enabled state of the control. Disabled fields have different colors, and can not be focused.

Returns:

the value of property enabled

setEnabled

public final ProgressIndicator setEnabled(boolean value)

Setter for property enabled
Default value is: true

Parameters:

value - boolean

Returns:

this to allow method chaining

getBarColor

public final com.sap.ui.core.client.BarColor getBarColor()

Getter for property barColor The color of the ProgressIndicator bar.

Returns:

the value of property barColor

setBarColor

public final ProgressIndicator setBarColor(com.sap.ui.core.client.BarColor value)

Setter for property barColor
Default value is: NEUTRAL

Parameters:

value - com.sap.ui.core.client.BarColor

Returns:

this to allow method chaining

getDisplayValue

public final String getDisplayValue()

Getter for property displayValue The text value to display in the ProgressIndicator. If not set, there will be nothing displayed.

Returns:

the value of property displayValue

setDisplayValue

public final ProgressIndicator setDisplayValue(String value)

Setter for property displayValue
Default value is: 0%

Parameters:

value - String

Returns:

this to allow method chaining

getPercentValue

public final int getPercentValue()

Getter for property percentValue The numerical value between 0 and 100 which determines the position of the ProgressIndicator bar.

Returns:

the value of property percentValue

setPercentValue

public final ProgressIndicator setPercentValue(int value)

Setter for property percentValue
Default value is: 0

Parameters:

value - int

Returns:

this to allow method chaining

isShowValue

public final boolean isShowValue()

Getter for property showValue Determines whether the current value should be rendered inside the bar.

Returns:

the value of property showValue

setShowValue

public final ProgressIndicator setShowValue(boolean value)

Setter for property showValue
Default value is: true

Parameters:

value - boolean

Returns:

this to allow method chaining

getWidth

public final String getWidth()

Getter for property width The width of the ProgressIndicator.

Returns:

the value of property width

setWidth

public final ProgressIndicator setWidth(String value)

Setter for property width
Default value is: 100%

Parameters:

value - String

Returns:

this to allow method chaining