com.sap.ui.commons.client
Class ProgressIndicatorWidget

java.lang.Object
  com.google.gwt.user.client.ui.UIObject
      com.google.gwt.user.client.ui.Widget
          com.sap.ui.core.client.ControlWidget
              com.sap.ui.commons.client.ProgressIndicatorWidget

All Implemented Interfaces:

com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.IsWidget

public class ProgressIndicatorWidget
extends com.sap.ui.core.client.ControlWidget

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: Michael Sobczak)

Nested Class Summary

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

Field Summary

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

	ProgressIndicatorWidget() constructs the class ProgressIndicatorWidget
protected	ProgressIndicatorWidget(ProgressIndicator control) constructs the class ProgressIndicatorWidget
	ProgressIndicatorWidget(String id) constructs the class ProgressIndicatorWidget

Method Summary

com.sap.ui.core.client.BarColor	getBarColor() Getter for property barColor The color of the ProgressIndicator bar.
ProgressIndicator	getControl() returns the reference to the Phoenix Control
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.
void	setBarColor(com.sap.ui.core.client.BarColor value) Setter for property barColor Default value is: NEUTRAL
void	setDisplayValue(String value) Setter for property displayValue Default value is: 0%
void	setEnabled(boolean value) Setter for property enabled Default value is: true
void	setPercentValue(int value) Setter for property percentValue Default value is: 0
void	setShowValue(boolean value) Setter for property showValue Default value is: true
void	setVisible(boolean value) Setter for property visible Default value is: true
void	setWidth(String value) Setter for property width Default value is: 100%

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

destroy, doAttachChildren, doDetachChildren, isDesignTime, wrap

Methods inherited from class com.google.gwt.user.client.ui.Widget

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onBrowserEvent, onDetach, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents

Methods inherited from class com.google.gwt.user.client.ui.UIObject

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, sinkBitlessEvent, toString, unsinkEvents

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ProgressIndicatorWidget

public ProgressIndicatorWidget()

constructs the class ProgressIndicatorWidget

ProgressIndicatorWidget

public ProgressIndicatorWidget(String id)

constructs the class ProgressIndicatorWidget

Parameters:

id - id of the ProgressIndicatorWidget

ProgressIndicatorWidget

protected ProgressIndicatorWidget(ProgressIndicator control)

constructs the class ProgressIndicatorWidget

Parameters:

control - reference to an existing ProgressIndicator

Method Detail

getControl

public ProgressIndicator getControl()

returns the reference to the Phoenix Control

Overrides:

getControl in class com.sap.ui.core.client.ControlWidget

Returns:

reference to the Phoenix Control

isVisible

public boolean isVisible()

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

Overrides:

isVisible in class com.google.gwt.user.client.ui.UIObject

Returns:

the value of property visible

setVisible

public void setVisible(boolean value)

Setter for property visible
Default value is: true

Overrides:

setVisible in class com.google.gwt.user.client.ui.UIObject

Parameters:

value - boolean

isEnabled

public 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 void setEnabled(boolean value)

Setter for property enabled
Default value is: true

Parameters:

value - boolean

getBarColor

public 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 void setBarColor(com.sap.ui.core.client.BarColor value)

Setter for property barColor
Default value is: NEUTRAL

Parameters:

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

getDisplayValue

public 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 void setDisplayValue(String value)

Setter for property displayValue
Default value is: 0%

Parameters:

value - String

getPercentValue

public 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 void setPercentValue(int value)

Setter for property percentValue
Default value is: 0

Parameters:

value - int

isShowValue

public 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 void setShowValue(boolean value)

Setter for property showValue
Default value is: true

Parameters:

value - boolean

getWidth

public String getWidth()

Getter for property width The width of the ProgressIndicator.

Returns:

the value of property width

setWidth

public void setWidth(String value)

Setter for property width
Default value is: 100%

Overrides:

setWidth in class com.google.gwt.user.client.ui.UIObject

Parameters:

value - String