public class AjaxProgressBar extends WOComponent
| Bindings | |
id | the id of the update container |
progressID | the id of the AjaxProgress |
progress | the progress object for this progress bar (can bind a new progress back out if one is in the
registry) |
startedFunction | the javascript function to execute when the progress is started |
canceledFunction | the javascript function to execute when the progress is canceled |
succeededFunction | the javascript function to execute when the progress succeeds |
failedFunction | the javascript function to execute when the progress fails |
finishedFunction | the javascript function to execute when the progress finishes (succeeded, failed, or
canceled) |
cancelText | the text to display for the cancel link |
cancelingText | the text to display when the progress is being canceled |
startingText | the text to display when the progress is starting |
progressOfText | the text to display for the word "of" in the "[size] of [totalsize]" string during upload |
finishedAction | the action to fire when the progress finishes (cancel, failed, or succeeded) |
canceledAction | the action to fire when the progress is canceled |
succeededAction | the action to fire when the progress succeeded |
failedAction | the action to fire when the progress fails |
started | boolean of whether or not the progress has started (i.e. begin polling) |
allowCancel | if true, the cancel link is visible |
visibleBeforeStart | if true, the progress bar is visible before the activity is started |
visibleAfterDone | if true, the progress bar is visible after the activity is done |
refreshTime | the number of milliseconds to wait between refreshes |
WOComponent._EventLoggingEnabler, WOComponent.EventNSKeyValueCodingAdditions.DefaultImplementation, NSKeyValueCodingAdditions.UtilityNSKeyValueCoding._BooleanFieldBinding, NSKeyValueCoding._BooleanMethodBinding, NSKeyValueCoding._FieldBinding, NSKeyValueCoding._ForwardingBinding, NSKeyValueCoding._KeyBinding, NSKeyValueCoding._KeyBindingCreation, NSKeyValueCoding._MethodBinding, NSKeyValueCoding._NumberFieldBinding, NSKeyValueCoding._NumberMethodBinding, NSKeyValueCoding._ReflectionKeyBindingCreation, NSKeyValueCoding.ErrorHandling, NSKeyValueCoding.MapImplementation, NSKeyValueCoding.Null<T>, NSKeyValueCoding.UnknownKeyException, NSKeyValueCoding.ValueAccessorNSValidation._MethodBinding, NSValidation._ValidationBinding, NSValidation.DefaultImplementation, NSValidation.Utility, NSValidation.ValidationException| Modifier and Type | Field and Description |
|---|---|
static java.lang.String |
AJAX_PROGRESSES_KEY |
_Extension, _IsEventLoggingEnabled, _keyAssociations_CLASS_CLASS, _KeyPathSeparatorChar, KeyPathSeparatorNullValue_CLASS| Constructor and Description |
|---|
AjaxProgressBar(WOContext context) |
| Modifier and Type | Method and Description |
|---|---|
protected void |
_checkForCompletion() |
void |
appendToResponse(WOResponse aResponse,
WOContext aContext) |
WOActionResults |
cancel() |
java.lang.String |
cancelingText() |
java.lang.String |
cancelText() |
java.lang.Object |
displayMaximum() |
java.lang.Object |
displayValue() |
boolean |
done() |
protected void |
finished() |
java.lang.String |
finishedClass() |
boolean |
fireFinishedJavascriptEvents() |
boolean |
fireStartedJavascriptEvent() |
java.lang.String |
id() |
boolean |
isStarted() |
java.lang.String |
onChange() |
java.lang.String |
percentage() |
AjaxProgress |
progress() |
static AjaxProgress |
progress(WOSession session,
java.lang.String id)
Returns the progress object with the given id (or null if one does not exist).
|
boolean |
progressBarVisible() |
protected void |
progressCanceled() |
protected void |
progressFailed() |
java.lang.String |
progressID() |
java.lang.String |
progressOfText() |
protected void |
progressSucceeded() |
WOActionResults |
refreshing() |
java.lang.String |
refreshTime() |
static void |
registerProgress(WOSession session,
AjaxProgress progress)
Register a progress object in the registry.
|
java.lang.String |
startingText() |
boolean |
synchronizesVariablesWithBindings() |
static void |
unregisterProgress(WOSession session,
AjaxProgress progress)
Unregister a progress object from the registry.
|
__valueForBinding, _associationWithName, _awakeInContext, _childTemplate, _cleanUpStatelessComponent, _componentDefinition, _componentUnroll, _isPage, _setContext, _setIsPage, _setParent, _setSubcomponent, _sleepInContext, _subcomponentForElementWithID, _templateNameForClass, _unroll, application, awake, baseURL, bindingKeys, canAccessFieldsDirectly, canGetValueForBinding, canSetValueForBinding, clone, context, debugString, descriptionForResponse, ensureAwakeInContext, frameworkName, generateResponse, handleQueryWithUnboundKey, handleTakeValueForUnboundKey, hasBinding, hasSession, invokeAction, isCachingEnabled, isEventLoggingEnabled, isStateless, logString, name, pageWithName, parent, path, pathURL, performParentAction, pullValuesFromParent, pushValuesToParent, reset, session, set_componentUnroll, set_unroll, setCachingEnabled, setValueForBinding, setVariableValueForName, sleep, takeValueForKey, takeValueForKeyPath, takeValuesFromRequest, template, templateWithHTMLString, templateWithHTMLString, templateWithHTMLString, templateWithName, toString, unableToSetNullForKey, validateTakeValueForKeyPath, validateValueForKey, validationFailedWithException, valueForBinding, valueForBooleanBinding, valueForIntegerBinding, valueForKey, valueForKeyPath, valueForNSArrayBindings, valueForNSDictionaryBindings, valueForNumberBinding, valueForStringBinding, variableValueForName, variableWithNamepublic static final java.lang.String AJAX_PROGRESSES_KEY
public AjaxProgressBar(WOContext context)
public void appendToResponse(WOResponse aResponse, WOContext aContext)
appendToResponse in class WOComponentpublic boolean synchronizesVariablesWithBindings()
synchronizesVariablesWithBindings in class WOComponentpublic boolean fireStartedJavascriptEvent()
public boolean fireFinishedJavascriptEvents()
public boolean progressBarVisible()
public java.lang.String startingText()
public java.lang.String cancelingText()
public AjaxProgress progress()
public java.lang.String progressID()
public java.lang.String id()
public java.lang.String finishedClass()
public java.lang.Object displayValue()
public java.lang.Object displayMaximum()
public java.lang.String percentage()
public boolean isStarted()
public java.lang.String cancelText()
public java.lang.String progressOfText()
public java.lang.String onChange()
protected void _checkForCompletion()
public boolean done()
public java.lang.String refreshTime()
public WOActionResults refreshing()
public WOActionResults cancel()
protected void finished()
protected void progressCanceled()
protected void progressSucceeded()
protected void progressFailed()
public static void registerProgress(WOSession session, AjaxProgress progress)
session - the sessionprogress - the progress object to registerpublic static void unregisterProgress(WOSession session, AjaxProgress progress)
session - the sessionprogress - the progress object to unregisterpublic static AjaxProgress progress(WOSession session, java.lang.String id)
session - the sessionid - the id of the progress to retrieveCopyright © 2002 – 2022 Project Wonder.