org.hkijena.jipipe.desktop

Class JIPipeDesktop

java.lang.Object

org.hkijena.jipipe.desktop.JIPipeDesktop

public class JIPipeDesktop
extends Object

Utility class for desktop-related JIPipe functions

Method Summary

Modifier and Type	Method and Description
static List<Path>	openDirectories(Component parent, JIPipeWorkbench workbench, JIPipeFileChooserApplicationSettings.LastDirectoryKey key, String title, HTMLText description) Lets the user choose multiple directories
static Path	openDirectory(Component parent, JIPipeWorkbench workbench, JIPipeFileChooserApplicationSettings.LastDirectoryKey key, String title, HTMLText description) Lets the user choose a directory
static Path	openFile(Component parent, JIPipeWorkbench workbench, JIPipeFileChooserApplicationSettings.LastDirectoryKey key, String title, HTMLText description, FileNameExtensionFilter... extensionFilters) Lets the user choose a file
static List<Path>	openFiles(Component parent, JIPipeWorkbench workbench, JIPipeFileChooserApplicationSettings.LastDirectoryKey key, String title, HTMLText description, FileNameExtensionFilter... extensionFilters) Lets the user choose multiple files
static Path	openPath(Component parent, JIPipeWorkbench workbench, JIPipeFileChooserApplicationSettings.LastDirectoryKey key, String title, HTMLText description, FileNameExtensionFilter... extensionFilters) Lets the user choose a file or directory
static List<Path>	openPaths(Component parent, JIPipeWorkbench workbench, JIPipeFileChooserApplicationSettings.LastDirectoryKey key, String title, HTMLText description, FileNameExtensionFilter... extensionFilters) Lets the user choose multiple files or directories
static Path	saveDirectory(Component parent, JIPipeWorkbench workbench, JIPipeFileChooserApplicationSettings.LastDirectoryKey key, String title, HTMLText description) Lets the user choose a directory
static Path	saveFile(Component parent, JIPipeWorkbench workbench, JIPipeFileChooserApplicationSettings.LastDirectoryKey key, String title, HTMLText description, FileNameExtensionFilter... extensionFilters) Lets the user choose a file
static Path	savePath(Component parent, JIPipeWorkbench workbench, JIPipeFileChooserApplicationSettings.LastDirectoryKey key, String title, HTMLText description, FileNameExtensionFilter... extensionFilters) Lets the user choose a file or directory
static List<Path>	selectMulti(Component parent, JIPipeWorkbench workbench, JIPipeFileChooserApplicationSettings.LastDirectoryKey key, String title, HTMLText description, PathIOMode ioMode, PathType pathMode, FileNameExtensionFilter... extensionFilters) Generic open method for multiple paths.
static Path	selectSingle(Component parent, JIPipeWorkbench workbench, JIPipeFileChooserApplicationSettings.LastDirectoryKey key, String title, HTMLText description, PathIOMode ioMode, PathType pathMode, FileNameExtensionFilter... extensionFilters) Generic open/save method for single paths

Methods inherited from class java.lang.Object

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

Method Detail

openFile

public static Path openFile(Component parent,
                            JIPipeWorkbench workbench,
                            JIPipeFileChooserApplicationSettings.LastDirectoryKey key,
                            String title,
                            HTMLText description,
                            FileNameExtensionFilter... extensionFilters)

Lets the user choose a file

Parameters:

parent - parent component

workbench - the workbench

key - location where the dialog is opened

title - dialog title

description - optional description (only supported by specific file chooser types)

extensionFilters - optional extension filters. the first one is chosen automatically

Returns:

selected file or null if dialog was cancelled

saveFile

public static Path saveFile(Component parent,
                            JIPipeWorkbench workbench,
                            JIPipeFileChooserApplicationSettings.LastDirectoryKey key,
                            String title,
                            HTMLText description,
                            FileNameExtensionFilter... extensionFilters)

Lets the user choose a file

Parameters:

parent - parent component

workbench - the workbench

key - location where the dialog is opened

title - dialog title

description - optional description (only supported by specific file chooser types)

extensionFilters - extension filters. the first one is chosen automatically

Returns:

selected file or null if dialog was cancelled

openPath

public static Path openPath(Component parent,
                            JIPipeWorkbench workbench,
                            JIPipeFileChooserApplicationSettings.LastDirectoryKey key,
                            String title,
                            HTMLText description,
                            FileNameExtensionFilter... extensionFilters)

Lets the user choose a file or directory

Parameters:

parent - parent component

workbench - the workbench

key - location where the dialog is opened

