new ProgressBar(componentId, options)
Backing object for rich:progressBar
Parameters:
| Name | Type | Description |
|---|---|---|
componentId |
||
options |
- Source:
Extends
Members
name :string
Component name.
Type:
- string
- Inherited From:
- Source:
Methods
attachToDom(source) → {DOMElement}
Attach component object to DOM element by component id, DOM element or jQuery object and returns the element
Its required for the client side API calls and to clean up after ajax request or document unload by
calling destroy method
Parameters:
| Name | Type | Description |
|---|---|---|
source |
string | DOMElement | jQuery | component id, DOM element or DOM elements wrapped by jQuery |
- Inherited From:
- Source:
Returns:
- Type
- DOMElement
destroy()
Destroy method. Will be called before remove component from the page
- Inherited From:
- Source:
detach(source)
Detach component object from DOM element by component id, DOM element or jQuery object
Parameters:
| Name | Type | Description |
|---|---|---|
source |
string | DOMElement | jQuery | component id, DOM element or DOM elements wrapped by jQuery |
- Inherited From:
- Source:
disable()
Disable the progress bar
- Source:
enable()
Enable the progress bar
- Source:
getEventElement() → {string}
Method returns element's id for event handlers binding.
Event API calls this method when binding by component object as selector was used.
- Inherited From:
- Source:
Returns:
- Type
- string
getMaxValue() → {int}
Get max value of the progress bar
- Source:
Returns:
max value
- Type
- int
getMinValue() → {int}
Get min value of the progress bar
- Source:
Returns:
min value
- Type
- int
getValue() → {int}
Get current value
- Source:
Returns:
current value
- Type
- int
invokeEvent(eventType, element, event, data) → {boolean}
Invokes event on on the DOM element
Parameters:
| Name | Type | Description |
|---|---|---|
eventType |
string | event type, e.g. "click" |
element |
DOMElement | DOM element object |
event |
Event | jQuery Event |
data |
Object | additional data used for event handler |
- Inherited From:
- Source:
Returns:
true if an event is successfully invoked
- Type
- boolean
isEnabled() → {boolean}
Returns true if the progress bar is enabled
- Source:
Returns:
true if the progress bar is enabled
- Type
- boolean
setValue(value)
Set new value
Parameters:
| Name | Type | Description |
|---|---|---|
value |
int | new value |
- Source:
toString() → {string}
Method for converting object to string
- Inherited From:
- Source:
Returns:
- Type
- string