er.extensions.components

Class ERXDownloadResponse

java.lang.Object

com.webobjects.appserver.WOElement

com.webobjects.appserver.WOComponent

er.extensions.components.ERXDownloadResponse

All Implemented Interfaces:

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

public class ERXDownloadResponse
extends WOComponent

A component that is used to generate a download response. Simply create the component, use appropriate setters for the type of content to be downloaded and return the component from a component action

See Also:

Serialized Form

Author:

kieran 1/27/2006

Bindings

Name	Description
contentDisposition	A string to set the content-disposition header. Defaults to "attachment;filename=\"" + downloadFilename() + "\""
contentType	A string to represents the MIME type (text/plain, application/pdf, etc.) of the file
downloadFilename	A string that represents the name of the file. Defaults to "downloadedfile"
fileContext	An ERXFileContext object that contains a reference to the file, the file name and the MIME type. If you set this binding, you don't need to set the contentType, fileToDownload and downloadFilename bindings.
fileToDownload	A java.io.File object that will be returned in the response

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

Method Summary

Modifier and Type	Method and Description
void	appendToResponse(WOResponse aResponse, WOContext aContext)
void	setContentDisposition(String contentDisposition)
void	setContentType(String contentType)
void	setDownloadFilename(String newDownloadFilename)
void	setFileContext(ERXFileContext fileContext) Convenience method to set file, download filename and content type.
void	setFileToDownload(File aFile)
void	setInputStreamToDownload(InputStream inStream, long contentSize) WO 5.3.3 setter where contentSize is int
String	toString()

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, synchronizesVariablesWithBindings, takeValueForKey, takeValueForKeyPath, takeValuesFromRequest, template, templateWithHTMLString, templateWithHTMLString, templateWithHTMLString, templateWithName, 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

Constructor Detail

ERXDownloadResponse

public ERXDownloadResponse(WOContext context)

Method Detail

setFileContext

public void setFileContext(ERXFileContext fileContext)

Convenience method to set file, download filename and content type.

Parameters:

fileContext -

setDownloadFilename

public void setDownloadFilename(String newDownloadFilename)

setFileToDownload

public void setFileToDownload(File aFile)

Parameters:

aFile - the file to be downloaded.

setInputStreamToDownload

public void setInputStreamToDownload(InputStream inStream,
                                     long contentSize)

WO 5.3.3 setter where contentSize is int

Parameters:

inStream -

contentSize -

appendToResponse

public void appendToResponse(WOResponse aResponse,
                             WOContext aContext)

Overrides:

appendToResponse in class WOComponent

setContentDisposition

public void setContentDisposition(String contentDisposition)

setContentType

public void setContentType(String contentType)

toString

public String toString()

Overrides:

toString in class WOComponent