Class: SC.ProgressView
Extends
SC.Control, SC.View.
Displays a progress bar. You can display both a defined and an indeterminate progressbar. The progress bar itself is designed to be styled using CSS classes with the following structure:
<div class="sc-progress-view"><div class="inner"></div></div>
The outer can form the boundary of the bar while the inner will be adjusted to fit the percentage of the progress.
Creating a ProgressView accepts a number of properties, for example:
progressView: SC.ProgressView.design({
value: 50,
minimum: 0,
maximum: 100,
isIndeterminate: NO,
isEnabled: YES
})
Defined in: progress.js
- Since:
- SproutCore 1.0
Field Summary
- ariaRole
- classNames
- contentIsIndeterminateKey
- contentMaximumKey
- contentMinimumKey
- displayProperties
- displayValue
- isIndeterminate
- isRunning
- maximum
- minimum
- renderDelegateName
- value
- Fields borrowed from SC.View:
- acceptsFirstResponder, acceptsMultitouch, ariaHidden, attributeBindings, autoMixins, backgroundColor, childViewLayout, childViewLayoutOptions, childViews, childViewsNeedLayout, classNameBindings, concatenatedProperties, createdByParent, designMode, enabledState, firstKeyView, hasLayout, hasTouch, hasVisibility, isBuildingIn, isBuildingOut, isChildViewLayoutLive, isEnabled, isFixedHeight, isFixedPosition, isFixedSize, isFixedWidth, isKeyResponder, isTextSelectable, isView, isVisible, lastKeyView, layerLocationNeedsUpdate, layerNeedsUpdate, layout, modeAdjust, nextKeyView, page, pane, parentView, previousKeyView, shouldInheritCursor, shouldInheritEnabled, tagName, themeName, toolTip, touchBoundary, transitionAdjust, transitionAdjustOptions, transitionHide, transitionHideOptions, transitionIn, transitionInOptions, transitionOut, transitionOutOptions, transitionShow, transitionShowOptions, useStaticLayout
- Fields borrowed from SC.Responder:
- hasFirstResponder, isFirstResponder, responderContext
- Fields borrowed from SC.Object:
- isDestroyed, isObject, nextProperty, object, property, target, toInvalidate
- Fields borrowed from SC.Observable:
- isObservable
- Fields borrowed from SC.Control:
- controlSize, errorLabel, fieldKey, fieldLabel, isActive, isControl, isSelected
Instance Methods
Field Detail
ariaRole String- Default value:
- 'progressbar'
- Default value:
- ['sc-progress-view']
- See:
- SC.View#classNames
Optionally specify the key used to extract the isIndeterminate value
from the content object. If this is set to null then the isIndeterminate
value will not be derived from the content object.
- Default value:
- null
Optionally specify the key used to extract the maximum progress value from the content object. If this is set to null then the maximum value will not be derived from the content object.
- Default value:
- null
Optionally specify the key used to extract the minimum progress value from the content object. If this is set to null then the minimum value will not be derived from the content object.
- Default value:
- null
- Default value:
- ['displayValue', 'ariaValue', 'minimum', 'maximum', 'isIndeterminate', 'isRunning', 'isVisibleInWindow']
- See:
- SC.View#displayProperties
Set to true if the item in progress is indeterminate. This may be overridden by the actual value.
- Default value:
- NO
Set to YES when the process is currently running. This will cause the
progress bar to animate, especially if it is indeterminate.
- Default value:
- NO
- Default value:
- 1.0
- Default value:
- 0
- Default value:
- 'progressRenderDelegate'
Bind this to the current value of the progress bar. Note that by default an empty value will disable the progress bar and a multiple value will make it indeterminate.
- Default value:
- 0.50
Instance Method Detail
The WAI-ARIA value for the progress view. This value will be passed to any rendering code as-is, not converted into percentages, etc. It is computed based on the original value property.