Module one.jpro.platform.file

Package one.jpro.platform.file.picker

Class WebFileSavePicker

java.lang.Object

one.jpro.platform.file.picker.WebFileSavePicker

All Implemented Interfaces:

FilePicker, FileSavePicker

public class WebFileSavePicker
extends Object

Represents a FileSavePicker implementation for JavaFX applications running on the web via JPro server. This class specializes for downloading a file and save it in the native file system.

Author:

Besmir Beqiri

Property Summary

Properties

Type	Property	Description
final javafx.beans.property.ObjectProperty<File>	initialDirectory	Defines the initial directory for the displayed file dialog.
final javafx.beans.property.StringProperty	initialFileName	The initial file name for the displayed dialog.
final javafx.beans.property.ObjectProperty<Function<File,CompletableFuture<Void>>>	onFileSelected	Returns the property representing the handler function that is called when the user selects a file.
final javafx.beans.property.ObjectProperty<ExtensionFilter>	selectedExtensionFilter	This property is used to pre-select the extension filter for the next displayed dialog and to read the user-selected extension filter from the dismissed dialog.
final javafx.beans.property.ObjectProperty<File>	tempDirectory	Retrieves the property that represents the temporary directory where the files will be saved before offered for downloading.
final javafx.beans.property.StringProperty	title	The title of the displayed file dialog.

Properties inherited from interface one.jpro.platform.file.picker.FilePicker

initialDirectory, initialFileName, selectedExtensionFilter, title

Constructor Summary

Constructors

Constructor	Description
WebFileSavePicker(javafx.scene.Node node)

Method Summary

Modifier and Type	Method	Description
final javafx.collections.ObservableList<ExtensionFilter>	getExtensionFilters()	Gets the extension filters used in the displayed file dialog.
final File	getInitialDirectory()	The initial directory for the displayed file dialog.
final String	getInitialFileName()	The initial file name for the displayed dialog.
final javafx.scene.Node	getNode()	Returns the associated node for this file picker.
final Function<File,CompletableFuture<Void>>	getOnFileSelected()	Gets the handler function that is called when the user selects a file to save.
final ExtensionFilter	getSelectedExtensionFilter()	Gets the extension filter which is currently selected in the displayed file dialog.
final File	getTempDirectory()	Returns the temporary directory.
final String	getTitle()	Gets the title of the displayed file dialog.
final javafx.beans.property.ObjectProperty<File>	initialDirectoryProperty()	Defines the initial directory for the displayed file dialog.
final javafx.beans.property.StringProperty	initialFileNameProperty()	The initial file name for the displayed dialog.
final javafx.beans.property.ObjectProperty<Function<File,CompletableFuture<Void>>>	onFileSelectedProperty()	Returns the property representing the handler function that is called when the user selects a file.
final javafx.beans.property.ObjectProperty<ExtensionFilter>	selectedExtensionFilterProperty()	This property is used to pre-select the extension filter for the next displayed dialog and to read the user-selected extension filter from the dismissed dialog.
final void	setInitialDirectory(File value)	Sets the initial directory for the displayed file dialog.
final void	setInitialFileName(String value)	Sets the initial file name for the displayed dialog.
final void	setOnFileSelected(Function<File,CompletableFuture<Void>> value)	Sets the handler function to be called when the user selects a file to save.
final void	setSelectedExtensionFilter(ExtensionFilter filter)	Sets the extension filter which is currently selected in the displayed file dialog.
final void	setTempDirectory(File value)	Sets the temporary directory.
final void	setTitle(String value)	Sets the title of the displayed file dialog.
final javafx.beans.property.ObjectProperty<File>	tempDirectoryProperty()	Retrieves the property that represents the temporary directory where the files will be saved before offered for downloading.
final javafx.beans.property.StringProperty	titleProperty()	The title of the displayed file dialog.

Methods inherited from class java.lang.Object

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

Methods inherited from interface one.jpro.platform.file.picker.FilePicker

getExtensionFilters, getInitialDirectory, getInitialFileName, getNode, getSelectedExtensionFilter, getTitle, initialDirectoryProperty, initialFileNameProperty, selectedExtensionFilterProperty, setInitialDirectory, setInitialFileName, setSelectedExtensionFilter, setTitle, titleProperty

Property Details

tempDirectory

public final javafx.beans.property.ObjectProperty<File> tempDirectoryProperty

