Module one.jpro.platform.file

Package one.jpro.platform.file.dropper

Class NativeFileDropper

java.lang.Object

one.jpro.platform.file.dropper.NativeFileDropper

All Implemented Interfaces:

javafx.event.EventTarget, FileDropper, MultipleFileSelector

public class NativeFileDropper
extends Object

Represents a FileDropper implementation for JavaFX desktop/mobile applications. This class extends the BaseFileDropper class and specializes it for selecting files from the native file system.

Author:

Besmir Beqiri, Indrit Beqiri

Property Summary

Properties

Type	Property	Description
final javafx.beans.property.ObjectProperty<ExtensionFilter>	extensionFilter	Defines the property for the extension filter.
javafx.beans.property.ReadOnlyBooleanProperty	filesDragOver	Defines the property for the files drag over state.
final javafx.beans.property.ObjectProperty<javafx.event.EventHandler<FileDragEvent>>	onDragEntered	Event handler invoked when file dragging gesture enters the target node.
final javafx.beans.property.ObjectProperty<javafx.event.EventHandler<FileDragEvent>>	onDragExited	Event handler invoked when file dragging gesture exits the target node.
javafx.beans.property.ObjectProperty<Consumer<List<? extends FileSource>>>	onFilesSelected	Defines the handler to be called when the user selects files.
javafx.beans.property.ObjectProperty<javafx.scene.control.SelectionMode>	selectionMode	Defines the selection mode.

Constructor Summary

Constructors

Constructor	Description
NativeFileDropper(javafx.scene.Node node)

Method Summary

Modifier and Type	Method	Description
javafx.event.EventDispatchChain	buildEventDispatchChain(javafx.event.EventDispatchChain tail)
final javafx.beans.property.ObjectProperty<ExtensionFilter>	extensionFilterProperty()	Defines the property for the extension filter.
javafx.beans.property.ReadOnlyBooleanProperty	filesDragOverProperty()	Defines the property for the files drag over state.
final ExtensionFilter	getExtensionFilter()	Gets the extension filter which is currently used.
javafx.scene.Node	getNode()	Returns the target node for this file dropper.
final javafx.event.EventHandler<FileDragEvent>	getOnDragEntered()	Retrieves the event handler to be called when file dragging gesture enters the target node.
final javafx.event.EventHandler<FileDragEvent>	getOnDragExited()	Retrieves the event handler to be called when file dragging gesture exits the target node.
Consumer<List<? extends FileSource>>	getOnFilesSelected()	Gets the handler to be called when the user selects files.
final javafx.scene.control.SelectionMode	getSelectionMode()	Returns the selection mode.
boolean	isFilesDragOver()	Gets the value of the filesDragOver property.
final javafx.beans.property.ObjectProperty<javafx.event.EventHandler<FileDragEvent>>	onDragEnteredProperty()	Event handler invoked when file dragging gesture enters the target node.
final javafx.beans.property.ObjectProperty<javafx.event.EventHandler<FileDragEvent>>	onDragExitedProperty()	Event handler invoked when file dragging gesture exits the target node.
javafx.beans.property.ObjectProperty<Consumer<List<? extends FileSource>>>	onFilesSelectedProperty()	Defines the handler to be called when the user selects files.
javafx.beans.property.ObjectProperty<javafx.scene.control.SelectionMode>	selectionModeProperty()	Defines the selection mode.
final void	setExtensionFilter(ExtensionFilter filter)	Sets the extension filter which is currently used.
final void	setOnDragEntered(javafx.event.EventHandler<FileDragEvent> value)	Sets the event handler to be called when file dragging gesture enters the target node.
final void	setOnDragExited(javafx.event.EventHandler<FileDragEvent> value)	Sets the event handler to be called when file dragging gesture enters the target node.
void	setOnFilesSelected(Consumer<List<? extends FileSource>> value)	Sets the handler to be called when the user selects files.
final void	setSelectionMode(javafx.scene.control.SelectionMode value)	Sets the selection mode.

Methods inherited from class java.lang.Object

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

Property Details

filesDragOver

public javafx.beans.property.ReadOnlyBooleanProperty filesDragOverProperty

Returns:

the filesDragOver property

See Also:

