Module jpro.webapi
Package com.jpro.webapi

Interface WebAPI.FileSelector

All Known Subinterfaces:
WebAPI.MultiFileUploader, WebAPI.SingleFileUploader
All Known Implementing Classes:
WebAPI.FileUploader
Enclosing class:
WebAPI
public static interface WebAPI.FileSelector

  • Property Summary

    Properties
    Type
    Property
    Description
    javafx.beans.property.ReadOnlyBooleanProperty
    fileDragOver
    This value changes to true, when the cursor is dragging a file and is above the associated node.
    javafx.beans.property.BooleanProperty
    selectFileOnClick
    When true, clicking the node will open a file chooser.
    javafx.beans.property.BooleanProperty
    selectFileOnDrop
    When true, dropping a file over this node selects the dropped file.
    javafx.beans.property.ObjectProperty<javafx.scene.control.SelectionMode>
    selectionMode
    Defines the selection mode of the file chooser.

  • Method Summary

    Modifier and Type
    Method
    Description
    javafx.beans.property.ReadOnlyBooleanProperty
    fileDragOverProperty()
    This value changes to true, when the cursor is dragging a file and is above the associated node.
    default boolean
    getFileDragOver()
    Gets the value of the property fileDragOver.
    javafx.collections.ObservableList<String>
    getFilesDragOverTypes()
    The MIME types of the files which are currently dragged above the node.
    default boolean
    getSelectFileOnClick()
    Gets the value of the property selectFileOnClick
    default boolean
    getSelectFileOnDrop()
    Gets the value of the property selectFileOnDrop
    default javafx.scene.control.SelectionMode
    getSelectionMode()
    Gets the value of the property selectionMode.
    javafx.beans.property.BooleanProperty
    selectFileOnClickProperty()
    When true, clicking the node will open a file chooser.
    javafx.beans.property.BooleanProperty
    selectFileOnDropProperty()
    When true, dropping a file over this node selects the dropped file.
    javafx.beans.property.ObjectProperty<javafx.scene.control.SelectionMode>
    selectionModeProperty()
    Defines the selection mode of the file chooser.
    default void
    setSelectFileOnClick(Boolean value)
    Sets the value of the property selectFileOnClick.
    default void
    setSelectFileOnDrop(Boolean value)
    Sets the value of the property selectFileOnDrop.
    default void
    setSelectionMode(javafx.scene.control.SelectionMode value)
    Sets the value of the property selectionMode.
    javafx.collections.ObservableList<String>
    supportedExtensions()
    Makes sure only files are selectable, which filename ends with at least one of the Strings.

  • Property Details

    • selectFileOnDrop

      javafx.beans.property.BooleanProperty selectFileOnDropProperty
      When true, dropping a file over this node selects the dropped file.
      See Also:

    • fileDragOver

      javafx.beans.property.ReadOnlyBooleanProperty fileDragOverProperty
      This value changes to true, when the cursor is dragging a file and is above the associated node.
      See Also:

    • selectFileOnClick

      javafx.beans.property.BooleanProperty selectFileOnClickProperty
      When true, clicking the node will open a file chooser.
      See Also:

    • selectionMode

      javafx.beans.property.ObjectProperty<javafx.scene.control.SelectionMode> selectionModeProperty
      Defines the selection mode of the file chooser. The default value is SelectionMode.SINGLE.
      Since:
      2023.3.0
      See Also:

  • Method Details

    • selectFileOnDropProperty

      javafx.beans.property.BooleanProperty selectFileOnDropProperty()
      When true, dropping a file over this node selects the dropped file.
      See Also:

    • fileDragOverProperty

      javafx.beans.property.ReadOnlyBooleanProperty fileDragOverProperty()
      This value changes to true, when the cursor is dragging a file and is above the associated node.
      See Also:

    • getFilesDragOverTypes

      javafx.collections.ObservableList<String> getFilesDragOverTypes()
      The MIME types of the files which are currently dragged above the node.
      Since:
      2023.3.1

    • selectFileOnClickProperty

      javafx.beans.property.BooleanProperty selectFileOnClickProperty()
      When true, clicking the node will open a file chooser.
      See Also:

    • getFileDragOver

      default boolean getFileDragOver()
      Gets the value of the property fileDragOver.
      Since:
      2018.1.1

    • setSelectFileOnClick

      default void setSelectFileOnClick(Boolean value)
      Sets the value of the property selectFileOnClick.

    • getSelectFileOnClick

      default boolean getSelectFileOnClick()
      Gets the value of the property selectFileOnClick

    • setSelectFileOnDrop

      default void setSelectFileOnDrop(Boolean value)
      Sets the value of the property selectFileOnDrop.

    • getSelectFileOnDrop

      default boolean getSelectFileOnDrop()
      Gets the value of the property selectFileOnDrop

    • supportedExtensions

      javafx.collections.ObservableList<String> supportedExtensions()
      Makes sure only files are selectable, which filename ends with at least one of the Strings. Every entry should start with "." like ".jpg". The file chooser might provide the option to open any file. This is limited to the file chooser and doesn't work with drag and drop due to limitations in the browser. The list is by default empty. If it's empty, then any filename is accepted.
      Since:
      2019.1.1

    • selectionModeProperty

      javafx.beans.property.ObjectProperty<javafx.scene.control.SelectionMode> selectionModeProperty()
      Defines the selection mode of the file chooser. The default value is SelectionMode.SINGLE.
      Since:
      2023.3.0
      See Also:

    • getSelectionMode

      default javafx.scene.control.SelectionMode getSelectionMode()
      Gets the value of the property selectionMode.
      Since:
      2023.3.0

    • setSelectionMode

      default void setSelectionMode(javafx.scene.control.SelectionMode value)
      Sets the value of the property selectionMode.
      Since:
      2023.3.0