er.attachment.components

Class ERAttachmentFlexibleEditor

java.lang.Object

com.webobjects.appserver.WOElement

com.webobjects.appserver.WOComponent

er.extensions.components.ERXComponent

er.extensions.components.ERXNonSynchronizingComponent

er.attachment.components.ERAttachmentFlexibleEditor

All Implemented Interfaces:

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

public class ERAttachmentFlexibleEditor
extends ERXNonSynchronizingComponent

ERAttachmentFlexibleEditor is a wrapper around ERAttachmentFlexibleUpload and ERAttachmentViewer It provides a one stop shop for editing a to-one relationship between a masterObject and an ERAttachment. Switching back and forth between edit and view modes is handled by ajax updates.

There is one scenario where there is the potential for an orphaned ERAttachment and associated file.

1. User lands on an edit page for the masterObject
2. User selects and successfully uploads a file for the attachment
3. User leaves the masterObject edit page without saving changes

See Also:

Serialized Form

Author:

david

Bindings

Name	Description
masterObject	(required) - Parent object owning the relationship to this attachment
relationshipKey	(required) - Name of the to-one relationship to the attachment
injectDefaultCSS	- inject the default stylesheet from the Ajax framework (defaults to true);
id	- unique identifier for this component (generated if null)
editorEditLabel	- label for the edit button (defaults to "Edit")
editorEditButtonClass	- css class for the edit button (defaults to "Button ObjButton EditObjButton")
editorCancelLabel	- label for the cancel button (defaults to "Cancel")
editorCancelButtonClass	- css class for the cancel button (defaults to "Button ObjButton CancelObjButton")
configurationName	- configuration name for configuring ERAttachment
storageType	- storage type for configuring ERAttachment
viewShowFileName	- show the attachment file name in the view mode (defaults to true)
viewShowAttachmentLink	- if viewShowFilename is true, wrap it with an ERAttachmentLink (defaults to true)
uploadDialogHeaderText	- the text of the upload header (defaults to "Edit Attachment")
viewHeight	- see: {@link ERAttachmentViewer}
viewWidth	- see: {@link ERAttachmentViewer}
viewAllowDownload	- see: {@link ERAttachmentLink}
uploadAllowCancel	- for the following see: {@link ERAttachmentFlexibleUpload}
uploadFinishedFunction	uploadFinishedFunction
uploadCancelButtonClass	uploadCancelButtonClass
uploadCancelLabel	uploadCancelLabel
uploadCanceledAction	uploadCanceledAction
uploadCanceledFunction	uploadCanceledFunction
uploadCancelingText	uploadCancelingText
uploadClearClass	uploadClearClass
uploadFailedAction	uploadFailedAction
uploadFailedFunction	uploadFailedFunction
uploadHeight	uploadHeight
uploadWidth	uploadWidth
uploadMimeType	uploadMimeType
uploadOwnerID	uploadOwnerID
uploadRefreshTime	uploadRefreshTime
uploadSelectFileButtonClass	uploadSelectFileButtonClass
uploadSelectFileLabel	uploadSelectFileLabel
uploadStartedFunction	uploadStartedFunction

Properties

Name	Description
er.attachment.[configurationName].tempFolder	(optional) the temp folder to use for WOFileUploads
er.attachment.tempFolder	(optional) the temp folder to use for WOFileUploads
er.attachment.[configurationName].storageType	er.attachment.[configurationName].storageType
er.attachment.storageType	er.attachment.storageType
er.attachment.[configurationName].width	er.attachment.[configurationName].width
er.attachment.width	er.attachment.width
er.attachment.[configurationName].height	er.attachment.[configurationName].height
er.attachment.height	er.attachment.height

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ERAttachmentFlexibleEditor.Keys

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 org.apache.log4j.Logger	log

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

Method Summary

Modifier and Type	Method and Description
boolean	allowCancel()
boolean	allowDownload()
void	appendToResponse(WOResponse response, WOContext context) Calls ERXNonSynchronizingComponent.resetCachedBindingsInStatefulComponent() prior to super.appendToResponse.
EOEditingContext	attachmentEC() EOEditingContext for the uploaded attachment
String	cancelButtonWrapperID() Unique identifier for the cancel button wrapper div
WOActionResults	cancelEdit() Action bound to the cancel button
WOActionResults	editAttachment() Action bound to the edit button
String	editorCancelButtonClass() The css class for the main cancel button Defaults to "Button ObjButton CancelObjButton"
String	editorCancelLabel() The label for the main cancel button Defaults to "Cancel"
String	editorEditButtonClass() The css class for the main edit button Defaults to "Button ObjButton EditObjButton"
String	editorEditLabel() The label for the main edit button Defaults to "Edit"
WOActionResults	finishedAction()
String	id() Base unique identifier, used to create the other id's in the component
boolean	injectDefaultCSS() Should the component inject the default css in the head of the page
EOEnterpriseObject	masterObject() Getter for the masterObject
ERAttachment	newAttachment()
String	refreshContainerFunction() Function to update the main update container
String	relationshipKey() Getter for the relationhipKey
void	setNewAttachment(ERAttachment a)
boolean	showFileName() Controls whether the file name should be displayed Defaults to true
boolean	showLink() Controls whether the file name should be shown as a link Defaults to true
boolean	showUpload() Controls whether the upload component is shown
String	startedFunction() Function called when the upload starts
String	updateContainerID() Unique identifier for the main update container
String	uploadCancelLabel() The label to apply to the upload components cancel button Defaults to "Cancel Upload"
String	uploadDialogHeaderText() The text to display in the header of the edit box
String	uploadFinishedFunction() Function called when the upload finishes
WOActionResults	uploadSucceededAction() Action called when an upload succeeds
ERAttachment	viewerAttachment() The masterObject's attachment

