Package io.jmix.ui.widget

Class JmixFileUploadField

java.lang.Object
com.vaadin.server.AbstractClientConnector
com.vaadin.ui.AbstractComponent
com.vaadin.ui.AbstractField<T>
com.vaadin.ui.CustomField<String>
io.jmix.ui.widget.JmixFileUploadField
All Implemented Interfaces:
com.vaadin.data.HasValue<String>, com.vaadin.event.ContextClickEvent.ContextClickNotifier, com.vaadin.event.MethodEventSource, com.vaadin.server.ClientConnector, com.vaadin.server.Sizeable, com.vaadin.shared.Connector, com.vaadin.ui.Component, com.vaadin.ui.Component.Focusable, com.vaadin.ui.Component.HasContextHelp, com.vaadin.ui.HasComponents, Serializable, Iterable<com.vaadin.ui.Component>
Direct Known Subclasses:
AbstractSingleFileUploadField.JmixSingleFileUploadField, WebdavJmixFileUploadField
public class JmixFileUploadField extends com.vaadin.ui.CustomField<String>
See Also:

  • Nested Class Summary

    Nested classes/interfaces inherited from class com.vaadin.server.AbstractClientConnector

    com.vaadin.server.AbstractClientConnector.IncorrectConcurrentAccessHandler

    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.ui.Component

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

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

    com.vaadin.ui.Component.HasContextHelp.ContextHelpIconClickEvent, com.vaadin.ui.Component.HasContextHelp.ContextHelpIconClickListener

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

    com.vaadin.ui.HasComponents.ComponentAttachDetachNotifier, com.vaadin.ui.HasComponents.ComponentAttachEvent, com.vaadin.ui.HasComponents.ComponentAttachListener, com.vaadin.ui.HasComponents.ComponentDetachEvent, com.vaadin.ui.HasComponents.ComponentDetachListener

    Nested classes/interfaces inherited from interface com.vaadin.data.HasValue

    com.vaadin.data.HasValue.ValueChangeEvent<V extends Object>, com.vaadin.data.HasValue.ValueChangeListener<V extends Object>

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

    com.vaadin.server.Sizeable.Unit

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected com.vaadin.ui.Button
    clearButton
     
    protected com.vaadin.ui.CssLayout
    container
     
    protected static final String
    EMPTY_VALUE_STYLENAME
     
    protected static final String
    FILE_UPLOAD_WRAPPER_STYLENAME
     
    protected String
    fileName
     
    protected com.vaadin.ui.Button
    fileNameButton
     
    protected String
    fileNotSelectedMessage
     
    protected boolean
    showClearButton
     
    protected boolean
    showFileName
     
    protected JmixFileUpload
    uploadButton
     
    protected String
    value
     

    Fields inherited from class com.vaadin.ui.AbstractComponent

    componentErrorProvider, DESIGN_ATTR_PLAIN_TEXT, requiredError

    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
    Description
    JmixFileUploadField()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addFileExtensionNotAllowedListener(JmixFileUpload.FileExtensionNotAllowedListener listener)
     
    void
    addFileNameClickListener(com.vaadin.ui.Button.ClickListener clickListener)
     
    void
    addFileSizeLimitExceededListener(JmixFileUpload.FileSizeLimitExceededListener listener)
     
    void
    addUploadFailedListener(JmixFileUpload.FailedListener listener)
     
    void
    addUploadFinishedListener(JmixFileUpload.FinishedListener listener)
     
    void
    addUploadStartedListener(JmixFileUpload.StartedListener listener)
     
    void
    addUploadSucceededListener(JmixFileUpload.SucceededListener listener)
     
    protected JmixFileUpload
    createUploadButton()
     
    protected void
    doSetValue(String presentationValue)
     
    void
    focus()
     
    String
    getClearButtonCaption()
     
    String
    getClearButtonDescription()
     
    String
    getClearButtonIcon()
     
    String
    getFileNotSelectedMessage()
     
    int
    getTabIndex()
     
    String
    getUploadButtonCaption()
     
    String
    getUploadButtonDescription()
     
    String
    getUploadButtonIcon()
     
    String
    getValue()
     
    protected com.vaadin.ui.Component
    initContent()
     
    protected void
    initLayout()
     
    boolean
    isShowClearButton()
     
    boolean
    isShowFileName()
     
    protected void
    onSetInternalValue(Object newValue)
     
    void
    removeClearButtonAction(com.vaadin.ui.Button.ClickListener listener)
     
    void
    removeFileNameClickListener(com.vaadin.ui.Button.ClickListener clickListener)
     
    void
    setAccept(String accept)
     
    void
    setCancelButtonCaption(String cancelButtonCaption)
     
    void
    setClearButtonCaption(String caption)
     
    void
    setClearButtonDescription(String description)
     
    void
    setClearButtonEnabled(boolean enabled)
     
    void
    setClearButtonIcon(com.vaadin.server.Resource icon)
     
    void
    setClearButtonListener(com.vaadin.ui.Button.ClickListener listener)
     
    void
    setDropZone(com.vaadin.ui.Component component)
     
    void
    setDropZonePrompt(String dropZonePrompt)
     
    void
    setFileNameButtonCaption(String title)
     
    void
    setFileNameButtonEnabled(boolean enabled)
     
    void
    setFileNotSelectedMessage(String fileNotSelectedMessage)
     
    void
    setFileSizeLimit(long fileSizeLimit)
     
    void
    setHeight(float height, com.vaadin.server.Sizeable.Unit unit)
     
    void
    setPasteZone(com.vaadin.ui.Component component)
     
    void
    setPermittedExtensions(Set<String> permittedExtensions)
     
    void
    setProgressWindowCaption(String progressWindowCaption)
     
    void
    setReadOnly(boolean readOnly)
     
    void
    setRequiredIndicatorVisible(boolean visible)
     
    void
    setShowClearButton(boolean showClearButton)
     
    void
    setShowFileName(boolean showFileName)
     
    void
    setTabIndex(int tabIndex)
     
    void
    setUnableToUploadFileMessage(String message)
     
    void
    setUploadButtonCaption(String caption)
     
    void
    setUploadButtonDescription(String description)
     
    void
    setUploadButtonEnabled(boolean enabled)
     
    void
    setUploadButtonIcon(com.vaadin.server.Resource icon)
     
    void
    setUploadReceiver(JmixFileUpload.Receiver receiver)
     
    void
    setWidth(float width, com.vaadin.server.Sizeable.Unit unit)
     
    protected void
    updateButtonsVisibility()
     

    Methods inherited from class com.vaadin.ui.CustomField

    attach, getContent, getState, getState, iterator, setFocusDelegate

    Methods inherited from class com.vaadin.ui.AbstractField

    addValueChangeListener, createValueChange, getCustomAttributes, isDifferentValue, isReadOnly, isRequiredIndicatorVisible, readDesign, setValue, setValue, writeDesign

    Methods inherited from class com.vaadin.ui.AbstractComponent

    addContextClickListener, addContextHelpIconClickListener, addListener, addShortcutListener, addStyleName, beforeClientResponse, detach, ensureContextHelpInitialized, findAncestor, fireComponentErrorEvent, fireComponentEvent, fireContextHelpClick, getActionManager, getCaption, getComponentError, getComponentErrorProvider, getContextHelpText, getData, getDebugId, getDescription, getErrorMessage, getHeight, getHeightUnits, getIcon, getId, getJTestId, getLocale, getParent, getPrimaryStyleName, getRequiredError, getStyleName, getWidth, getWidthUnits, isCaptionAsHtml, isConnectorEnabled, isContextHelpTextHtmlEnabled, isEnabled, isOrHasAncestor, isResponsive, isVisible, removeContextClickListener, removeListener, removeShortcutListener, removeStyleName, setCaption, setCaptionAsHtml, setComponentError, setComponentErrorProvider, setContextHelpText, setContextHelpTextHtmlEnabled, setData, setDebugId, setDescription, setDescription, setEnabled, setHeight, setHeightFull, setHeightUndefined, setIcon, setId, setJTestId, setLocale, setParent, setPrimaryStyleName, setRequiredError, setResponsive, setSizeFull, setSizeUndefined, setStyleName, setVisible, setWidth, setWidthFull, setWidthUndefined

    Methods inherited from class com.vaadin.server.AbstractClientConnector

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

    Methods inherited from class java.lang.Object

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

    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.ui.Component

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

    Methods inherited from interface com.vaadin.shared.Connector

    getConnectorId

    Methods inherited from interface com.vaadin.data.HasValue

    clear, getDefaultValidator, getEmptyValue, getOptionalValue, isEmpty

    Methods inherited from interface java.lang.Iterable

    forEach, spliterator

    Methods inherited from interface com.vaadin.server.Sizeable

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

  • Field Details

    • FILE_UPLOAD_WRAPPER_STYLENAME

      protected static final String FILE_UPLOAD_WRAPPER_STYLENAME
      See Also:

    • EMPTY_VALUE_STYLENAME

      protected static final String EMPTY_VALUE_STYLENAME
      See Also:

    • container

      protected com.vaadin.ui.CssLayout container

    • fileNameButton

      protected com.vaadin.ui.Button fileNameButton

    • clearButton

      protected com.vaadin.ui.Button clearButton

    • uploadButton

      protected JmixFileUpload uploadButton

    • showFileName

      protected boolean showFileName

    • showClearButton

      protected boolean showClearButton

    • fileName

      protected String fileName

    • fileNotSelectedMessage

      protected String fileNotSelectedMessage

    • value

      protected String value

  • Constructor Details

    • JmixFileUploadField

      public JmixFileUploadField()

  • Method Details

    • createUploadButton

      protected JmixFileUpload createUploadButton()

    • initContent

      protected com.vaadin.ui.Component initContent()
      Specified by:
      initContent in class com.vaadin.ui.CustomField<String>

    • getFileNotSelectedMessage

      public String getFileNotSelectedMessage()

    • setFileNotSelectedMessage

      public void setFileNotSelectedMessage(String fileNotSelectedMessage)

    • doSetValue

      protected void doSetValue(String presentationValue)
      Specified by:
      doSetValue in class com.vaadin.ui.AbstractField<String>

    • getValue

      public String getValue()

    • onSetInternalValue

      protected void onSetInternalValue(Object newValue)

    • setWidth

      public void setWidth(float width, com.vaadin.server.Sizeable.Unit unit)
      Specified by:
      setWidth in interface com.vaadin.server.Sizeable
      Overrides:
      setWidth in class com.vaadin.ui.CustomField<String>

    • setHeight

      public void setHeight(float height, com.vaadin.server.Sizeable.Unit unit)
      Specified by:
      setHeight in interface com.vaadin.server.Sizeable
      Overrides:
      setHeight in class com.vaadin.ui.CustomField<String>

    • setReadOnly

      public void setReadOnly(boolean readOnly)
      Specified by:
      setReadOnly in interface com.vaadin.data.HasValue<String>
      Overrides:
      setReadOnly in class com.vaadin.ui.AbstractField<String>

    • setRequiredIndicatorVisible

      public void setRequiredIndicatorVisible(boolean visible)
      Specified by:
      setRequiredIndicatorVisible in interface com.vaadin.data.HasValue<String>
      Overrides:
      setRequiredIndicatorVisible in class com.vaadin.ui.AbstractField<String>

    • focus

      public void focus()
      Specified by:
      focus in interface com.vaadin.ui.Component.Focusable
      Overrides:
      focus in class com.vaadin.ui.CustomField<String>

    • updateButtonsVisibility

      protected void updateButtonsVisibility()

    • initLayout

      protected void initLayout()

    • isShowFileName

      public boolean isShowFileName()

    • setShowFileName

      public void setShowFileName(boolean showFileName)

    • setFileNameButtonCaption

      public void setFileNameButtonCaption(@Nullable String title)

    • addFileNameClickListener

      public void addFileNameClickListener(com.vaadin.ui.Button.ClickListener clickListener)

    • removeFileNameClickListener

      public void removeFileNameClickListener(com.vaadin.ui.Button.ClickListener clickListener)

    • setFileNameButtonEnabled

      public void setFileNameButtonEnabled(boolean enabled)

    • setClearButtonEnabled

      public void setClearButtonEnabled(boolean enabled)

    • setUploadButtonEnabled

      public void setUploadButtonEnabled(boolean enabled)

    • setUploadButtonDescription

      public void setUploadButtonDescription(@Nullable String description)

    • getUploadButtonDescription

      @Nullable public String getUploadButtonDescription()

    • setUploadButtonCaption

      public void setUploadButtonCaption(@Nullable String caption)

    • getUploadButtonCaption

      @Nullable public String getUploadButtonCaption()

    • setUploadButtonIcon

      public void setUploadButtonIcon(@Nullable com.vaadin.server.Resource icon)

    • getUploadButtonIcon

      @Nullable public String getUploadButtonIcon()

    • isShowClearButton

      public boolean isShowClearButton()

    • setShowClearButton

      public void setShowClearButton(boolean showClearButton)

    • setClearButtonCaption

      public void setClearButtonCaption(@Nullable String caption)

    • getClearButtonCaption

      @Nullable public String getClearButtonCaption()

    • setClearButtonIcon

      public void setClearButtonIcon(@Nullable com.vaadin.server.Resource icon)

    • getClearButtonIcon

      @Nullable public String getClearButtonIcon()

    • setClearButtonListener

      public void setClearButtonListener(com.vaadin.ui.Button.ClickListener listener)

    • removeClearButtonAction

      public void removeClearButtonAction(com.vaadin.ui.Button.ClickListener listener)

    • setClearButtonDescription

      public void setClearButtonDescription(String description)

    • getClearButtonDescription

      public String getClearButtonDescription()

    • getTabIndex

      public int getTabIndex()
      Specified by:
      getTabIndex in interface com.vaadin.ui.Component.Focusable
      Overrides:
      getTabIndex in class com.vaadin.ui.CustomField<String>

    • setTabIndex

      public void setTabIndex(int tabIndex)
      Specified by:
      setTabIndex in interface com.vaadin.ui.Component.Focusable
      Overrides:
      setTabIndex in class com.vaadin.ui.CustomField<String>

    • setProgressWindowCaption

      public void setProgressWindowCaption(String progressWindowCaption)

    • setUnableToUploadFileMessage

      public void setUnableToUploadFileMessage(String message)

    • setCancelButtonCaption

      public void setCancelButtonCaption(String cancelButtonCaption)

    • setDropZonePrompt

      public void setDropZonePrompt(@Nullable String dropZonePrompt)

    • setFileSizeLimit

      public void setFileSizeLimit(long fileSizeLimit)

    • setUploadReceiver

      public void setUploadReceiver(JmixFileUpload.Receiver receiver)

    • addUploadStartedListener

      public void addUploadStartedListener(JmixFileUpload.StartedListener listener)

    • addUploadFinishedListener

      public void addUploadFinishedListener(JmixFileUpload.FinishedListener listener)

    • addUploadSucceededListener

      public void addUploadSucceededListener(JmixFileUpload.SucceededListener listener)

    • addUploadFailedListener

      public void addUploadFailedListener(JmixFileUpload.FailedListener listener)

    • addFileSizeLimitExceededListener

      public void addFileSizeLimitExceededListener(JmixFileUpload.FileSizeLimitExceededListener listener)

    • addFileExtensionNotAllowedListener

      public void addFileExtensionNotAllowedListener(JmixFileUpload.FileExtensionNotAllowedListener listener)

    • setAccept

      public void setAccept(@Nullable String accept)

    • setDropZone

      public void setDropZone(@Nullable com.vaadin.ui.Component component)

    • setPasteZone

      public void setPasteZone(@Nullable com.vaadin.ui.Component component)

    • setPermittedExtensions

      public void setPermittedExtensions(@Nullable Set<String> permittedExtensions)