Package com.hybris.cockpitng.editor.dndfileupload

Class MultiDragAndDropFileUploadEditor

java.lang.Object

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

com.hybris.cockpitng.editor.dndfileupload.AbstractDragAndDropFileUploadEditor<java.util.Collection<FileUploadResult>>

com.hybris.cockpitng.editor.dndfileupload.MultiDragAndDropFileUploadEditor

All Implemented Interfaces:

CockpitEditorRenderer<java.util.Collection<FileUploadResult>>

public class MultiDragAndDropFileUploadEditor
extends AbstractDragAndDropFileUploadEditor<java.util.Collection<FileUploadResult>>

Multi file upload editor. 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 - when set to true upload content will be displayed in single line
• selectedItemsMaxSize - defines number of uploaded elements when list scroll should be shown Listbox.setRows(int). Default value: 5.

Field Summary

Fields

Modifier and Type	Field	Description
protected static int	DEFAULT_MAX_FILE_COUNT
static int	DEFAULT_SELECTED_ITEMS_MAX_SIZE
protected static java.lang.String	EDITOR_CONTAINER_SCLASS
protected static java.lang.String	EDITOR_PREFIX
protected static java.lang.String	FILE_UPLOAD_MAX_FILE_COUNT
protected static java.lang.String	LABEL_DROPCONTENT_TOOLTIP_MULTI
protected static java.lang.String	LABEL_EXCEEDED_MAX_FILES_COUNT
protected static java.lang.String	LABEL_EXCEEDED_MAX_UPLOAD_SIZE
protected static java.lang.String	LABEL_UNSUPPORTED_UPLOAD
protected static java.lang.String	PARAM_MAX_ALLOWED_TOTAL_UPLOAD_SIZE
protected static java.lang.String	PARAM_MAX_FILE_COUNT
protected static java.lang.String	PARAM_SELECTED_ITEMS_MAX_SIZE

Fields inherited from class com.hybris.cockpitng.editor.dndfileupload.AbstractDragAndDropFileUploadEditor

ALLOWED_SIZE_DECIMAL_FORMAT, BYTES_IN_KILOBYTE, DEFAULT_MAX_FILE_SIZE, FILE_UPLOAD_MAX_SIZE, LABEL_DROPCONTENT, LABEL_DROPCONTENT_TOOLTIP, LABEL_UNSUPPORTED_FILETYPE, LABEL_UPLOAD, ON_MAX_FILE_COUNT_EXCEED, PARAM_ACCEPT, PARAM_MAX_SIZE, PARAM_SINGLE_LINE_MODE, UNLIMITED_FILE_SIZE

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

HEADER_LABEL_TOOLTIP, ON_ADD_EVENT, ON_DELETE_EVENT, YW_EDITOR_AREA_LABEL_CONTAINER

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

INITIAL_EDIT_STRING

Constructor Summary

Constructors

Constructor	Description
MultiDragAndDropFileUploadEditor()

Method Summary

