Module one.jpro.platform.file
Package one.jpro.platform.file.dropper

Interface FileDropper

All Superinterfaces:
javafx.event.EventTarget, MultipleFileSelector
All Known Implementing Classes:
NativeFileDropper, WebFileDropper
public interface FileDropper extends MultipleFileSelector, javafx.event.EventTarget
This interface represents a file dropper that allows users to select and drop files. The implementation of this interface depends on whether the application is running in a browser via JPro server or outside the browser as a desktop application.
Author:
Besmir Beqiri

  • Property Details

  • Method Details

    • create

      static FileDropper create(javafx.scene.Node node)
      Creates a file dropper. If the application is running in a browser via JPro server, then a web version of the file dropper is returned. If the application is not running inside the browser than a desktop version is returned.
      Parameters:
      node - the action node for this file dropper
      Returns:
      a FileDropper object.
      Throws:
      NullPointerException - if the node is null

    • getNode

      javafx.scene.Node getNode()
      Returns the target node for this file dropper.
      Returns:
      the target node for this file dropper.

    • getExtensionFilter

      ExtensionFilter getExtensionFilter()
      Gets the extension filter which is currently used.
      Returns:
      the extension filter or null if no extension

    • setExtensionFilter

      void setExtensionFilter(ExtensionFilter value)
      Sets the extension filter which is currently used.
      Parameters:
      value - the extension filter

    • extensionFilterProperty

      javafx.beans.property.ObjectProperty<ExtensionFilter> extensionFilterProperty()
      Defines the property for the extension filter.
      Returns:
      the extensionFilter property
      See Also:

    • getOnDragEntered

      javafx.event.EventHandler<FileDragEvent> getOnDragEntered()
      Retrieves the event handler to be called when file dragging gesture enters the target node.
      Returns:
      the event handler or null.

    • setOnDragEntered

      void setOnDragEntered(javafx.event.EventHandler<FileDragEvent> value)
      Sets the event handler to be called when file dragging gesture enters the target node.
      Parameters:
      value - the event handler or null.

    • onDragEnteredProperty

      javafx.beans.property.ObjectProperty<javafx.event.EventHandler<FileDragEvent>> onDragEnteredProperty()
      Event handler invoked when file dragging gesture enters the target node.
      Returns:
      the onDragEntered property
      See Also:

    • getOnDragExited

      javafx.event.EventHandler<FileDragEvent> getOnDragExited()
      Retrieves the event handler to be called when file dragging gesture exits the target node.
      Returns:
      the event handler or null.

    • setOnDragExited

      void setOnDragExited(javafx.event.EventHandler<FileDragEvent> value)
      Sets the event handler to be called when file dragging gesture enters the target node.
      Parameters:
      value - the event handler or null.

    • onDragExitedProperty

      javafx.beans.property.ObjectProperty<javafx.event.EventHandler<FileDragEvent>> onDragExitedProperty()
      Event handler invoked when file dragging gesture exits the target node.
      Returns:
      the onDragExited property
      See Also:

    • isFilesDragOver

      boolean isFilesDragOver()
      Returns a boolean value indicating if files are currently being dragged over the target node.
      Returns:
      true if files are currently being dragged over the target node, false otherwise.

    • filesDragOverProperty

      javafx.beans.property.ReadOnlyBooleanProperty filesDragOverProperty()
      Defines the property for the files drag over state.
      Returns:
      the filesDragOver property
      See Also: