er.ajax

Class AjaxProgressBar

java.lang.Object

com.webobjects.appserver.WOElement

com.webobjects.appserver.WOComponent

er.ajax.AjaxProgressBar

All Implemented Interfaces:

WOActionResults, NSKeyValueCoding, NSKeyValueCoding.ErrorHandling, NSKeyValueCodingAdditions, NSValidation, Serializable, Cloneable

public class AjaxProgressBar
extends WOComponent

See Also:

Serialized Form

Author:

mschrag

Bindings

Name	Description
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

Nested Class Summary

Nested classes/interfaces inherited from class com.webobjects.appserver.WOComponent

WOComponent._EventLoggingEnabler, WOComponent.Event

Nested classes/interfaces inherited from interface com.webobjects.foundation.NSKeyValueCodingAdditions

NSKeyValueCodingAdditions.DefaultImplementation, NSKeyValueCodingAdditions.Utility

Nested classes/interfaces inherited from interface com.webobjects.foundation.NSKeyValueCoding

NSKeyValueCoding._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.ValueAccessor

Nested classes/interfaces inherited from interface com.webobjects.foundation.NSValidation

NSValidation._MethodBinding, NSValidation._ValidationBinding, NSValidation.DefaultImplementation, NSValidation.Utility, NSValidation.ValidationException

Field Summary

Fields

Modifier and Type	Field and Description
static String	AJAX_PROGRESSES_KEY

Fields inherited from class com.webobjects.appserver.WOComponent

_Extension, _IsEventLoggingEnabled, _keyAssociations

Fields inherited from interface com.webobjects.foundation.NSKeyValueCoding.ErrorHandling

_CLASS

Fields inherited from interface com.webobjects.foundation.NSKeyValueCodingAdditions

_CLASS, _KeyPathSeparatorChar, KeyPathSeparator

Fields inherited from interface com.webobjects.foundation.NSKeyValueCoding

NullValue

Fields inherited from interface com.webobjects.foundation.NSValidation

_CLASS

Constructor Summary

Constructors

Constructor and Description
AjaxProgressBar(WOContext context)

Method Summary

Modifier and Type	Method and Description
protected void	_checkForCompletion()
void	appendToResponse(WOResponse aResponse, WOContext aContext)
WOActionResults	cancel()
String	cancelingText()
String	cancelText()
Object	displayMaximum()
Object	displayValue()
boolean	done()
protected void	finished()
String	finishedClass()
boolean	fireFinishedJavascriptEvents()
boolean	fireStartedJavascriptEvent()
String	id()
boolean	isStarted()
String	onChange()
String	percentage()
AjaxProgress	progress()
static AjaxProgress	progress(WOSession session, 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()
String	progressID()
String	progressOfText()
protected void	progressSucceeded()
WOActionResults	refreshing()
String	refreshTime()
static void	registerProgress(WOSession session, AjaxProgress progress) Register a progress object in the registry.
String	startingText()
boolean	synchronizesVariablesWithBindings()
static void	unregisterProgress(WOSession session, AjaxProgress progress) Unregister a progress object from the registry.

Methods inherited from class com.webobjects.appserver.WOComponent

__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, variableWithName

Methods inherited from class java.lang.Object

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

Field Detail

AJAX_PROGRESSES_KEY

public static final String AJAX_PROGRESSES_KEY

See Also:

Constant Field Values

Constructor Detail

AjaxProgressBar

public AjaxProgressBar(WOContext context)

Method Detail

appendToResponse

public void appendToResponse(WOResponse aResponse,
                             WOContext aContext)

Overrides:

appendToResponse in class WOComponent

synchronizesVariablesWithBindings

public boolean synchronizesVariablesWithBindings()

Overrides:

synchronizesVariablesWithBindings in class WOComponent

fireStartedJavascriptEvent

public boolean fireStartedJavascriptEvent()

fireFinishedJavascriptEvents

public boolean fireFinishedJavascriptEvents()

progressBarVisible

public boolean progressBarVisible()

startingText

public String startingText()

cancelingText

public String cancelingText()

progress

public AjaxProgress progress()

progressID

public String progressID()

id

public String id()

finishedClass

public String finishedClass()

displayValue

public Object displayValue()

displayMaximum

public Object displayMaximum()

percentage

public String percentage()

isStarted

public boolean isStarted()

cancelText

public String cancelText()

progressOfText

public String progressOfText()

onChange

public String onChange()

_checkForCompletion

protected void _checkForCompletion()

done

public boolean done()

refreshTime

public String refreshTime()

refreshing

public WOActionResults refreshing()

cancel

public WOActionResults cancel()

finished

protected void finished()

progressCanceled

protected void progressCanceled()

progressSucceeded

protected void progressSucceeded()

progressFailed

protected void progressFailed()

registerProgress

public static void registerProgress(WOSession session,
                                    AjaxProgress progress)

Register a progress object in the registry. Cover method that calls through to the AjaxProgress implementation to maintain backwards compatibility.

Parameters:

session - the session

progress - the progress object to register

unregisterProgress

public static void unregisterProgress(WOSession session,
                                      AjaxProgress progress)

Unregister a progress object from the registry. Cover method that calls through to the AjaxProgress implementation to maintain backwards compatibility.

Parameters:

session - the session

progress - the progress object to unregister

progress

public static AjaxProgress progress(WOSession session,
                                    String id)

Returns the progress object with the given id (or null if one does not exist). Cover method that calls through to the AjaxProgress implementation to maintain backwards compatibility.

Parameters:

session - the session

id - the id of the progress to retrieve

Returns:

the matching progess object (or null)