org.opencms.ade.upload.client.ui

类 A_CmsUploadDialog

java.lang.Object

com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.Widget

com.google.gwt.user.client.ui.Panel

com.google.gwt.user.client.ui.SimplePanel

com.google.gwt.user.client.ui.PopupPanel

org.opencms.gwt.client.ui.CmsPopup

org.opencms.ade.upload.client.ui.A_CmsUploadDialog

所有已实现的接口:

com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.logical.shared.HasCloseHandlers<com.google.gwt.user.client.ui.PopupPanel>, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.EventPreview, com.google.gwt.user.client.ui.AcceptsOneWidget, com.google.gwt.user.client.ui.HasAnimation, com.google.gwt.user.client.ui.HasOneWidget, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.HasWidgets, com.google.gwt.user.client.ui.HasWidgets.ForIsWidget, com.google.gwt.user.client.ui.IsWidget, com.google.gwt.user.client.ui.SourcesPopupEvents, java.lang.Iterable<com.google.gwt.user.client.ui.Widget>, I_CmsAutoHider, I_CmsUploadDialog

直接已知子类:

CmsUploadDialogFormDataImpl, CmsUploadDialogImpl

public abstract class A_CmsUploadDialog
extends CmsPopup
implements I_CmsUploadDialog

Provides an upload dialog.

从以下版本开始:

8.0.0

嵌套类概要

从类继承的嵌套类/接口 com.google.gwt.user.client.ui.PopupPanel

com.google.gwt.user.client.ui.PopupPanel.PositionCallback

从类继承的嵌套类/接口 com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled

从接口继承的嵌套类/接口 com.google.gwt.user.client.ui.HasWidgets

com.google.gwt.user.client.ui.HasWidgets.ForIsWidget

字段概要

字段

限定符和类型	字段和说明
protected I_CmsUploadContext	m_context The upload context.
protected com.google.gwt.user.client.ui.HTML	m_dragAndDropMessage The drag and drop message.
protected CmsScrollPanel	m_scrollPanel The scroll panel.
protected java.util.List<java.lang.String>	m_uploadedFiles The uploaded file names.

从类继承的字段 org.opencms.gwt.client.ui.CmsPopup

m_closeCommand, m_notificationWidgetInstalled, m_windowWidth

从类继承的字段 com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

构造器概要

构造器

构造器和说明
A_CmsUploadDialog() Default constructor.

方法概要

方法

