org.opencms.ui.components

Class CmsUploadButton

java.lang.Object

com.vaadin.server.AbstractClientConnector

com.vaadin.ui.AbstractComponent

com.vaadin.ui.AbstractFocusable

com.vaadin.ui.Button

org.opencms.ui.components.CmsUploadButton

All Implemented Interfaces:

com.vaadin.event.Action.ShortcutNotifier, com.vaadin.event.ContextClickEvent.ContextClickNotifier, com.vaadin.event.FieldEvents.BlurNotifier, com.vaadin.event.FieldEvents.FocusNotifier, com.vaadin.event.MethodEventSource, com.vaadin.server.ClientConnector, com.vaadin.server.Sizeable, com.vaadin.shared.communication.ServerRpc, com.vaadin.shared.Connector, com.vaadin.ui.Component, com.vaadin.ui.Component.Focusable, java.io.Serializable, I_CmsUploadRpc

public class CmsUploadButton
extends com.vaadin.ui.Button
implements I_CmsUploadRpc

The upload button.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CmsUploadButton.I_UploadListener Upload listener interface.

Nested classes/interfaces inherited from class com.vaadin.ui.Button

com.vaadin.ui.Button.ClickEvent, com.vaadin.ui.Button.ClickListener, com.vaadin.ui.Button.ClickShortcut

Nested classes/interfaces inherited from interface com.vaadin.ui.Component

com.vaadin.ui.Component.ErrorEvent, com.vaadin.ui.Component.Event, com.vaadin.ui.Component.Focusable, com.vaadin.ui.Component.Listener

Nested classes/interfaces inherited from interface com.vaadin.server.ClientConnector

com.vaadin.server.ClientConnector.AttachEvent, com.vaadin.server.ClientConnector.AttachListener, com.vaadin.server.ClientConnector.ConnectorErrorEvent, com.vaadin.server.ClientConnector.DetachEvent, com.vaadin.server.ClientConnector.DetachListener

Nested classes/interfaces inherited from interface com.vaadin.server.Sizeable

com.vaadin.server.Sizeable.Unit

Field Summary

Fields inherited from class com.vaadin.ui.Button

clickShortcut

Fields inherited from class com.vaadin.ui.AbstractComponent

DESIGN_ATTR_PLAIN_TEXT

Fields inherited from interface com.vaadin.server.Sizeable

SIZE_UNDEFINED, UNITS_CM, UNITS_EM, UNITS_EX, UNITS_INCH, UNITS_MM, UNITS_PERCENTAGE, UNITS_PICAS, UNITS_PIXELS, UNITS_POINTS

Constructor Summary

Constructors

Constructor and Description
CmsUploadButton(com.vaadin.server.Resource icon, java.lang.String targetFolderRootPath) Constructor.
CmsUploadButton(java.lang.String targetFolderRootPath) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
void	addUploadListener(CmsUploadButton.I_UploadListener listener) Adds an upload listener.
protected CmsUploadState	getState()
void	onUploadFinished(java.util.List<java.lang.String> uploadedFiles) Called once the upload is finished.
void	removeUploadListener(CmsUploadButton.I_UploadListener listener) Removes the given upload listener.
void	setTargetFolder(java.lang.String targetFolder) Sets the upload target folder.

Methods inherited from class com.vaadin.ui.Button

addClickListener, addListener, click, fireClick, fireClick, getCustomAttributes, getIconAlternateText, getState, isDisableOnClick, isHtmlContentAllowed, readDesign, removeClickListener, removeClickShortcut, removeListener, setClickShortcut, setDisableOnClick, setHtmlContentAllowed, setIcon, setIconAlternateText, writeDesign

Methods inherited from class com.vaadin.ui.AbstractFocusable

addBlurListener, addFocusListener, addListener, addListener, focus, getTabIndex, removeBlurListener, removeFocusListener, removeListener, removeListener, setTabIndex

Methods inherited from class com.vaadin.ui.AbstractComponent