Retrieves the property that represents the temporary directory where the files will be saved before offered for downloading.

See Also:

• getTempDirectory()
• setTempDirectory(File)
• tempDirectoryProperty()

onFileSelected

public final javafx.beans.property.ObjectProperty<Function<File,CompletableFuture<Void>>> onFileSelectedProperty

Specified by:

onFileSelectedProperty in interface FileSavePicker

Returns:

the property containing the handler function for file selection

See Also:

• FileSavePicker.getOnFileSelected()
• FileSavePicker.setOnFileSelected(Function)
• FileSavePicker.onFileSelectedProperty()

initialFileName

public final javafx.beans.property.StringProperty initialFileNameProperty

Specified by:

initialFileNameProperty in interface FilePicker

Returns:

the initialFileName property

See Also:

• FilePicker.getInitialFileName()
• FilePicker.setInitialFileName(String)
• FilePicker.initialFileNameProperty()

initialDirectory

public final javafx.beans.property.ObjectProperty<File> initialDirectoryProperty

Specified by:

initialDirectoryProperty in interface FilePicker

Returns:

the initialDirectory property

See Also:

• FilePicker.getInitialDirectory()
• FilePicker.setInitialDirectory(File)
• FilePicker.initialDirectoryProperty()

title

public final javafx.beans.property.StringProperty titleProperty

Specified by:

titleProperty in interface FilePicker

Returns:

the title property

See Also:

• FilePicker.getTitle()
• FilePicker.setTitle(String)
• FilePicker.titleProperty()

selectedExtensionFilter

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

Specified by:

selectedExtensionFilterProperty in interface FilePicker

Returns:

the selectedExtensionFilter property

See Also:

• FilePicker.getSelectedExtensionFilter()
• FilePicker.setSelectedExtensionFilter(ExtensionFilter)
• FilePicker.selectedExtensionFilterProperty()

Constructor Details

WebFileSavePicker

public WebFileSavePicker(javafx.scene.Node node)

Method Details

getTempDirectory

public final File getTempDirectory()

Returns the temporary directory.

Returns:

the temporary directory as a File object.

setTempDirectory

public final void setTempDirectory(File value)

Sets the temporary directory.

Parameters:

value - the temporary directory as a File object.

tempDirectoryProperty

public final javafx.beans.property.ObjectProperty<File> tempDirectoryProperty()

Retrieves the property that represents the temporary directory where the files will be saved before offered for downloading.

Returns:

the tempDirectory property

See Also:

• getTempDirectory()
• setTempDirectory(File)

getOnFileSelected

public final Function<File,CompletableFuture<Void>> getOnFileSelected()

Description copied from interface: FileSavePicker

Gets the handler function that is called when the user selects a file to save. The handler accepts a File and returns a CompletableFuture<Void> indicating when the file save operation has completed.

Specified by:

getOnFileSelected in interface FileSavePicker

Returns:

the handler function for file selection, or null if none is set

setOnFileSelected

public final void setOnFileSelected(Function<File,CompletableFuture<Void>> value)

Description copied from interface: FileSavePicker

Sets the handler function to be called when the user selects a file to save. The handler function should accept a File object and return a CompletableFuture<Void> that completes when the save operation is finished.

Specified by:

setOnFileSelected in interface FileSavePicker

Parameters:

value - the handler function to set, or null to remove any existing handler

onFileSelectedProperty

public final javafx.beans.property.ObjectProperty<Function<File,CompletableFuture<Void>>> onFileSelectedProperty()

Description copied from interface: FileSavePicker

Returns the property representing the handler function that is called when the user selects a file. This property allows for observing changes to the handler and for binding. The handler function accepts a File and returns a CompletableFuture<Void> indicating when the file save operation has completed.

Specified by:

onFileSelectedProperty in interface FileSavePicker

Returns:

the onFileSelected property

See Also:

• FileSavePicker.getOnFileSelected()
• FileSavePicker.setOnFileSelected(Function)

getNode

public final javafx.scene.Node getNode()

Description copied from interface: FilePicker

Returns the associated node for this file picker.

Specified by:

getNode in interface FilePicker

Returns:

the associated node for this file picker.

initialFileNameProperty

public final javafx.beans.property.StringProperty initialFileNameProperty()

Description copied from interface: FilePicker

The initial file name for the displayed dialog.

