com.vaadin.fluent.api

Interface FluentUpload<THIS extends FluentUpload<THIS>>

Type Parameters:

THIS - Self-referential generic THIS

All Superinterfaces:

com.vaadin.server.ClientConnector, com.vaadin.ui.Component, com.vaadin.ui.Component.Focusable, com.vaadin.shared.Connector, com.vaadin.event.ContextClickEvent.ContextClickNotifier, FluentAbstractComponent<THIS>, FluentClientConnector<THIS>, FluentComponent<THIS>, FluentComponent.FluentFocusable<THIS>, FluentContextClickNotifier<THIS>, FluentSizeable<THIS>, Serializable, com.vaadin.server.Sizeable

All Known Implementing Classes:

FUpload

public interface FluentUpload<THIS extends FluentUpload<THIS>>
extends FluentAbstractComponent<THIS>, FluentComponent.FluentFocusable<THIS>

The base interface for fluent versions of Upload

See Also:

Upload

Nested Class Summary

Nested classes/interfaces inherited from interface com.vaadin.fluent.api.FluentComponent

FluentComponent.FluentFocusable<C extends FluentComponent.FluentFocusable<C>>

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 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

Method Summary

Modifier and Type	Method and Description
default THIS	withButtonCaption(String buttonCaption) In addition to the actual file chooser, upload components have button that starts actual upload progress.
default THIS	withChangeListener(com.vaadin.ui.Upload.ChangeListener listener) Adds a filename change event listener
default THIS	withFailedListener(com.vaadin.ui.Upload.FailedListener listener) Adds the upload interrupted event listener.
default THIS	withFinishedListener(com.vaadin.ui.Upload.FinishedListener listener) Adds the upload received event listener.
default THIS	withImmediateMode(boolean immediateMode) Sets the immediate mode of the upload.
default THIS	withProgressListener(com.vaadin.ui.Upload.ProgressListener listener) Adds the upload progress event listener.
default THIS	withStartedListener(com.vaadin.ui.Upload.StartedListener listener) Adds the upload started event listener.
default THIS	withSucceededListener(com.vaadin.ui.Upload.SucceededListener listener) Adds the upload success event listener.

Methods inherited from interface com.vaadin.fluent.api.FluentAbstractComponent

withCaption, withCaptionAsHtml, withComponentError, withData, withDescription, withDescription, withLocale, withResponsive, withShortcutListener, withStyleName

Methods inherited from interface com.vaadin.fluent.api.FluentClientConnector

withAttachListener, withDetachListener

Methods inherited from interface com.vaadin.fluent.api.FluentContextClickNotifier

withContextClickListener

Methods inherited from interface com.vaadin.event.ContextClickEvent.ContextClickNotifier

addContextClickListener, removeContextClickListener

Methods inherited from interface com.vaadin.fluent.api.FluentComponent.FluentFocusable

withTabIndex

Methods inherited from interface com.vaadin.ui.Component.Focusable

focus, getTabIndex, setTabIndex

Methods inherited from interface com.vaadin.fluent.api.FluentComponent

withCaption, withEnabled, withIcon, withId, withParent, withPrimaryStyleName, withStyleName, withStyleName, withVisible

Methods inherited from interface com.vaadin.ui.Component

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

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.fluent.api.FluentSizeable

withFullHeight, withFullSize, withFullWidth, withHeight, withHeight, withSize, withUndefinedHeight, withUndefinedSize, withUndefinedWidth, withWidth, withWidth

Methods inherited from interface com.vaadin.server.Sizeable

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

Method Detail

withChangeListener

default THIS withChangeListener(com.vaadin.ui.Upload.ChangeListener listener)

Adds a filename change event listener

Parameters:

listener - the Listener to add, not null

Returns:

this for method chaining

See Also:

Upload.addChangeListener(ChangeListener)

withFailedListener

default THIS withFailedListener(com.vaadin.ui.Upload.FailedListener listener)

Adds the upload interrupted event listener.

Parameters:

listener - the Listener to be added, not null

Returns:

this for method chaining

See Also:

Upload.addFailedListener(FailedListener)

withFinishedListener

default THIS withFinishedListener(com.vaadin.ui.Upload.FinishedListener listener)

Adds the upload received event listener.

Parameters:

listener - the Listener to be added, not null

Returns:

this for method chaining

See Also:

Upload.addFinishedListener(FinishedListener)

withProgressListener

default THIS withProgressListener(com.vaadin.ui.Upload.ProgressListener listener)

Adds the upload progress event listener.

Parameters:

listener - the progress listener to be added

Returns:

this for method chaining

See Also:

Upload.addProgressListener(ProgressListener)

withStartedListener

default THIS withStartedListener(com.vaadin.ui.Upload.StartedListener listener)

Adds the upload started event listener.

Parameters:

listener - the Listener to be added, not null

Returns:

this for method chaining

See Also:

Upload.addStartedListener(StartedListener)

withSucceededListener

default THIS withSucceededListener(com.vaadin.ui.Upload.SucceededListener listener)

Adds the upload success event listener.

Parameters:

listener - the Listener to be added, not null

Returns:

this for method chaining

See Also:

Upload.addSucceededListener(SucceededListener)

withButtonCaption

default THIS withButtonCaption(String buttonCaption)

In addition to the actual file chooser, upload components have button that starts actual upload progress. This method is used to set text in that button.

In case the button text is set to null, the button is hidden. In this case developer must explicitly initiate the upload process with Upload.submitUpload().

In case the Upload is used in immediate mode using Upload.setImmediateMode(boolean), the file choose (html input with type "file") is hidden and only the button with this text is shown.

Note the string given is set as is to the button. HTML formatting is not stripped. Be sure to properly validate your value according to your needs.

Parameters:

buttonCaption - text for upload components button.

Returns:

this for method chaining

See Also:

Upload.setButtonCaption(String)

withImmediateMode

default THIS withImmediateMode(boolean immediateMode)

Sets the immediate mode of the upload.

If the upload is in immediate mode, the file upload is started immediately after the user has selected the file.

If the upload is not in immediate mode, after selecting the file the user must click another button to start the upload.

The default mode of an Upload component is immediate.

Parameters:

immediateMode - true for immediate mode, false for not

Returns:

this for method chaining

See Also:

Upload.setImmediateMode(boolean)