com.hybris.cockpitng.editor.dndfileupload

Class AbstractDragAndDropFileUploadEditor<T>

java.lang.Object

com.hybris.cockpitng.editors.impl.AbstractCockpitEditorRenderer<T>

com.hybris.cockpitng.editor.dndfileupload.AbstractDragAndDropFileUploadEditor<T>

Type Parameters:

T - type of uploaded reference

All Implemented Interfaces:

CockpitEditorRenderer<T>

Direct Known Subclasses:

DragAndDropFileUploadEditor, MultiDragAndDropFileUploadEditor

public abstract class AbstractDragAndDropFileUploadEditor<T>
extends AbstractCockpitEditorRenderer<T>

Abstract file upload editor which allows to drag and drop content. Accepted params:

• accept - specifies the MIME types of files that the server accepts e.g "audio/|video/|image/*"
• maxsize - defines max file size, if not defined then default system value will be used (property fileUpload.maxSize)
• singleLineMode - param which defines single line mode. This param can be utilised in sub classes

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	DEFAULT_MAX_FILE_SIZE
protected static String	FILE_UPLOAD_MAX_SIZE
protected static String	LABEL_DROPCONTENT
protected static String	LABEL_UNSUPPORTED_FILETYPE
protected static String	LABEL_UPLOAD
protected static String	PARAM_ACCEPT
protected static String	PARAM_MAX_SIZE
protected static String	PARAM_SINGLE_LINE_MODE
protected static int	UNLIMITED_FILE_SIZE

Fields inherited from class com.hybris.cockpitng.editors.impl.AbstractCockpitEditorRenderer

HEADER_LABEL_TOOLTIP, ON_ADD_EVENT, ON_DELETE_EVENT

Fields inherited from interface com.hybris.cockpitng.editors.CockpitEditorRenderer

INITIAL_EDIT_STRING

Constructor Summary

Constructors

Constructor and Description
AbstractDragAndDropFileUploadEditor()

Method Summary

Modifier and Type	Method and Description
protected void	addImageZoomPopup(org.zkoss.zk.ui.Component parent, org.zkoss.zul.Image target)
protected org.zkoss.zk.ui.Component	createDropUpload(org.zkoss.zk.ui.Component dropAnchor, EditorContext<T> context)
protected org.zkoss.zul.Button	createFileUpload(EditorContext<T> context)
protected org.zkoss.zk.ui.Component	createUploadContainer(EditorContext<T> context, org.zkoss.zk.ui.event.EventListener<org.zkoss.zk.ui.event.UploadEvent> onUpload)
protected byte[]	extractUploadedData(org.zkoss.util.media.Media media)
CockpitProperties	getCockpitProperties()
protected Optional<org.zkoss.zul.Image>	getContentImage(FileUploadResult uploadResult)
protected org.zkoss.zul.Image	getContentTypeImage(String contentType, boolean gridPreview)
protected abstract String	getEditorSclass()
protected int	getMaxFileSize(EditorContext<T> context)
ObjectPreviewService	getObjectPreviewService()
protected String	getUpload(EditorContext<T> context)
protected boolean	isCorrectFileSize(int sizeFromEditorParam)
protected boolean	isSingleLineModeEnabled(EditorContext<T> context)
protected boolean	isUploadedMediaAcceptable(org.zkoss.util.media.Media media, EditorContext<T> ctx)
protected boolean	matchContentType(String accept, String contentType)
protected void	showUnsupportedMediaMessage(org.zkoss.zk.ui.Component parent, EditorContext<T> context, org.zkoss.util.media.Media media)
protected Optional<FileUploadResult>	toFileUploadResult(org.zkoss.util.media.Media media)

Methods inherited from class com.hybris.cockpitng.editors.impl.AbstractCockpitEditorRenderer

extractEmbeddedEditor, extractEmbeddedType, findAncestorEditor, findEmbeddedEditors, getInitialEditString, getL10nDecorator

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.hybris.cockpitng.editors.CockpitEditorRenderer

render

Field Detail

PARAM_ACCEPT

protected static final String PARAM_ACCEPT

See Also:

Constant Field Values

PARAM_MAX_SIZE

protected static final String PARAM_MAX_SIZE

See Also:

Constant Field Values

PARAM_SINGLE_LINE_MODE

protected static final String PARAM_SINGLE_LINE_MODE

See Also:

Constant Field Values

LABEL_DROPCONTENT

protected static final String LABEL_DROPCONTENT

See Also:

Constant Field Values

LABEL_UPLOAD

protected static final String LABEL_UPLOAD

See Also:

Constant Field Values

FILE_UPLOAD_MAX_SIZE

protected static final String FILE_UPLOAD_MAX_SIZE

See Also:

Constant Field Values

DEFAULT_MAX_FILE_SIZE

protected static final int DEFAULT_MAX_FILE_SIZE

See Also:

Constant Field Values

UNLIMITED_FILE_SIZE

protected static final int UNLIMITED_FILE_SIZE

See Also:

Constant Field Values

LABEL_UNSUPPORTED_FILETYPE

protected static final String LABEL_UNSUPPORTED_FILETYPE

See Also:

Constant Field Values

Constructor Detail

AbstractDragAndDropFileUploadEditor

public AbstractDragAndDropFileUploadEditor()

Method Detail

getEditorSclass

protected abstract String getEditorSclass()

showUnsupportedMediaMessage

protected void showUnsupportedMediaMessage(org.zkoss.zk.ui.Component parent,
                                           EditorContext<T> context,
                                           org.zkoss.util.media.Media media)

isUploadedMediaAcceptable

protected boolean isUploadedMediaAcceptable(org.zkoss.util.media.Media media,
                                            EditorContext<T> ctx)

matchContentType

protected boolean matchContentType(String accept,
                                   String contentType)

createUploadContainer

protected org.zkoss.zk.ui.Component createUploadContainer(EditorContext<T> context,
                                                          org.zkoss.zk.ui.event.EventListener<org.zkoss.zk.ui.event.UploadEvent> onUpload)

createFileUpload

protected org.zkoss.zul.Button createFileUpload(EditorContext<T> context)

getUpload

protected String getUpload(EditorContext<T> context)

createDropUpload

protected org.zkoss.zk.ui.Component createDropUpload(org.zkoss.zk.ui.Component dropAnchor,
                                                     EditorContext<T> context)

toFileUploadResult

protected Optional<FileUploadResult> toFileUploadResult(org.zkoss.util.media.Media media)

extractUploadedData

protected byte[] extractUploadedData(org.zkoss.util.media.Media media)

getMaxFileSize

protected int getMaxFileSize(EditorContext<T> context)

isCorrectFileSize

protected boolean isCorrectFileSize(int sizeFromEditorParam)

isSingleLineModeEnabled

protected boolean isSingleLineModeEnabled(EditorContext<T> context)

getContentImage

protected Optional<org.zkoss.zul.Image> getContentImage(FileUploadResult uploadResult)

getContentTypeImage

protected org.zkoss.zul.Image getContentTypeImage(String contentType,
                                                  boolean gridPreview)

addImageZoomPopup

protected void addImageZoomPopup(org.zkoss.zk.ui.Component parent,
                                 org.zkoss.zul.Image target)

getObjectPreviewService

public ObjectPreviewService getObjectPreviewService()

getCockpitProperties

public CockpitProperties getCockpitProperties()