er.ajax

Class AjaxFileUpload

java.lang.Object

com.webobjects.appserver.WOElement

com.webobjects.appserver.WOComponent

er.ajax.AjaxFileUpload

All Implemented Interfaces:

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

Direct Known Subclasses:

AjaxFlexibleFileUpload

public class AjaxFileUpload
extends WOComponent

AjaxFileUpload provides an Ajax wrapper around the file upload process. This works pretty differently than WOFileUpload. The AjaxFileUpload component itself provides its own form and autosubmits when the user selects a file to upload. The upload runs in a hidden iframe, with Ajax updates occurring in the main window. When the final ajax update occurs after the completion of the upload, the appropriate actions fire. This means that if the user navigates away during the upload, no completion/failure/etc notifications will occur.

See Also:

Serialized Form

Author:

mschrag

Bindings

Name	Description
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
startedFunction	the javascript function to execute when the progress is started
canceledFunction	the javascript function to execute when the upload is canceled
succeededFunction	the javascript function to execute when the upload succeeds
failedFunction	the javascript function to execute when the upload fails
finishedFunction	the javascript function to execute when the upload finishes (succeeded, failed, or canceled)
finishedAction	the action to fire when the upload finishes (cancel, failed, or succeeded)
canceledAction	the action to fire when the upload is canceled
succeededAction	the action to fire when the upload succeeded
failedAction	the action to fire when the upload fails
data	the NSData that will be bound with the contents of the upload
inputStream	will be bound to an input stream on the contents of the upload
outputStream	the output stream to write the contents of the upload to
streamToFilePath	the path to write the upload to, can be a directory
finalFilePath	the final file path of the upload (when streamToFilePath is set or keepTempFile = true)
filePath	the name of the uploaded file
allowCancel	if true, the cancel link is visible
progressBarBeforeStart	if true, the progress bar is visible before the upload is started
progressBarAfterDone	if true, the progress bar is visible after the upload is done
refreshTime	the number of milliseconds to wait between refreshes
keepTempFile	if true, don't delete the temp file that AjaxFileUpload creates
uploadLabel	the label to display on the Upload button ("Upload" by default)
uploadFunctionName	the upload button will instead be a function with the given name
progressOfText	the text to display for the word "of" in the "[size] of [totalsize]" string during upload
mimeType	set from the content-type of the upload header if available
class	the class attribute of the file input
style	the style attribute of the file input
id	the id attribute of the file input
onFileSelected	optional JS code that is called when the file selection changes. To auto-start the upload when a file is selected, set uploadFunctionName to e.g. "startUpload" and onFileSelected to "startUpload()"
uploadProgress	access to the underlying AjaxUploadProgress object

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
protected AjaxUploadProgress	_progress
protected boolean	_triggerUploadStart
protected boolean	_uploadStarted

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
AjaxFileUpload(WOContext context)

Method Summary

Modifier and Type	Method and Description
void	appendToResponse(WOResponse aResponse, WOContext aContext)
String	bytesReadSize()
String	cancelingText()
String	cancelText()
String	id()
boolean	isUploadStarted()
boolean	progressBarAfterDone()
boolean	progressBarBeforeStart()
String	progressBarID()
String	requestHandlerKey()
void	setRequestHandlerKey(String requestHandlerKey)
void	setUploadProgress(AjaxUploadProgress progress)
String	srcUrl()
String	startingText()
WOActionResults	startUpload()
String	startUploadFunctionCall()
String	startUploadName()
String	streamLengthSize()
boolean	synchronizesVariablesWithBindings()
boolean	triggerStartUpload()
WOActionResults	uploadCanceled()
WOActionResults	uploadFailed()
void	uploadFinished()
String	uploadFormID()
String	uploadFrameName()
String	uploadLabel()
AjaxUploadProgress	uploadProgress()
WOActionResults	uploadSucceeded()
String	uploadUrl()

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

_uploadStarted

protected boolean _uploadStarted

_progress

protected AjaxUploadProgress _progress

_triggerUploadStart

protected boolean _triggerUploadStart

Constructor Detail

AjaxFileUpload

public AjaxFileUpload(WOContext context)

Method Detail

setRequestHandlerKey

public void setRequestHandlerKey(String requestHandlerKey)

requestHandlerKey

public String requestHandlerKey()

appendToResponse

public void appendToResponse(WOResponse aResponse,
                             WOContext aContext)

Overrides:

appendToResponse in class WOComponent

synchronizesVariablesWithBindings

public boolean synchronizesVariablesWithBindings()

Overrides:

synchronizesVariablesWithBindings in class WOComponent

uploadLabel

public String uploadLabel()

progressBarBeforeStart

public boolean progressBarBeforeStart()

progressBarAfterDone

public boolean progressBarAfterDone()

setUploadProgress

public void setUploadProgress(AjaxUploadProgress progress)

uploadProgress

public AjaxUploadProgress uploadProgress()

id

public String id()

uploadUrl

public String uploadUrl()

bytesReadSize

public String bytesReadSize()

streamLengthSize

public String streamLengthSize()

uploadFrameName

public String uploadFrameName()

startUploadName

public String startUploadName()

startUploadFunctionCall

public String startUploadFunctionCall()

triggerStartUpload

public boolean triggerStartUpload()

uploadFormID

public String uploadFormID()

progressBarID

public String progressBarID()

startingText

public String startingText()

cancelText

public String cancelText()

cancelingText

public String cancelingText()

startUpload

public WOActionResults startUpload()

isUploadStarted

public boolean isUploadStarted()

uploadFinished

public void uploadFinished()

uploadCanceled

public WOActionResults uploadCanceled()

uploadSucceeded

public WOActionResults uploadSucceeded()

uploadFailed

public WOActionResults uploadFailed()

srcUrl

public String srcUrl()