er.directtoweb.pages
Class ERD2WProgressPage

java.lang.Object
  com.webobjects.appserver.WOElement
      com.webobjects.appserver.WOComponent
          com.webobjects.directtoweb.D2WComponent
              com.webobjects.directtoweb.D2WPage
                  er.directtoweb.pages.ERD2WPage
                      er.directtoweb.pages.ERD2WMessagePage
                          er.directtoweb.pages.ERD2WProgressPage

All Implemented Interfaces:

com.webobjects.appserver.WOActionResults, com.webobjects.directtoweb.ConfirmPageInterface, com.webobjects.directtoweb.ErrorPageInterface, com.webobjects.directtoweb.generation.DTWGeneration, com.webobjects.directtoweb.InspectPageInterface, com.webobjects.foundation.NSKeyValueCoding, com.webobjects.foundation.NSKeyValueCoding.ErrorHandling, com.webobjects.foundation.NSKeyValueCodingAdditions, com.webobjects.foundation.NSValidation, ERDBranchInterface, ERDErrorPageInterface, ERDMessagePageInterface, ERDUserInfoInterface, ERXComponentActionRedirector.Restorable, ERXExceptionHolder, java.io.Serializable, java.lang.Cloneable

Direct Known Subclasses:

ERD2WProgressPageTemplate

public class ERD2WProgressPage
extends ERD2WMessagePage

Displays progress by using a ERXLongResponse.Task. Very useful for sending mail and the like. You call up this page and give it a long running task. The task is currently responsible for returning the correct page for each stage. Work in progress.

See Also:

Serialized Form

Author:

ak on Wed Feb 04 2004

Nested Class Summary

Nested classes/interfaces inherited from class er.directtoweb.pages.ERD2WPage

ERD2WPage.Keys

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

com.webobjects.appserver.WOComponent._EventLoggingEnabler, com.webobjects.appserver.WOComponent.Event

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

com.webobjects.foundation.NSKeyValueCodingAdditions.DefaultImplementation, com.webobjects.foundation.NSKeyValueCodingAdditions.Utility

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

com.webobjects.foundation.NSKeyValueCoding._BooleanFieldBinding, com.webobjects.foundation.NSKeyValueCoding._BooleanMethodBinding, com.webobjects.foundation.NSKeyValueCoding._FieldBinding, com.webobjects.foundation.NSKeyValueCoding._ForwardingBinding, com.webobjects.foundation.NSKeyValueCoding._KeyBinding, com.webobjects.foundation.NSKeyValueCoding._KeyBindingCreation, com.webobjects.foundation.NSKeyValueCoding._MethodBinding, com.webobjects.foundation.NSKeyValueCoding._NumberFieldBinding, com.webobjects.foundation.NSKeyValueCoding._NumberMethodBinding, com.webobjects.foundation.NSKeyValueCoding._ReflectionKeyBindingCreation, com.webobjects.foundation.NSKeyValueCoding.ErrorHandling, com.webobjects.foundation.NSKeyValueCoding.Null, com.webobjects.foundation.NSKeyValueCoding.UnknownKeyException, com.webobjects.foundation.NSKeyValueCoding.ValueAccessor

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

com.webobjects.foundation.NSValidation._MethodBinding, com.webobjects.foundation.NSValidation._ValidationBinding, com.webobjects.foundation.NSValidation.DefaultImplementation, com.webobjects.foundation.NSValidation.Utility, com.webobjects.foundation.NSValidation.ValidationException

Field Summary

protected ERXLongResponseTask	_longResponseTask holds the task
protected int	_percentCompleted holds the completed percentage

Fields inherited from class er.directtoweb.pages.ERD2WMessagePage

_cancelDelegate, _cancelPage, _exception, _message, _title

Fields inherited from class er.directtoweb.pages.ERD2WPage

_allConfigurations, _branch, _context, _nextPage, _nextPageDelegate, _pageController, _userInfo, errorKeyOrder, errorMessage, errorMessages, keyPathsWithValidationExceptions, validationLog

Fields inherited from class com.webobjects.directtoweb.D2WComponent

_eo, _localContext, currentObjectKey

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

ERD2WProgressPage(com.webobjects.appserver.WOContext context)
Public constructor

Method Summary

ERXLongResponseTask	longResponseTask()
int	percentCompleted()
void	setLongResponseTask(ERXLongResponseTask longResponseTask)
void	setPercentCompleted(int value)
boolean	shouldShowProgressBar()

Methods inherited from class er.directtoweb.pages.ERD2WMessagePage

cancelAction, cancelDelegate, cancelPage, confirmAction, confirmDelegate, confirmPage, exception, formattedMessage, hasCancelPage, hasNextPage, message, nextPageAction, setCancelDelegate, setCancelPage, setConfirmDelegate, setConfirmPage, setException, setMessage, setTitle, showExplanationComponent, title, titleForPage

Methods inherited from class er.directtoweb.pages.ERD2WPage