限定符和类型	方法和说明
com.google.gwt.event.shared.HandlerRegistration	addCloseHandler(com.google.gwt.event.logical.shared.CloseHandler<com.google.gwt.user.client.ui.PopupPanel> handler)
protected void	addFileInput(CmsFileInput fileInput) Adds the given file input field to this dialog.
protected void	addFiles(java.util.List<CmsFileInfo> fileInfos) Adds the given file input field to this dialog.
protected void	cancelUpdateProgress() Cancels the upload progress timer.
protected void	cancelUpload() Cancels the upload.
abstract CmsListInfoBean	createInfoBean(CmsFileInfo file) Creates a bean that can be used for the list item widget.
protected void	createLoadingAnimation(java.lang.String msg) Creates the loading animation HTML and adds is to the content wrapper.
protected void	disableOKButton(java.lang.String disabledReason) Disables the OK button.
protected void	doResize() Required to be called when the content has changed.
protected void	enableOKButton() Enables the OK button.
protected long	getContentLength() Returns the contentLength.
protected com.google.gwt.user.client.ui.FlowPanel	getContentWrapper() Returns the contentWrapper.
abstract java.lang.String	getFileSizeTooLargeMessage(CmsFileInfo file) Returns the massage for too large files.
protected java.util.List<java.lang.String>	getFilesToUnzip(boolean all) Returns the list of file names that have to unziped.
protected java.util.Map<java.lang.String,CmsFileInfo>	getFilesToUpload() Returns the filesToUpload.
protected java.lang.String	getFileText() Returns "files" or "file" depending on the files to upload.
protected java.lang.String	getResourceType(CmsFileInfo file) Returns the resource type name for a given filename.
protected java.lang.String	getTargetFolder() Returns the targetFolder.
protected I_CmsUploadServiceAsync	getUploadService() Returns the upload service instance.
protected java.lang.String	getUploadUri() Returns the upload JSP uri.
protected void	insertUploadForm(com.google.gwt.user.client.ui.FormPanel form) Inserts a hidden form into.
abstract boolean	isTooLarge(CmsFileInfo cmsFileInfo) Returns true if the file is too large, false otherwise.
void	loadAndShow() Loads and shows this dialog.
protected void	onOkClick() The action that is executed if the user clicks on the OK button.
void	parseResponse(java.lang.String results) Parses the upload response of the server and decides what to do.
protected void	proceedWorkflow(CmsUploadFileBean result) Decides how to go on depending on the information of the server response.
protected void	removeDragAndDropMessage() Removes the drag and drop message.
protected void	setContentLength(long contentLength) Sets the contentLength.
protected void	setContentWrapperHeight() Execute to set the content wrapper height.
void	setContext(I_CmsUploadContext context) Sets the upload context.
protected void	setDragAndDropMessage() Displays the 'use drag and drop' / 'no drag and drop available' message.
void	setIsTargetRootPath(boolean isTargetRootPath) Sets the boolean flag to control whether the target folder is interpreted as a root path.
protected void	setSummaryHTML(java.lang.String html) Sets the HTML of the selection summary.
void	setTargetFolder(java.lang.String target) Sets the target folder.
void	showErrorReport(java.lang.String message, java.lang.String stacktrace) Shows the error report.
void	submit() Executes the submit action.
protected void	updateProgress() Retrieves the progress information from the server.
protected void	updateProgressBar(CmsUploadProgessInfo info) Updates the progress bar.
abstract void	updateSummary() Updates the file summary.

从类继承的方法 org.opencms.gwt.client.ui.CmsPopup

add, add, addButton, addButton, addDialogClose, adjustIndex, beginDragging, catchNotifications, center, centerHorizontally, checkIndexBoundsForAccess, checkIndexBoundsForInsertion, clear, continueDragging, createDialogNotificationWidget, doAttachChildren, doDetachChildren, endDragging, getAvailableHeight, getCaption, getChildren, getContainerElement, getWidget, getWidgetCount, getWidgetIndex, getWidgetIndex, getWidth, hasCaption, hide, insert, insert, insertFront, installNotificationWidget, iterator, onBrowserEvent, onDetach, onPreviewNativeEvent, remove, remove, removeAllButtons, removeButton, removePadding, setBackgroundColor, setCaption, setHeight, setHeight, setMainContent, setPixelSize, setPositionFixed, setSize, setSpecialBackgroundClass, setUseAnimation, setWidget, setWidth, setWidth, show, showArrow, wrapWithBorderPadding

从类继承的方法 com.google.gwt.user.client.ui.PopupPanel

addAutoHidePartner, addPopupListener, getGlassElement, getGlassStyleName, getOffsetHeight, getOffsetWidth, getPopupLeft, getPopupTop, getStyleElement, getTitle, hide, isAnimationEnabled, isAutoHideEnabled, isAutoHideOnHistoryEventsEnabled, isGlassEnabled, isModal, isPreviewingAllNativeEvents, isShowing, isVisible, onEventPreview, onKeyDownPreview, onKeyPressPreview, onKeyUpPreview, onUnload, removeAutoHidePartner, removePopupListener, setAnimationEnabled, setAutoHideEnabled, setAutoHideOnHistoryEventsEnabled, setGlassEnabled, setGlassStyleName, setModal, setPopupPosition, setPopupPositionAndShow, setPreviewingAllNativeEvents, setTitle, setVisible, showRelativeTo

