Package org.sellcom.javafx.stage

Class PathChooser

java.lang.Object

org.sellcom.javafx.stage.PathChooser

public class PathChooser
extends java.lang.Object

FileChooser equivalent handling Paths instead of Files.

Since:

1.0

See Also:

FileChooser

Constructor Summary

Constructors

Constructor	Description
PathChooser()	Crates a new PathChooser.

Method Summary

Modifier and Type	Method	Description
javafx.collections.ObservableList<javafx.stage.FileChooser.ExtensionFilter>	getExtensionFilters()	Returns the extension filters of the displayed file dialog.
java.nio.file.Path	getInitialDirectory()	Returns the initial directory of the displayed file dialog.
java.lang.String	getInitialFileName()	Returns the initial file name of the displayed file dialog.
javafx.stage.FileChooser.ExtensionFilter	getSelectedExtensionFilter()	Returns the selected extension filter of the displayed file dialog.
java.lang.String	getTitle()	Returns the title of the displayed file dialog.
javafx.beans.property.ObjectProperty<java.nio.file.Path>	initialDirectoryProperty()	Returns the property for the initial directory of the displayed file dialog.
javafx.beans.property.ObjectProperty<java.lang.String>	initialFileNameProperty()	Returns the property for the initial file name of the displayed file dialog.
javafx.beans.property.ObjectProperty<javafx.stage.FileChooser.ExtensionFilter>	selectedExtensionFilterProperty()	Returns the property for the selected extension filter of the displayed file dialog.
void	setInitialDirectory(java.nio.file.Path directory)	Sets the initial directory of the displayed file dialog.
void	setInitialFileName(java.lang.String fileName)	Sets the initial file name of the displayed file dialog.
void	setSelectedExtensionFilter(javafx.stage.FileChooser.ExtensionFilter extensionFilter)	Sets the selected extension filter of the displayed file dialog.
void	setTitle(java.lang.String title)	Sets the title of the displayed file dialog.
java.util.Optional<java.nio.file.Path>	showOpenDialog(javafx.stage.Window ownerWindow)	Shows a file open dialog.
java.util.List<java.nio.file.Path>	showOpenMultipleDialog(javafx.stage.Window ownerWindow)	Shows a file open dialog in which multiple files can be selected.
java.util.Optional<java.nio.file.Path>	showSaveDialog(javafx.stage.Window ownerWindow)	Shows a file save dialog.
javafx.beans.property.StringProperty	titleProperty()	Returns the property for 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

Constructor Detail

PathChooser

public PathChooser()

Crates a new PathChooser.

Since:

1.0

Method Detail

getExtensionFilters

public javafx.collections.ObservableList<javafx.stage.FileChooser.ExtensionFilter> getExtensionFilters()

Returns the extension filters of the displayed file dialog.

Since:

1.0

getInitialDirectory

public java.nio.file.Path getInitialDirectory()

Returns the initial directory of the displayed file dialog.

Since:

1.0

getInitialFileName

public java.lang.String getInitialFileName()

Returns the initial file name of the displayed file dialog.

Since:

1.0

getSelectedExtensionFilter

public javafx.stage.FileChooser.ExtensionFilter getSelectedExtensionFilter()

Returns the selected extension filter of the displayed file dialog.

Since:

1.0

getTitle

public java.lang.String getTitle()

Returns the title of the displayed file dialog.

Since:

1.0

initialDirectoryProperty

public javafx.beans.property.ObjectProperty<java.nio.file.Path> initialDirectoryProperty()

Returns the property for the initial directory of the displayed file dialog.

Since:

1.0

initialFileNameProperty

public javafx.beans.property.ObjectProperty<java.lang.String> initialFileNameProperty()

Returns the property for the initial file name of the displayed file dialog.

Since:

1.0

selectedExtensionFilterProperty

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

Returns the property for the selected extension filter of the displayed file dialog.

Since:

1.0

setInitialDirectory

public void setInitialDirectory(java.nio.file.Path directory)

Sets the initial directory of the displayed file dialog.

Throws:

java.lang.IllegalArgumentException - if directory is null

Since:

1.0

setInitialFileName

public void setInitialFileName(java.lang.String fileName)

Sets the initial file name of the displayed file dialog.

Throws:

java.lang.IllegalArgumentException - if fileName is null or empty

Since:

1.0

setSelectedExtensionFilter

public void setSelectedExtensionFilter(javafx.stage.FileChooser.ExtensionFilter extensionFilter)

Sets the selected extension filter of the displayed file dialog.

Throws:

java.lang.IllegalArgumentException - if extensionFilter is null

Since:

1.0

setTitle

public void setTitle(java.lang.String title)

Sets the title of the displayed file dialog.

Throws:

java.lang.IllegalArgumentException - if title is null or empty

Since:

1.0

showOpenDialog

public java.util.Optional<java.nio.file.Path> showOpenDialog(javafx.stage.Window ownerWindow)

Shows a file open dialog. The method does not return until the displayed open dialog is dismissed. If the owner window for the file dialog is set, input to all windows in the dialog's owner chain is blocked while the file dialog is being shown.

Since:

1.0

showOpenMultipleDialog

public java.util.List<java.nio.file.Path> showOpenMultipleDialog(javafx.stage.Window ownerWindow)

Shows a file open dialog in which multiple files can be selected. The method does not return until the displayed open dialog is dismissed. If the owner window for the file dialog is set, input to all windows in the dialog's owner chain is blocked while the file dialog is being shown.

Since:

1.0

showSaveDialog

public java.util.Optional<java.nio.file.Path> showSaveDialog(javafx.stage.Window ownerWindow)

Shows a file save dialog. The method does not return until the displayed open dialog is dismissed. If the owner window for the file dialog is set, input to all windows in the dialog's owner chain is blocked while the file dialog is being shown.

Since:

1.0

titleProperty

public javafx.beans.property.StringProperty titleProperty()

Returns the property for the title of the displayed file dialog.

Since:

1.0