AjaxProgressBar Class Reference

Inherits com::webobjects::appserver::WOComponent.

Collaboration diagram for AjaxProgressBar:

[legend]

List of all members.

Public Member Functions
	AjaxProgressBar (WOContext context)
void	appendToResponse (WOResponse aResponse, WOContext aContext)
WOActionResults	cancel ()
String	cancelingText ()
String	cancelText ()
Object	displayMaximum ()
Object	displayValue ()
boolean	done ()
String	finishedClass ()
boolean	fireFinishedJavascriptEvents ()
boolean	fireStartedJavascriptEvent ()
String	id ()
boolean	isStarted ()
String	onChange ()
String	percentage ()
AjaxProgress	progress ()
boolean	progressBarVisible ()
String	progressID ()
String	progressOfText ()
WOActionResults	refreshing ()
String	refreshTime ()
String	startingText ()
boolean	synchronizesVariablesWithBindings ()
Static Public Member Functions
static AjaxProgress	progress (WOSession session, String id)
static void	registerProgress (WOSession session, AjaxProgress progress)
static void	unregisterProgress (WOSession session, AjaxProgress progress)
Static Public Attributes
static final String	AJAX_PROGRESSES_KEY = "_ajaxProgresses"
Protected Member Functions
void	_checkForCompletion ()
void	finished ()
void	progressCanceled ()
void	progressFailed ()
void	progressSucceeded ()
Private Attributes
boolean	_completionEventsFired
boolean	_fireFinishedJavascriptEvents
boolean	_fireStartedJavascriptEvent
String	_id
AjaxProgress	_progress
boolean	_running

---

Detailed 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

Author:

mschrag

---

Constructor & Destructor Documentation

AjaxProgressBar

(

WOContext

context

)

---

Member Function Documentation

void _checkForCompletion

(

)

[protected]

void appendToResponse	(	WOResponse	aResponse,
		WOContext	aContext
	)

WOActionResults cancel

(

)

String cancelingText

(

)

String cancelText

(

)

Object displayMaximum

(

)

Object displayValue

(

)

boolean done

(

)

void finished

(

)

[protected]

String finishedClass

(

)

boolean fireFinishedJavascriptEvents

(

)

boolean fireStartedJavascriptEvent

(

)

String id

(

)

boolean isStarted

(

)

String onChange

(

)

String percentage

(

)

static AjaxProgress progress	(	WOSession	session,
		String	id
	)			[static]

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)

AjaxProgress progress

(

)

boolean progressBarVisible

(

)

void progressCanceled

(

)

[protected]

void progressFailed

(

)

[protected]

String progressID

(

)

String progressOfText

(

)

void progressSucceeded

(

)

[protected]

WOActionResults refreshing

(

)

String refreshTime

(

)

static void registerProgress	(	WOSession	session,
		AjaxProgress	progress
	)			[static]

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

String startingText

(

)

boolean synchronizesVariablesWithBindings

(

)

static void unregisterProgress	(	WOSession	session,
		AjaxProgress	progress
	)			[static]

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

---

Member Data Documentation

boolean _completionEventsFired [private]

boolean _fireFinishedJavascriptEvents [private]

boolean _fireStartedJavascriptEvent [private]

String _id [private]

AjaxProgress _progress [private]

boolean _running [private]

final String AJAX_PROGRESSES_KEY = "_ajaxProgresses" [static]

---

The documentation for this class was generated from the following file:

• /opt/source/Wonder/Frameworks/Ajax/Ajax/Sources/er/ajax/AjaxProgressBar.java