Modifier and Type	Method	Description
protected org.zkoss.zk.ui.Component	createDropUpload(org.zkoss.zk.ui.Component dropAnchor, EditorContext<java.util.Collection<FileUploadResult>> context)
protected org.zkoss.zul.Listbox	createUploadedFilesList(EditorContext<java.util.Collection<FileUploadResult>> context, EditorListener<java.util.Collection<FileUploadResult>> listener)
protected java.util.Optional<org.zkoss.zul.Image>	getContentImageWithZoom(org.zkoss.zk.ui.Component container, FileUploadResult fileUploadResult)
protected java.lang.String	getDropAreaConstraintInfo(EditorContext<java.util.Collection<FileUploadResult>> context)
protected java.lang.String	getEditorSclass()
protected long	getMaxAllowedTotalUploadSizeInKilobytes(EditorContext<java.util.Collection<FileUploadResult>> context)
protected int	getMaxFileCount(EditorContext<java.util.Collection<FileUploadResult>> context)
protected int	getSelectedReferencesMaxSize(EditorContext<java.util.Collection<FileUploadResult>> context)
protected java.lang.String	getUpload(EditorContext<java.util.Collection<FileUploadResult>> context)
protected void	onMaxFileCountExceed(org.zkoss.zul.Listbox uploadedList, EditorContext<java.util.Collection<FileUploadResult>> context)
protected void	onUpload(org.zkoss.zul.Listbox uploadedList, org.zkoss.zk.ui.event.UploadEvent event, EditorContext<java.util.Collection<FileUploadResult>> context, EditorListener<java.util.Collection<FileUploadResult>> listener)
void	render(org.zkoss.zk.ui.Component parent, EditorContext<java.util.Collection<FileUploadResult>> context, EditorListener<java.util.Collection<FileUploadResult>> listener)	Creates a new editor component and attaches it to the specified Component component.
protected void	renderUploadedFile(org.zkoss.zul.Listitem item, FileUploadResult data, int index, EditorContext<java.util.Collection<FileUploadResult>> context, java.util.function.BiConsumer<java.lang.Integer,FileUploadResult> onRemoveReference)
protected void	showMaxFileCountExceededMessage(org.zkoss.zk.ui.Component messageAnchor, EditorContext<java.util.Collection<FileUploadResult>> context)
protected void	showTotalAllowedUploadSizeExceededMessage(org.zkoss.zk.ui.Component messageAnchor, EditorContext<java.util.Collection<FileUploadResult>> context)
protected void	showUnsupportedMediaMessage(org.zkoss.zk.ui.Component messageAnchor, EditorContext<java.util.Collection<FileUploadResult>> context)

Methods inherited from class com.hybris.cockpitng.editor.dndfileupload.AbstractDragAndDropFileUploadEditor

addImageZoomPopup, createFileUpload, createUploadContainer, createUploadContainer, extractUploadedData, getCockpitProperties, getContentImage, getContentTypeImage, getMaxFileSize, getObjectPreviewService, isCorrectFileSize, isSingleLineModeEnabled, isUploadedMediaAcceptable, matchContentType, readableFileSize, showUnsupportedMediaMessage, toFileUploadResult

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

Field Detail

DEFAULT_SELECTED_ITEMS_MAX_SIZE

public static final int DEFAULT_SELECTED_ITEMS_MAX_SIZE

See Also:

Constant Field Values

EDITOR_PREFIX

protected static final java.lang.String EDITOR_PREFIX

See Also:

Constant Field Values

EDITOR_CONTAINER_SCLASS

protected static final java.lang.String EDITOR_CONTAINER_SCLASS

See Also:

Constant Field Values

PARAM_SELECTED_ITEMS_MAX_SIZE

protected static final java.lang.String PARAM_SELECTED_ITEMS_MAX_SIZE

See Also:

Constant Field Values

LABEL_UNSUPPORTED_UPLOAD

protected static final java.lang.String LABEL_UNSUPPORTED_UPLOAD

See Also:

Constant Field Values

LABEL_EXCEEDED_MAX_FILES_COUNT

protected static final java.lang.String LABEL_EXCEEDED_MAX_FILES_COUNT

See Also:

Constant Field Values

LABEL_EXCEEDED_MAX_UPLOAD_SIZE

protected static final java.lang.String LABEL_EXCEEDED_MAX_UPLOAD_SIZE

See Also:

Constant Field Values

PARAM_MAX_FILE_COUNT

protected static final java.lang.String PARAM_MAX_FILE_COUNT

See Also:

Constant Field Values

PARAM_MAX_ALLOWED_TOTAL_UPLOAD_SIZE

protected static final java.lang.String PARAM_MAX_ALLOWED_TOTAL_UPLOAD_SIZE

See Also:

Constant Field Values

DEFAULT_MAX_FILE_COUNT

protected static final int DEFAULT_MAX_FILE_COUNT

See Also:

Constant Field Values

FILE_UPLOAD_MAX_FILE_COUNT

protected static final java.lang.String FILE_UPLOAD_MAX_FILE_COUNT

See Also:

Constant Field Values

LABEL_DROPCONTENT_TOOLTIP_MULTI

protected static final java.lang.String LABEL_DROPCONTENT_TOOLTIP_MULTI

See Also:

Constant Field Values

Constructor Detail

MultiDragAndDropFileUploadEditor

public MultiDragAndDropFileUploadEditor()

Method Detail

getEditorSclass