This property is used mostly in the displayed file save dialogs as the initial file name for the file being saved. If set for a file open dialog it will have any impact on the displayed dialog only if the corresponding platform provides support for such property in its file open dialogs.

Specified by:

initialFileNameProperty in interface FilePicker

Returns:

the initialFileName property

See Also:

• FilePicker.getInitialFileName()
• FilePicker.setInitialFileName(String)

getInitialFileName

public final String getInitialFileName()

Description copied from interface: FilePicker

The initial file name for the displayed dialog.

Specified by:

getInitialFileName in interface FilePicker

Returns:

the file name as a string

setInitialFileName

public final void setInitialFileName(String value)

Description copied from interface: FilePicker

Sets the initial file name for the displayed dialog.

Specified by:

setInitialFileName in interface FilePicker

Parameters:

value - the file name

initialDirectoryProperty

public final javafx.beans.property.ObjectProperty<File> initialDirectoryProperty()

Description copied from interface: FilePicker

Defines the initial directory for the displayed file dialog.

Specified by:

initialDirectoryProperty in interface FilePicker

Returns:

the initialDirectory property

See Also:

• FilePicker.getInitialDirectory()
• FilePicker.setInitialDirectory(File)

getInitialDirectory

public final File getInitialDirectory()

Description copied from interface: FilePicker

The initial directory for the displayed file dialog.

Specified by:

getInitialDirectory in interface FilePicker

Returns:

the initial directory as a File object

setInitialDirectory

public final void setInitialDirectory(File value)

Description copied from interface: FilePicker

Sets the initial directory for the displayed file dialog.

Specified by:

setInitialDirectory in interface FilePicker

Parameters:

value - the initial directory as a File object

getTitle

public final String getTitle()

Description copied from interface: FilePicker

Gets the title of the displayed file dialog.

Specified by:

getTitle in interface FilePicker

Returns:

the title string

setTitle

public final void setTitle(String value)

Description copied from interface: FilePicker

Sets the title of the displayed file dialog.

Specified by:

setTitle in interface FilePicker

Parameters:

value - the title string

titleProperty

public final javafx.beans.property.StringProperty titleProperty()

Description copied from interface: FilePicker

The title of the displayed file dialog.

Specified by:

titleProperty in interface FilePicker

Returns:

the title property

See Also:

• FilePicker.getTitle()
• FilePicker.setTitle(String)

getExtensionFilters

public final javafx.collections.ObservableList<ExtensionFilter> getExtensionFilters()

Description copied from interface: FilePicker

Gets the extension filters used in the displayed file dialog. Only one extension filter from the list is active at any time in the displayed dialog and only files which correspond to this extension filter are shown. The first extension filter from the list is activated when the dialog is invoked. Then the user can switch the active extension filter to any other extension filter from the list and in this way control the set of displayed files.

Specified by:

getExtensionFilters in interface FilePicker

Returns:

An observable list of the extension filters used in the dialog

getSelectedExtensionFilter

public final ExtensionFilter getSelectedExtensionFilter()

Description copied from interface: FilePicker

Gets the extension filter which is currently selected in the displayed file dialog.

Specified by:

getSelectedExtensionFilter in interface FilePicker

Returns:

the selected extension filter or null if no extension

setSelectedExtensionFilter

public final void setSelectedExtensionFilter(ExtensionFilter filter)

Description copied from interface: FilePicker

Sets the extension filter which is currently selected in the displayed file dialog.

Specified by:

setSelectedExtensionFilter in interface FilePicker

Parameters:

filter - the selected extension filter

selectedExtensionFilterProperty

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

Description copied from interface: FilePicker

This property is used to pre-select the extension filter for the next displayed dialog and to read the user-selected extension filter from the dismissed dialog.

When the file dialog is shown, the selectedExtensionFilter will be checked. If the value of selectedExtensionFilter is null or is not contained in the list of extension filters, then the first extension filter in the list of extension filters will be selected instead. Otherwise, the specified selectedExtensionFilter will be activated.

After the dialog is dismissed the value of this property is updated to match the user-selected extension filter from the dialog.

Specified by:

selectedExtensionFilterProperty in interface FilePicker

Returns:

the selectedExtensionFilter property

See Also:

• FilePicker.getSelectedExtensionFilter()
• FilePicker.setSelectedExtensionFilter(ExtensionFilter)