title - dialog title

description - optional description (only supported by specific file chooser types)

Returns:

selected file or null if dialog was cancelled

savePath

public static Path savePath(Component parent,
                            JIPipeWorkbench workbench,
                            JIPipeFileChooserApplicationSettings.LastDirectoryKey key,
                            String title,
                            HTMLText description,
                            FileNameExtensionFilter... extensionFilters)

Lets the user choose a file or directory

Parameters:

parent - parent component

workbench - the workbench

key - location where the dialog is opened

title - dialog title

description - optional description (only supported by specific file chooser types)

Returns:

selected file or null if dialog was cancelled

openDirectory

public static Path openDirectory(Component parent,
                                 JIPipeWorkbench workbench,
                                 JIPipeFileChooserApplicationSettings.LastDirectoryKey key,
                                 String title,
                                 HTMLText description)

Lets the user choose a directory

Parameters:

parent - parent component

workbench - the workbench

key - location where the dialog is opened

title - dialog title

description - optional description (only supported by specific file chooser types)

Returns:

selected directory or null if dialog was cancelled

saveDirectory

public static Path saveDirectory(Component parent,
                                 JIPipeWorkbench workbench,
                                 JIPipeFileChooserApplicationSettings.LastDirectoryKey key,
                                 String title,
                                 HTMLText description)

Lets the user choose a directory

Parameters:

parent - parent component

workbench - the workbench

key - location where the dialog is opened

title - dialog title

description - optional description (only supported by specific file chooser types)

Returns:

selected directory or null if dialog was cancelled

openFiles

public static List<Path> openFiles(Component parent,
                                   JIPipeWorkbench workbench,
                                   JIPipeFileChooserApplicationSettings.LastDirectoryKey key,
                                   String title,
                                   HTMLText description,
                                   FileNameExtensionFilter... extensionFilters)

Lets the user choose multiple files

Parameters:

parent - parent component

workbench - the workbench

key - location where the dialog is opened

title - dialog title

description - optional description (only supported by specific file chooser types)

Returns:

selected list of files. Is empty if dialog was cancelled.

openDirectories

public static List<Path> openDirectories(Component parent,
                                         JIPipeWorkbench workbench,
                                         JIPipeFileChooserApplicationSettings.LastDirectoryKey key,
                                         String title,
                                         HTMLText description)

Lets the user choose multiple directories

Parameters:

parent - parent component

workbench - the workbench

key - location where the dialog is opened

title - dialog title

description - optional description (only supported by specific file chooser types)

Returns:

selected list of files. Is empty if dialog was cancelled.

openPaths

public static List<Path> openPaths(Component parent,
                                   JIPipeWorkbench workbench,
                                   JIPipeFileChooserApplicationSettings.LastDirectoryKey key,
                                   String title,
                                   HTMLText description,
                                   FileNameExtensionFilter... extensionFilters)

Lets the user choose multiple files or directories

Parameters:

parent - parent component

workbench - the workbench

key - location where the dialog is opened

title - dialog title

description - optional description (only supported by specific file chooser types)

Returns:

selected list of files. Is empty if dialog was cancelled.

selectSingle

public static Path selectSingle(Component parent,
                                JIPipeWorkbench workbench,
                                JIPipeFileChooserApplicationSettings.LastDirectoryKey key,
                                String title,
                                HTMLText description,
                                PathIOMode ioMode,
                                PathType pathMode,
                                FileNameExtensionFilter... extensionFilters)

Generic open/save method for single paths

Parameters:

parent - parent component

workbench - the workbench

key - location where the dialog is opened

title - dialog title

description - optional description (only supported by specific file chooser types)

ioMode - whether to load or save

pathMode - which types of paths are returned

extensionFilters - passed if a file is opened/saved

Returns:

selected path of provided pathMode or null if dialog was cancelled

selectMulti

public static List<Path> selectMulti(Component parent,
                                     JIPipeWorkbench workbench,
                                     JIPipeFileChooserApplicationSettings.LastDirectoryKey key,
                                     String title,
                                     HTMLText description,
                                     PathIOMode ioMode,
                                     PathType pathMode,
                                     FileNameExtensionFilter... extensionFilters)

Generic open method for multiple paths. Info: Due to API limitations, only one saved file can be returned.

Parameters:

parent - parent component

workbench - the workbench

key - location where the dialog is opened

title - dialog title

description - optional description (only supported by specific file chooser types)

ioMode - whether to load or save

pathMode - which types of paths are returned

Returns:

selected paths of provided pathMode or empty list if dialog was cancelled