Methods inherited from class er.extensions.components.ERXNonSynchronizingComponent

invokeAction, resetCachedBindingsInStatefulComponent, synchronizesVariablesWithBindings, takeValuesFromRequest

Methods inherited from class er.extensions.components.ERXComponent

_awakeInContext, _checkAccess, _frameworkName, _includeCSSResources, _includeJavascriptResources, additionalCSSFiles, additionalJavascriptFiles, 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

Field Detail

log

protected final org.apache.log4j.Logger log

Constructor Detail

ERAttachmentFlexibleEditor

public ERAttachmentFlexibleEditor(WOContext context)

Method Detail

appendToResponse

public void appendToResponse(WOResponse response,
                             WOContext context)

Description copied from class: ERXNonSynchronizingComponent

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

Overrides:

appendToResponse in class ERXNonSynchronizingComponent

Parameters:

response - to which we are appending

context - context of the response

editAttachment

public WOActionResults editAttachment()

Action bound to the edit button

Returns:

null

cancelEdit

public WOActionResults cancelEdit()

Action bound to the cancel button

Returns:

null

uploadSucceededAction

public WOActionResults uploadSucceededAction()

Action called when an upload succeeds

Returns:

results of the

finishedAction

public WOActionResults finishedAction()

showUpload

public boolean showUpload()

Controls whether the upload component is shown

Returns:

boolean

newAttachment

public ERAttachment newAttachment()

setNewAttachment

public void setNewAttachment(ERAttachment a)

attachmentEC

public EOEditingContext attachmentEC()

EOEditingContext for the uploaded attachment

Returns:

EOEditingContext

allowCancel

public boolean allowCancel()

uploadCancelLabel

public String uploadCancelLabel()

The label to apply to the upload components cancel button Defaults to "Cancel Upload"

Returns:

String the uploadCancelLabel

viewerAttachment

public ERAttachment viewerAttachment()

The masterObject's attachment

Returns:

ERAttachment

showFileName

public boolean showFileName()

Controls whether the file name should be displayed Defaults to true

Returns:

boolean

showLink

public boolean showLink()

Controls whether the file name should be shown as a link Defaults to true

Returns:

boolean

allowDownload

public boolean allowDownload()

editorEditButtonClass

public String editorEditButtonClass()

The css class for the main edit button Defaults to "Button ObjButton EditObjButton"

Returns:

the editorEditButtonClass

editorCancelButtonClass

public String editorCancelButtonClass()

The css class for the main cancel button Defaults to "Button ObjButton CancelObjButton"

Returns:

the editorCancelButtonClass

editorEditLabel

public String editorEditLabel()

The label for the main edit button Defaults to "Edit"

Returns:

the editorEditLabel

editorCancelLabel

public String editorCancelLabel()

The label for the main cancel button Defaults to "Cancel"

Returns:

the _editorCancelLabel

uploadDialogHeaderText

public String uploadDialogHeaderText()

The text to display in the header of the edit box

Returns:

the uploadDialogHeaderText

masterObject

public EOEnterpriseObject masterObject()

Getter for the masterObject

Returns:

the masterObject

relationshipKey

public String relationshipKey()

Getter for the relationhipKey

Returns:

the relationshipKey

injectDefaultCSS

public boolean injectDefaultCSS()

Should the component inject the default css in the head of the page

Returns:

boolean

id

public String id()

Base unique identifier, used to create the other id's in the component

Returns:

String

updateContainerID

public String updateContainerID()

Unique identifier for the main update container

Returns:

String

cancelButtonWrapperID

public String cancelButtonWrapperID()

Unique identifier for the cancel button wrapper div

Returns:

String

refreshContainerFunction

public String refreshContainerFunction()

Function to update the main update container

Returns:

String

uploadFinishedFunction

public String uploadFinishedFunction()

Function called when the upload finishes

Returns:

String

startedFunction

public String startedFunction()

Function called when the upload starts

Returns:

String