从类继承的方法 com.google.gwt.user.client.ui.SimplePanel

getWidget, setWidget

从类继承的方法 com.google.gwt.user.client.ui.Panel

add, adopt, adopt, disown, orphan, remove

从类继承的方法 com.google.gwt.user.client.ui.Widget

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onLoad, removeFromParent, setLayoutData, sinkEvents

从类继承的方法 com.google.gwt.user.client.ui.UIObject

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setElement, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEvent, toString, unsinkEvents

从类继承的方法 java.lang.Object

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

从接口继承的方法 org.opencms.gwt.client.ui.I_CmsAutoHider

addAutoHidePartner, isAutoHideEnabled, isAutoHideOnHistoryEventsEnabled, removeAutoHidePartner, setAutoHideEnabled, setAutoHideOnHistoryEventsEnabled

从接口继承的方法 com.google.gwt.event.shared.HasHandlers

fireEvent

字段详细资料

m_context

protected I_CmsUploadContext m_context

The upload context.

m_dragAndDropMessage

protected com.google.gwt.user.client.ui.HTML m_dragAndDropMessage

The drag and drop message.

m_scrollPanel

protected CmsScrollPanel m_scrollPanel

The scroll panel.

m_uploadedFiles

protected java.util.List<java.lang.String> m_uploadedFiles

The uploaded file names.

构造器详细资料

A_CmsUploadDialog

public A_CmsUploadDialog()

Default constructor.

方法详细资料

addCloseHandler

public com.google.gwt.event.shared.HandlerRegistration addCloseHandler(com.google.gwt.event.logical.shared.CloseHandler<com.google.gwt.user.client.ui.PopupPanel> handler)

指定者:

addCloseHandler 在接口中 com.google.gwt.event.logical.shared.HasCloseHandlers<com.google.gwt.user.client.ui.PopupPanel>

覆盖:

addCloseHandler 在类中 com.google.gwt.user.client.ui.PopupPanel

另请参阅:

PopupPanel.addCloseHandler(com.google.gwt.event.logical.shared.CloseHandler)

createInfoBean

public abstract CmsListInfoBean createInfoBean(CmsFileInfo file)

Creates a bean that can be used for the list item widget.

参数:

file - the info to create the bean for

返回:

a list info bean

getFileSizeTooLargeMessage

public abstract java.lang.String getFileSizeTooLargeMessage(CmsFileInfo file)

Returns the massage for too large files.

参数:

file - the file

返回:

the message

isTooLarge

public abstract boolean isTooLarge(CmsFileInfo cmsFileInfo)

Returns true if the file is too large, false otherwise.

参数:

cmsFileInfo - the file to check

返回:

true if the file is too large, false otherwise

loadAndShow

public void loadAndShow()

Loads and shows this dialog.

parseResponse

public void parseResponse(java.lang.String results)

Parses the upload response of the server and decides what to do.

指定者:

parseResponse 在接口中 I_CmsUploadDialog

参数:

results - a JSON Object

setContext

public void setContext(I_CmsUploadContext context)

Sets the upload context.

参数:

context - the new upload context

setIsTargetRootPath

public void setIsTargetRootPath(boolean isTargetRootPath)

Sets the boolean flag to control whether the target folder is interpreted as a root path.

参数:

isTargetRootPath - true if the target folder should be treated as a root path

setTargetFolder

public void setTargetFolder(java.lang.String target)

Sets the target folder.

参数:

target - the target folder to set

showErrorReport

public void showErrorReport(java.lang.String message,
                   java.lang.String stacktrace)

Shows the error report.

指定者:

showErrorReport 在接口中 I_CmsUploadDialog

参数:

message - the message to show

stacktrace - the stacktrace to show

submit

public void submit()

Executes the submit action.

updateSummary

public abstract void updateSummary()

Updates the file summary.

addFileInput

protected void addFileInput(CmsFileInput fileInput)

Adds the given file input field to this dialog.