• isFilesDragOver()
• filesDragOverProperty()

extensionFilter

public final javafx.beans.property.ObjectProperty<ExtensionFilter> extensionFilterProperty

Specified by:

extensionFilterProperty in interface FileDropper

Returns:

the extensionFilter property

See Also:

• FileDropper.getExtensionFilter()
• FileDropper.setExtensionFilter(ExtensionFilter)
• FileDropper.extensionFilterProperty()

selectionMode

public javafx.beans.property.ObjectProperty<javafx.scene.control.SelectionMode> selectionModeProperty

Specified by:

selectionModeProperty in interface MultipleFileSelector

Returns:

the selectionMode property

See Also:

• MultipleFileSelector.getSelectionMode()
• MultipleFileSelector.setSelectionMode(SelectionMode)
• MultipleFileSelector.selectionModeProperty()

onDragEntered

public final javafx.beans.property.ObjectProperty<javafx.event.EventHandler<FileDragEvent>> onDragEnteredProperty

Specified by:

onDragEnteredProperty in interface FileDropper

Returns:

the onDragEntered property

See Also:

• FileDropper.getOnDragEntered()
• FileDropper.setOnDragEntered(EventHandler)
• FileDropper.onDragEnteredProperty()

onDragExited

public final javafx.beans.property.ObjectProperty<javafx.event.EventHandler<FileDragEvent>> onDragExitedProperty

Specified by:

onDragExitedProperty in interface FileDropper

Returns:

the onDragExited property

See Also:

• FileDropper.getOnDragExited()
• FileDropper.setOnDragExited(EventHandler)
• FileDropper.onDragExitedProperty()

onFilesSelected

public javafx.beans.property.ObjectProperty<Consumer<List<? extends FileSource>>> onFilesSelectedProperty

Specified by:

onFilesSelectedProperty in interface MultipleFileSelector

Returns:

the onFilesSelected property

See Also:

• MultipleFileSelector.getOnFilesSelected()
• MultipleFileSelector.setOnFilesSelected(Consumer)
• MultipleFileSelector.onFilesSelectedProperty()

Constructor Details

NativeFileDropper

public NativeFileDropper(javafx.scene.Node node)

Method Details

isFilesDragOver

public boolean isFilesDragOver()

Gets the value of the filesDragOver property.

Property description:

Returns:

the value of the filesDragOver property

See Also:

• filesDragOverProperty()

filesDragOverProperty

public javafx.beans.property.ReadOnlyBooleanProperty filesDragOverProperty()

Description copied from interface: FileDropper

Defines the property for the files drag over state.

Returns:

the filesDragOver property

See Also:

• isFilesDragOver()

getNode

public javafx.scene.Node getNode()

Description copied from interface: FileDropper

Returns the target node for this file dropper.

Specified by:

getNode in interface FileDropper

Returns:

the target node for this file dropper.

getExtensionFilter

public final ExtensionFilter getExtensionFilter()

Description copied from interface: FileDropper

Gets the extension filter which is currently used.

Specified by:

getExtensionFilter in interface FileDropper

Returns:

the extension filter or null if no extension

setExtensionFilter

public final void setExtensionFilter(ExtensionFilter filter)

Description copied from interface: FileDropper

Sets the extension filter which is currently used.

Specified by:

setExtensionFilter in interface FileDropper

Parameters:

filter - the extension filter

extensionFilterProperty

public final javafx.beans.property.ObjectProperty<ExtensionFilter> extensionFilterProperty()

Description copied from interface: FileDropper

Defines the property for the extension filter.

Specified by:

extensionFilterProperty in interface FileDropper

Returns:

the extensionFilter property

See Also:

• FileDropper.getExtensionFilter()
• FileDropper.setExtensionFilter(ExtensionFilter)

getSelectionMode

public final javafx.scene.control.SelectionMode getSelectionMode()

Description copied from interface: MultipleFileSelector

Returns the selection mode.

The default value is SelectionMode.SINGLE.

Specified by:

getSelectionMode in interface MultipleFileSelector

Returns:

the selection mode of the file dialog

setSelectionMode

public final void setSelectionMode(javafx.scene.control.SelectionMode value)

Description copied from interface: MultipleFileSelector

