Interface WebAPI.SingleFileUploader

All Superinterfaces:
WebAPI.FileSelector
All Known Implementing Classes:
WebAPI.FileUploader
Enclosing class:
WebAPI
public static interface WebAPI.SingleFileUploader extends WebAPI.FileSelector
This class is used for uploading a file. It's associated with a node.
Since:
2018.1.1

  • Property Details

  • Method Details

    • selectedFileProperty

      javafx.beans.property.ReadOnlyStringProperty selectedFileProperty()
      Contains the filename, which was selected by the client.
      Returns:
      the selectedFile property
      See Also:

    • selectedFileSizeProperty

      javafx.beans.property.ReadOnlyIntegerProperty selectedFileSizeProperty()
      Contains the size in bytes of the selected file.
      Returns:
      the selectedFileSize property
      See Also:

    • progressProperty

      javafx.beans.property.ReadOnlyDoubleProperty progressProperty()
      Defines the progress of uploading the file. When the value is 1.0, then the upload is finished.
      Returns:
      the progress property
      See Also:

    • jsFileProperty

      javafx.beans.property.ReadOnlyObjectProperty<WebAPI.JSFile> jsFileProperty()
      The current JSFile, which was selected by the client.
      Returns:
      the jsFile property

    • uploadFile

      void uploadFile()
      Starts uploading the selected file. During upload, the progress property will slowly reach 1.0.

    • uploadedFileProperty

      javafx.beans.property.ReadOnlyObjectProperty<File> uploadedFileProperty()
      Contains the file, which was uploaded. It is null until progress reaches 1.0.
      Returns:
      the uploadedFile property
      See Also:

    • onFileSelectedProperty

      javafx.beans.property.ObjectProperty<WebAPI.FileSelectedListener> onFileSelectedProperty()
      Defines a function to be called when a file is dropped.
      Returns:
      the onFileSelected property
      See Also:

    • shouldCreateObjectURLProperty

      javafx.beans.property.BooleanProperty shouldCreateObjectURLProperty()
      Defines whether an object url should be created.
      Returns:
      the shouldCreateObjectURL property

    • objectURLProperty

      javafx.beans.property.ObjectProperty<JSVariable> objectURLProperty()
      Returns:
      a JSVariable containing the object URL.

    • getUploadedFile

      default File getUploadedFile()
      Gets the value of the property uploadedFile.

    • getSelectedFile

      default String getSelectedFile()
      Gets the value of the property selectedFile.

    • getSelectedFileSize

      default int getSelectedFileSize()
      Gets the value of the property selectedFileSize

    • getProgress

      default double getProgress()
      Gets the value of the property progress.

    • getJSFile

      default WebAPI.JSFile getJSFile()
      Gets the value of the property jsFile.

    • getOnFileSelected

      default WebAPI.FileSelectedListener getOnFileSelected()
      Since:
      2018.1.1 Gets the value of the property onFileSelected

    • setOnFileSelected

      default void setOnFileSelected(WebAPI.FileSelectedListener value)
      Since:
      2018.1.1 Sets the value of the property onFileSelected.