参数:

fileInput - the file input field to add

addFiles

protected void addFiles(java.util.List<CmsFileInfo> fileInfos)

Adds the given file input field to this dialog.

参数:

fileInfos - the file info objects

cancelUpdateProgress

protected void cancelUpdateProgress()

Cancels the upload progress timer.

cancelUpload

protected void cancelUpload()

Cancels the upload.

createLoadingAnimation

protected void createLoadingAnimation(java.lang.String msg)

Creates the loading animation HTML and adds is to the content wrapper.

参数:

msg - the message to display below the animation

disableOKButton

protected void disableOKButton(java.lang.String disabledReason)

Disables the OK button.

参数:

disabledReason - the reason for disabling the OK button

doResize

protected void doResize()

Required to be called when the content has changed.

enableOKButton

protected void enableOKButton()

Enables the OK button.

getContentLength

protected long getContentLength()

Returns the contentLength.

返回:

the contentLength

getContentWrapper

protected com.google.gwt.user.client.ui.FlowPanel getContentWrapper()

Returns the contentWrapper.

返回:

the contentWrapper

getFilesToUnzip

protected java.util.List<java.lang.String> getFilesToUnzip(boolean all)

Returns the list of file names that have to unziped.

参数:

all - true if the returned list should contain those filenames that are not inside the map of files to upload. false only those filenames are returned that are also inside the map of files to upload

返回:

the list of file names that have to unziped

getFilesToUpload

protected java.util.Map<java.lang.String,CmsFileInfo> getFilesToUpload()

Returns the filesToUpload.

返回:

the filesToUpload

getFileText

protected java.lang.String getFileText()

Returns "files" or "file" depending on the files to upload.

返回:

"files" or "file" depending on the files to upload

getResourceType

protected java.lang.String getResourceType(CmsFileInfo file)

Returns the resource type name for a given filename.

参数:

file - the file info

返回:

the resource type name

getTargetFolder

protected java.lang.String getTargetFolder()

Returns the targetFolder.

返回:

the targetFolder

getUploadService

protected I_CmsUploadServiceAsync getUploadService()

Returns the upload service instance.

返回:

the upload service instance

getUploadUri

protected java.lang.String getUploadUri()

Returns the upload JSP uri.

返回:

the upload JSP uri

insertUploadForm

protected void insertUploadForm(com.google.gwt.user.client.ui.FormPanel form)

Inserts a hidden form into.

参数:

form - the form to insert

onOkClick

protected void onOkClick()

The action that is executed if the user clicks on the OK button.

If the selection dialog is currently shown the selected files are checked otherwise the upload is triggered.

proceedWorkflow

protected void proceedWorkflow(CmsUploadFileBean result)

Decides how to go on depending on the information of the server response.

Shows a warning if there is another upload process active (inside the same session).

Otherwise if the list of files to upload contains already existent resources on the VFS or if there are files selected that have invalid file names the overwrite dialog is shown.

Only if there is no other upload process running and none of the selected files is already existent on the VFS the upload is triggered.

参数:

result - the bean that contains the information to evaluate

removeDragAndDropMessage

protected void removeDragAndDropMessage()

Removes the drag and drop message.

setContentLength

protected void setContentLength(long contentLength)

Sets the contentLength.

参数:

contentLength - the contentLength to set

setContentWrapperHeight

protected void setContentWrapperHeight()

Execute to set the content wrapper height.

setDragAndDropMessage

protected void setDragAndDropMessage()

Displays the 'use drag and drop' / 'no drag and drop available' message.

setSummaryHTML

protected void setSummaryHTML(java.lang.String html)

Sets the HTML of the selection summary.

参数:

html - the HTML to set as String

updateProgress

protected void updateProgress()

Retrieves the progress information from the server.

updateProgressBar

protected void updateProgressBar(CmsUploadProgessInfo info)

Updates the progress bar.

参数:

info - the progress info