er.attachment.components

Class ERAttachmentViewer

java.lang.Object

com.webobjects.appserver.WOElement

com.webobjects.appserver.WOComponent

er.extensions.components.ERXComponent

er.extensions.components.ERXNonSynchronizingComponent

er.extensions.components.ERXStatelessComponent

er.attachment.components.viewers.AbstractERAttachmentViewer

er.attachment.components.ERAttachmentViewer

All Implemented Interfaces:

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

public class ERAttachmentViewer
extends AbstractERAttachmentViewer

ERAttachmentViewer provides a way to drop in an embedded viewer for attachments. Viewers can be specified with properties. For example, if you want to define the viewer for PDF's, you can set er.attachment.mimeType.image/pdf.viewer=com.mine.PDFViewer or you can set er.attachment.mimeType.image/*.viewer=com.mine.DefaultImageViewer. To override the default fallback viewer, set er.attachment.mimeType.default.viewer=com.mine.DefaultViewer. If an attachment is unavailable (for instance, if it is in the queue to be sent to S3, but it's not uploaded yet), you can set er.attachment.mimeType.unavailable.viewer=com.mine.UnavailableViewer.

There are defaults provided for several attachment types.

See Also:

Serialized Form

Author:

mschrag

Bindings

Name	Description
attachment	the attachment to display
configurationName	(optional) the configuration name for this attachment (see top level documentation)
class	(optional) the css class
id	(optional) the html element id
style	(optional) the embedded css style
width	(optional) if displaying an image, sets the image width
height	(optional) if displaying an image, sets the image height
target	(optional) specifies where to open the linked attachment

Properties

Name	Description
er.attachment.mimeType.[mimeType].viewer	the class name of the viewer component for the given mime type
er.attachment.mimeType.[globMimeType].viewer	er.attachment.mimeType.[globMimeType].viewer
er.attachment.mimeType.unavailable.viewer	er.attachment.mimeType.unavailable.viewer
er.attachment.mimeType.default.viewer	er.attachment.mimeType.default.viewer

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

Method Summary

Modifier and Type	Method and Description
String	viewerClassName()

Methods inherited from class er.attachment.components.viewers.AbstractERAttachmentViewer

attachment, attachmentUrl, synchronizesVariablesWithBindings

Methods inherited from class er.extensions.components.ERXStatelessComponent

isStateless, reset

Methods inherited from class er.extensions.components.ERXNonSynchronizingComponent

appendToResponse, invokeAction, resetCachedBindingsInStatefulComponent, 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, 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, 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

ERAttachmentViewer

public ERAttachmentViewer(WOContext context)

Method Detail

viewerClassName

public String viewerClassName()

Returns:

the class name of the viewer to use for the given mime type.