aggregateEventDurationForCurrentPropertyKey, allConfigurationNames, appendToResponse, awake, branch, branchChoices, branchName, clearTabSectionsContents, clearValidationFailed, clickToOpenEnabled, cssClassForPageContainerElement, cssClassForPropertyKey, cssClassForPropertyName, currentSection, currentSectionKeys, currentTab, d2wComponentNameDebuggingEnabled, d2wContext, d2wCurrentComponentName, d2wDebuggingEnabled, descriptionForResponse, displayVariant, editingContext, errorKeyOrder, errorMessage, errorMessages, hasActualChanges, hasBranchChoices, hasErrors, hasValidationExceptionForPropertyKey, inlineStyleDeclarationForPropertyKey, inlineStyleDeclarationForPropertyName, invokeAction, isEmbedded, isEntityEditable, isEntityReadOnly, isKeyOmitted, isObjectDeleteable, isObjectEditable, isObjectInspectable, isTopLevelPage, latestEntryForCurrentPropertyKey, makeStatsKey, nextPage, nextPageDelegate, nextPageFromDelegate, now, object, pageController, pageWithName, pageWrapperName, sectionsContents, sectionsForCurrentTab, self, setBranch, setCurrentSection, setCurrentTab, setD2wContext, setDataSource, setEditingContext, setErrorMessage, setErrorMessages, setLocalContext, setNextPage, setNextPageDelegate, setObject, setPageController, settings, shouldCollectValidationExceptions, shouldDisplayDetailedPageMetrics, shouldDisplayPageMetricsSummary, shouldPropagateExceptions, shouldSetFailedValidationValue, showCancel, sleep, statsForPage, statsKeyForCurrentPropertyKey, statsKeyPrefix, tabSectionsContents, tabSectionsContentsFromRuleResult, takeValuesFromRequest, urlForCurrentState, userInfo, userPreferencesValueForKey, userPreferencesValueForPageConfigurationKey, validationFailedWithException

Methods inherited from class com.webobjects.directtoweb.D2WPage

alternateRowColor, dataSource, extraBindings, finalize, replacementAssociationForAssociation, setExtraBindings

Methods inherited from class com.webobjects.directtoweb.D2WComponent

allEntities, allowCollapsing, applicationPort, assistantPort, attribute, backgroundColorForHeaderRow, backgroundColorForPage, backgroundColorForTable, backgroundColorForTableDark, backgroundColorForTableLight, color, currentSettings, currentUrl, d2wContextVisibleEntityNamesCountPlus1, defaultRowspan, displayNameForKeyWhenRelationship, displayNameForProperty, displayPropertyKeys, dynamicPages, entity, entityName, formatter, generationReplacementFor, generationReplacementForCurrentObject, hasCustomKey, hasEntity, hasNoColor, homeClicked, homeHref, isEditing, isEntityReadOnly, isLiveAssistantEnabled, isNotBoldAsBoolean, isNotItalicAsBoolean, isPropertyAnAttribute, isWebAssistantActive, isWebAssistantConnected, isWebAssistantEnabled, keyForGenerationReplacementForVariableNamed, keyWhenRelationship, lastUrl, length, localContext, logout, objectPropertyValue, objectPropertyValueIsNonNull, pageTitle, property, propertyKey, propertyValueClassName, relationship, resourcePathURL, sessionID, setCurrentSettings, setDynamicPages, setEntities, setEntity, setEntityName, setPropertyKey, setResourcePathURL, setTask, setTasks, showBanner, showWebAssistant, submitActionName, target, task, tasks, visibleEntityNames

Methods inherited from class com.webobjects.appserver.WOComponent

_associationWithName, _awakeInContext, _childTemplate, _componentDefinition, _componentUnroll, _isPage, _setContext, _setIsPage, _setParent, _setSubcomponent, _sleepInContext, _subcomponentForElementWithID, _templateNameForClass, _unroll, application, baseURL, bindingKeys, canAccessFieldsDirectly, canGetValueForBinding, canSetValueForBinding, clone, context, debugString, ensureAwakeInContext, frameworkName, generateResponse, handleQueryWithUnboundKey, handleTakeValueForUnboundKey, hasBinding, hasSession, isCachingEnabled, isEventLoggingEnabled, isStateless, logString, name, pageWithName, parent, path, pathURL, performParentAction, pullValuesFromParent, pushValuesToParent, reset, session, set_componentUnroll, set_unroll, setCachingEnabled, setValueForBinding, synchronizesVariablesWithBindings, takeValueForKey, takeValueForKeyPath, template, templateWithHTMLString, templateWithName, toString, unableToSetNullForKey, validateTakeValueForKeyPath, validateValueForKey, valueForBinding, valueForKey, valueForKeyPath

Methods inherited from class java.lang.Object

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

Methods inherited from interface er.directtoweb.interfaces.ERDMessagePageInterface

dataSource, nextPageDelegate, object, setDataSource, setNextPageDelegate

Methods inherited from interface com.webobjects.directtoweb.InspectPageInterface

setNextPage, setObject

Methods inherited from interface com.webobjects.directtoweb.ErrorPageInterface

setNextPage

Field Detail

_longResponseTask

protected ERXLongResponseTask _longResponseTask

holds the task

_percentCompleted

protected int _percentCompleted

holds the completed percentage

Constructor Detail

ERD2WProgressPage

public ERD2WProgressPage(com.webobjects.appserver.WOContext context)

Public constructor

Parameters:

context - the context

Method Detail

longResponseTask

public ERXLongResponseTask longResponseTask()

setLongResponseTask

public void setLongResponseTask(ERXLongResponseTask longResponseTask)

shouldShowProgressBar

public boolean shouldShowProgressBar()

percentCompleted

public int percentCompleted()

setPercentCompleted

public void setPercentCompleted(int value)