er.attachment.components

Class ERDragAndDropUpload

java.lang.Object

com.webobjects.appserver.WOElement

com.webobjects.appserver.WOComponent

er.extensions.components.ERXComponent

er.extensions.components.ERXNonSynchronizingComponent

er.attachment.components.ERDragAndDropUpload

All Implemented Interfaces:

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

public class ERDragAndDropUpload
extends ERXNonSynchronizingComponent

A component designed to allow drag and drop uploads of ERAttachments. Except where otherwise noted, the javascript functions have a single argument: the event.

If you want to include a file selector to the drop-area, then either use includeFileSelector or add one in another location as:
<wo:genericContainer elementName = "input" type = "file" id = "fileSelectorID" multiple = "multiple" />
and bind fileSelectorID to the id.

If you just want a file selector button without the drop area, then use this component with no content and includeFileSelector set to true.
This version also uses a fix from Michael Kondratov for the completeAllFunction in dndupload.js. completeAllFunction now works as advertised.

See Also:

Serialized Form

Author:

Ramsey, Fredrik, Michael Kondratov

Bindings

Name	Description
accept	an array of accepted mimetypes. If no mimetypes are specified, all are accepted. ex. (image/png, image/jpg, text/*)
action	the action to fire when an attachment is uploaded
attachment	the uploaded attachment
completeAllFunction	a javascript function to execute when all dropped files are processed
completeFunction	a javascript function to execute after each uploaded file is processed. This function accepts two args. The first is the event. The second is the file.
configurationName	the configuration name. See the package javadocs for more info.
disabled	if true, the upload component is disabled and only displays component content
editingContext	the editing context where the ERAttachments will be created
enterFunction	a javascript function to execute when dragged files enter the drop target
errorFunction	a javascript function to execute when a file upload error occurs. This function accepts two args. The first is the event. The second is the file.
exitFunction	a javascript function to execute when dragged files exit the drop target
overFunction	a javascript function to execute when dragged files are over the drop target
storageType	the ERAttachment storage type (db, file, s3, cf, ...)
includeFileSelector	a file selector appears at the top of the drag-area.
fileSelectorID	include an id to a file selector outside of the component. Can be used if more custom file selector behavior is needed.

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 er.extensions.components.ERXComponent

_dynamicBindings

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

Method Summary

Modifier and Type	Method and Description
protected String	_frameworkName() Returns the name of this component's framework or "app" if frameworkName() returns null.
NSArray<String>	accept()
boolean	acceptMimetype(String mimetype)
protected NSArray<String>	additionalJavascriptFiles() Returns an array of additional Javascript files for this component, or null (or empty array) if there aren't any.
String	configurationName() The ERAttachment configuration name for the uploaded files.
String	dropTargetID()
EOEditingContext	editingContext() The EOEditingContext where the ERAttachment will be created
String	fileSelectorID()
WOActionResults	invokeAction(WORequest request, WOContext context) Calls ERXNonSynchronizingComponent.resetCachedBindingsInStatefulComponent() prior to super.invokeAction.
String	postURL() The ajax request URL for this component.
String	storageType() The ERAttachment storage type for the uploaded files.
void	takeValuesFromRequest(WORequest request, WOContext context) Calls ERXNonSynchronizingComponent.resetCachedBindingsInStatefulComponent() prior to super.takeValuesFromRequest.

Methods inherited from class er.extensions.components.ERXNonSynchronizingComponent

appendToResponse, resetCachedBindingsInStatefulComponent, synchronizesVariablesWithBindings

Methods inherited from class er.extensions.components.ERXComponent

_awakeInContext, _checkAccess, _includeCSSResources, _includeJavascriptResources, additionalCSSFiles, arrayValueForBinding, arrayValueForBinding, booleanValueForBinding, booleanValueForBinding, booleanValueForBinding, browser, checkAccess, clickToOpenEnabled, componentName, defaultCSSPath, defaultJavascriptPath, dynamicBindings, floatValueForBinding, intValueForBinding, isPageAccessAllowed, localizer, objectValueForBinding, objectValueForBinding, pageWithName, postAppendToResponse, preAppendToResponse, primaryCSSFile, primaryJavascriptFile, reset, shouldCheckAccess, stringValueForBinding, stringValueForBinding, useDefaultComponentCSS, useDefaultComponentJavascript

Methods inherited from class com.webobjects.appserver.WOComponent

__valueForBinding, _associationWithName, _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, isCachingEnabled, isEventLoggingEnabled, isStateless, logString, name, pageWithName, parent, path, pathURL, performParentAction, pullValuesFromParent, pushValuesToParent, session, set_componentUnroll, set_unroll, setCachingEnabled, setValueForBinding, setVariableValueForName, sleep, takeValueForKey, takeValueForKeyPath, 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

Constructor Detail

ERDragAndDropUpload

public ERDragAndDropUpload(WOContext context)

Method Detail

dropTargetID

public String dropTargetID()

Returns:

the dropTargetID

fileSelectorID

public String fileSelectorID()

additionalJavascriptFiles

protected NSArray<String> additionalJavascriptFiles()

Description copied from class: ERXComponent

Returns an array of additional Javascript files for this component, or null (or empty array) if there aren't any. Each path will be prepended with defaultJavascriptPath().

このコンポーネントに必要なオプション Javascript ファイルの配列。無ければ、null (empty array) 各自のパスは defaultJavascriptPath() と合成されます。

Overrides:

additionalJavascriptFiles in class ERXComponent

Returns:

an array of additional Javascript files for this component.

このコンポーネントに必要なオプション Javascript ファイルの配列

_frameworkName

protected String _frameworkName()

Description copied from class: ERXComponent

Returns the name of this component's framework or "app" if frameworkName() returns null.

このコンポーネントのフレームワークを戻します。 frameworkName() が null の場合には "app" が戻ります。

Overrides:

_frameworkName in class ERXComponent

Returns:

the name of this component's framework

このコンポーネントのフレームワーク

postURL

public String postURL()

The ajax request URL for this component.

Returns:

the post URL for the ajax post request

invokeAction

public WOActionResults invokeAction(WORequest request,
                                    WOContext context)

Description copied from class: ERXNonSynchronizingComponent

Calls ERXNonSynchronizingComponent.resetCachedBindingsInStatefulComponent() prior to super.invokeAction.

Overrides:

invokeAction in class ERXNonSynchronizingComponent

Parameters:

request - for which the action is invoked

context - of the request

Returns:

the result of invoking the action

takeValuesFromRequest

public void takeValuesFromRequest(WORequest request,
                                  WOContext context)

Description copied from class: ERXNonSynchronizingComponent

Calls ERXNonSynchronizingComponent.resetCachedBindingsInStatefulComponent() prior to super.takeValuesFromRequest.

Overrides:

takeValuesFromRequest in class ERXNonSynchronizingComponent

Parameters:

request - from which the values will be taken

context - of the request

storageType

public String storageType()

The ERAttachment storage type for the uploaded files.

Returns:

the storageType

configurationName

public String configurationName()

The ERAttachment configuration name for the uploaded files.

Returns:

the configurationName

editingContext

public EOEditingContext editingContext()

The EOEditingContext where the ERAttachment will be created

accept

public NSArray<String> accept()

acceptMimetype

public boolean acceptMimetype(String mimetype)