protected java.lang.String getEditorSclass()

Specified by:

getEditorSclass in class AbstractDragAndDropFileUploadEditor<java.util.Collection<FileUploadResult>>

render

public void render(org.zkoss.zk.ui.Component parent,
                   EditorContext<java.util.Collection<FileUploadResult>> context,
                   EditorListener<java.util.Collection<FileUploadResult>> listener)

Description copied from interface: CockpitEditorRenderer

Creates a new editor component and attaches it to the specified Component component.

Parameters:

parent - parent component the editor should be attached to

context - the context for the editor creation

listener - the listener to notify the rest of the world about value changes and other events

onUpload

protected void onUpload(org.zkoss.zul.Listbox uploadedList,
                        org.zkoss.zk.ui.event.UploadEvent event,
                        EditorContext<java.util.Collection<FileUploadResult>> context,
                        EditorListener<java.util.Collection<FileUploadResult>> listener)

onMaxFileCountExceed

protected void onMaxFileCountExceed(org.zkoss.zul.Listbox uploadedList,
                                    EditorContext<java.util.Collection<FileUploadResult>> context)

createUploadedFilesList

protected org.zkoss.zul.Listbox createUploadedFilesList(EditorContext<java.util.Collection<FileUploadResult>> context,
                                                        EditorListener<java.util.Collection<FileUploadResult>> listener)

getSelectedReferencesMaxSize

protected int getSelectedReferencesMaxSize(EditorContext<java.util.Collection<FileUploadResult>> context)

renderUploadedFile

protected void renderUploadedFile(org.zkoss.zul.Listitem item,
                                  FileUploadResult data,
                                  int index,
                                  EditorContext<java.util.Collection<FileUploadResult>> context,
                                  java.util.function.BiConsumer<java.lang.Integer,FileUploadResult> onRemoveReference)

getContentImageWithZoom

protected java.util.Optional<org.zkoss.zul.Image> getContentImageWithZoom(org.zkoss.zk.ui.Component container,
                                                                          FileUploadResult fileUploadResult)

showUnsupportedMediaMessage

protected void showUnsupportedMediaMessage(org.zkoss.zk.ui.Component messageAnchor,
                                           EditorContext<java.util.Collection<FileUploadResult>> context)

showMaxFileCountExceededMessage

protected void showMaxFileCountExceededMessage(org.zkoss.zk.ui.Component messageAnchor,
                                               EditorContext<java.util.Collection<FileUploadResult>> context)

showTotalAllowedUploadSizeExceededMessage

protected void showTotalAllowedUploadSizeExceededMessage(org.zkoss.zk.ui.Component messageAnchor,
                                                         EditorContext<java.util.Collection<FileUploadResult>> context)

createDropUpload

protected org.zkoss.zk.ui.Component createDropUpload(org.zkoss.zk.ui.Component dropAnchor,
                                                     EditorContext<java.util.Collection<FileUploadResult>> context)

Overrides:

createDropUpload in class AbstractDragAndDropFileUploadEditor<java.util.Collection<FileUploadResult>>

getDropAreaConstraintInfo

protected java.lang.String getDropAreaConstraintInfo(EditorContext<java.util.Collection<FileUploadResult>> context)

Overrides:

getDropAreaConstraintInfo in class AbstractDragAndDropFileUploadEditor<java.util.Collection<FileUploadResult>>

Parameters:

context - to allow to read l10n data

Returns:

localized information on allowed file size and number of allowed files (if applicable)

getMaxFileCount

protected int getMaxFileCount(EditorContext<java.util.Collection<FileUploadResult>> context)

Parameters:

context - context object to read configuration

Returns:

maximal number of uploaded files

getMaxAllowedTotalUploadSizeInKilobytes

protected long getMaxAllowedTotalUploadSizeInKilobytes(EditorContext<java.util.Collection<FileUploadResult>> context)

Parameters:

context - context object to read configuration

Returns:

maximal allowed upload size in kilobytes

getUpload

protected java.lang.String getUpload(EditorContext<java.util.Collection<FileUploadResult>> context)

Overrides:

getUpload in class AbstractDragAndDropFileUploadEditor<java.util.Collection<FileUploadResult>>