addContextClickListener, addListener, addShortcutListener, addStyleName, attach, beforeClientResponse, detach, findAncestor, fireComponentErrorEvent, fireComponentEvent, getActionManager, getCaption, getComponentError, getData, getDebugId, getDescription, getErrorMessage, getExplicitImmediateValue, getHeight, getHeightUnits, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getWidth, getWidthUnits, isCaptionAsHtml, isConnectorEnabled, isEnabled, isImmediate, isOrHasAncestor, isReadOnly, isResponsive, isVisible, removeContextClickListener, removeListener, removeShortcutListener, removeStyleName, setCaption, setCaptionAsHtml, setComponentError, setData, setDebugId, setDescription, setEnabled, setHeight, setHeight, setHeightUndefined, setIcon, setId, setImmediate, setLocale, setParent, setPrimaryStyleName, setReadOnly, setResponsive, setSizeFull, setSizeUndefined, setStyleName, setStyleName, setVisible, setWidth, setWidth, setWidthUndefined

Methods inherited from class com.vaadin.server.AbstractClientConnector

addAttachListener, addDetachListener, addExtension, addListener, addListener, addListener, addMethodInvocationToQueue, createState, encodeState, equals, fireEvent, getAllChildrenIterable, getConnectorId, getErrorHandler, getExtensions, getListeners, getResource, getRpcManager, getRpcProxy, getSession, getStateType, getUI, handleConnectorRequest, hashCode, hasListeners, isAttached, isThis, markAsDirty, markAsDirtyRecursive, registerRpc, registerRpc, removeAttachListener, removeDetachListener, removeExtension, removeListener, removeListener, removeListener, removeListener, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler, setResource

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vaadin.event.Action.ShortcutNotifier

addShortcutListener, removeShortcutListener

Methods inherited from interface com.vaadin.ui.Component

addListener, addStyleName, attach, getCaption, getDescription, getIcon, getId, getLocale, getParent, getPrimaryStyleName, getStyleName, getUI, isEnabled, isReadOnly, isVisible, removeListener, removeStyleName, setCaption, setEnabled, setIcon, setId, setParent, setPrimaryStyleName, setReadOnly, setStyleName, setVisible

Methods inherited from interface com.vaadin.server.ClientConnector

addAttachListener, addDetachListener, beforeClientResponse, detach, encodeState, getErrorHandler, getExtensions, getRpcManager, getStateType, handleConnectorRequest, isAttached, isConnectorEnabled, markAsDirty, markAsDirtyRecursive, removeAttachListener, removeDetachListener, removeExtension, requestRepaint, requestRepaintAll, retrievePendingRpcCalls, setErrorHandler

Methods inherited from interface com.vaadin.shared.Connector

getConnectorId

Methods inherited from interface com.vaadin.server.Sizeable

getHeight, getHeightUnits, getWidth, getWidthUnits, setHeight, setHeight, setHeightUndefined, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthUndefined

Constructor Detail

CmsUploadButton

public CmsUploadButton(com.vaadin.server.Resource icon,
               java.lang.String targetFolderRootPath)

Constructor.

Parameters:

icon - the button icon

targetFolderRootPath - the target folder path

CmsUploadButton

public CmsUploadButton(java.lang.String targetFolderRootPath)

Constructor.

Parameters:

targetFolderRootPath - the upload target folder root path

Method Detail

addUploadListener

public void addUploadListener(CmsUploadButton.I_UploadListener listener)

Adds an upload listener.

Parameters:

listener - the listener instance

onUploadFinished

public void onUploadFinished(java.util.List<java.lang.String> uploadedFiles)

Description copied from interface: I_CmsUploadRpc

Called once the upload is finished.

Specified by:

onUploadFinished in interface I_CmsUploadRpc

Parameters:

uploadedFiles - the uploaded file root paths

See Also:

I_CmsUploadRpc.onUploadFinished(java.util.List)

removeUploadListener

public void removeUploadListener(CmsUploadButton.I_UploadListener listener)

Removes the given upload listener.

Parameters:

listener - the listener to remove

setTargetFolder

public void setTargetFolder(java.lang.String targetFolder)

Sets the upload target folder.

Parameters:

targetFolder - the upload target

getState

protected CmsUploadState getState()

Overrides:

getState in class com.vaadin.ui.Button

See Also:

AbstractComponent.getState()