Module one.jpro.platform.file

Package one.jpro.platform.file.picker

Class NativeFileOpenPicker

java.lang.Object

one.jpro.platform.file.picker.NativeFileOpenPicker

All Implemented Interfaces:

MultipleFileSelector, FileOpenPicker, FilePicker

public class NativeFileOpenPicker
extends Object

Represents a FileOpenPicker implementation for JavaFX desktop/mobile applications. This class specializes for selecting and opening files from the native file system. Depending on the configuration (e.g. extension filters and selection mode), it will display either a FileChooser or a DirectoryChooser.

Author:

Besmir Beqiri, Indrit Beqiri, Florian Kirmaier

See Also:

• FileChooser
• DirectoryChooser
• NativeFileSource

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.
javafx.beans.property.ObjectProperty<Consumer<List<? extends FileSource>>>	onFilesSelected	Defines the handler to be called when the user selects files.
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<javafx.scene.control.SelectionMode>	selectionMode	Defines the selection mode.
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
NativeFileOpenPicker(javafx.scene.Node node)	Initializes a new instance associated with the specified 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 Consumer<List<? extends FileSource>>	getOnFilesSelected()	Gets the handler to be called when the user selects files.
final ExtensionFilter	getSelectedExtensionFilter()	Gets the extension filter which is currently selected in the displayed file dialog.
final javafx.scene.control.SelectionMode	getSelectionMode()	Returns the selection mode.
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.
javafx.beans.property.ObjectProperty<Consumer<List<? extends FileSource>>>	onFilesSelectedProperty()	Defines the handler to be called when the user selects files.
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 javafx.beans.property.ObjectProperty<javafx.scene.control.SelectionMode>	selectionModeProperty()	Defines the selection mode.
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	setOnFilesSelected(Consumer<List<? extends FileSource>> value)	Sets the handler to be called when the user selects files.
final void	setSelectedExtensionFilter(ExtensionFilter filter)	Sets the extension filter which is currently selected in the displayed file dialog.
final void	setSelectionMode(javafx.scene.control.SelectionMode value)	Sets the selection mode.
final void	setTitle(String value)	Sets the title of the displayed file dialog.
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

selectionMode

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

Returns:

the selectionMode property

See Also:

• selectionModeProperty()

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()

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

NativeFileOpenPicker

public NativeFileOpenPicker(javafx.scene.Node node)

Initializes a new instance associated with the specified node.

Parameters:

node - The node associated with this file picker.

Method Details

selectionModeProperty

public final 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.

Returns:

the selectionMode property

See Also:

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

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.

getOnFilesSelected

public final 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 final 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)

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)