Sets the selection mode.

Specified by:

setSelectionMode in interface MultipleFileSelector

Parameters:

value - The selection mode to be set. This should be one of the values defined in the SelectionMode enumeration. Possible values are SelectionMode.SINGLE or SelectionMode.MULTIPLE.

selectionModeProperty

public javafx.beans.property.ObjectProperty<javafx.scene.control.SelectionMode> selectionModeProperty()

Description copied from interface: MultipleFileSelector

Defines the selection mode. The selection mode determines how the file dialog allows the user to select files.

Specified by:

selectionModeProperty in interface MultipleFileSelector

Returns:

the selectionMode property

See Also:

• MultipleFileSelector.getSelectionMode()
• MultipleFileSelector.setSelectionMode(SelectionMode)

getOnDragEntered

public final javafx.event.EventHandler<FileDragEvent> getOnDragEntered()

Description copied from interface: FileDropper

Retrieves the event handler to be called when file dragging gesture enters the target node.

Specified by:

getOnDragEntered in interface FileDropper

Returns:

the event handler or null.

setOnDragEntered

public final void setOnDragEntered(javafx.event.EventHandler<FileDragEvent> value)

Description copied from interface: FileDropper

Sets the event handler to be called when file dragging gesture enters the target node.

Specified by:

setOnDragEntered in interface FileDropper

Parameters:

value - the event handler or null.

onDragEnteredProperty

public final javafx.beans.property.ObjectProperty<javafx.event.EventHandler<FileDragEvent>> onDragEnteredProperty()

Description copied from interface: FileDropper

Event handler invoked when file dragging gesture enters the target node.

Specified by:

onDragEnteredProperty in interface FileDropper

Returns:

the onDragEntered property

See Also:

• FileDropper.getOnDragEntered()
• FileDropper.setOnDragEntered(EventHandler)

getOnDragExited

public final javafx.event.EventHandler<FileDragEvent> getOnDragExited()

Description copied from interface: FileDropper

Retrieves the event handler to be called when file dragging gesture exits the target node.

Specified by:

getOnDragExited in interface FileDropper

Returns:

the event handler or null.

setOnDragExited

public final void setOnDragExited(javafx.event.EventHandler<FileDragEvent> value)

Description copied from interface: FileDropper

Sets the event handler to be called when file dragging gesture enters the target node.

Specified by:

setOnDragExited in interface FileDropper

Parameters:

value - the event handler or null.

onDragExitedProperty

public final javafx.beans.property.ObjectProperty<javafx.event.EventHandler<FileDragEvent>> onDragExitedProperty()

Description copied from interface: FileDropper

Event handler invoked when file dragging gesture exits the target node.

Specified by:

onDragExitedProperty in interface FileDropper

Returns:

the onDragExited property

See Also:

• FileDropper.getOnDragExited()
• FileDropper.setOnDragExited(EventHandler)

getOnFilesSelected

public Consumer<List<? extends FileSource>> getOnFilesSelected()

Description copied from interface: MultipleFileSelector

Gets the handler to be called when the user selects files.

Specified by:

getOnFilesSelected in interface MultipleFileSelector

Returns:

the event handler or null.

setOnFilesSelected

public void setOnFilesSelected(Consumer<List<? extends FileSource>> value)

Description copied from interface: MultipleFileSelector

Sets the handler to be called when the user selects files.

Specified by:

setOnFilesSelected in interface MultipleFileSelector

Parameters:

value - the event handler or null.

onFilesSelectedProperty

public javafx.beans.property.ObjectProperty<Consumer<List<? extends FileSource>>> onFilesSelectedProperty()

Description copied from interface: MultipleFileSelector

Defines the handler to be called when the user selects files. The handler returns the selected files or null if no file has been selected.

Specified by:

onFilesSelectedProperty in interface MultipleFileSelector

Returns:

the onFilesSelected property

See Also:

• MultipleFileSelector.getOnFilesSelected()
• MultipleFileSelector.setOnFilesSelected(Consumer)

buildEventDispatchChain

public javafx.event.EventDispatchChain buildEventDispatchChain(javafx.event.EventDispatchChain tail)

Specified by:

buildEventDispatchChain in interface javafx.event.EventTarget