org.hkijena.jipipe.plugins.settings

Class JIPipeFileChooserApplicationSettings

java.lang.Object

org.hkijena.jipipe.api.parameters.AbstractJIPipeParameterCollection

org.hkijena.jipipe.api.settings.JIPipeDefaultApplicationsSettingsSheet

org.hkijena.jipipe.plugins.settings.JIPipeFileChooserApplicationSettings

All Implemented Interfaces:

JIPipeParameterCollection, JIPipeParameterCollection.ParameterChangedEventListener, JIPipeParameterCollection.ParameterStructureChangedEventListener, JIPipeParameterCollection.ParameterUIChangedEventListener, JIPipeApplicationSettingsSheet, JIPipeSettingsSheet

public class JIPipeFileChooserApplicationSettings
extends JIPipeDefaultApplicationsSettingsSheet

Settings concerning file dialogs

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JIPipeFileChooserApplicationSettings.FileChooserType
static class	JIPipeFileChooserApplicationSettings.LastDirectoryKey

Nested classes/interfaces inherited from interface org.hkijena.jipipe.api.parameters.JIPipeParameterCollection

JIPipeParameterCollection.ParameterChangedEvent, JIPipeParameterCollection.ParameterChangedEventEmitter, JIPipeParameterCollection.ParameterChangedEventListener, JIPipeParameterCollection.ParameterStructureChangedEvent, JIPipeParameterCollection.ParameterStructureChangedEventEmitter, JIPipeParameterCollection.ParameterStructureChangedEventListener, JIPipeParameterCollection.ParameterUIChangedEvent, JIPipeParameterCollection.ParameterUIChangedEventEmitter, JIPipeParameterCollection.ParameterUIChangedEventListener

Field Summary

Fields

Modifier and Type	Field and Description
static String	ID

Constructor Summary

Constructors

Constructor and Description
JIPipeFileChooserApplicationSettings()

Method Summary

Modifier and Type	Method and Description
FileChooserBookmarkList	getBookmarks()
JIPipeDefaultApplicationSettingsSheetCategory	getDefaultCategory() Returns one of the predefined categories
String	getDescription() Description of this settings sheet
JIPipeFileChooserApplicationSettings.FileChooserType	getFileChooserType()
Icon	getIcon() The icon of the settings sheet
String	getId() The unique ID of the settings sheet
static JIPipeFileChooserApplicationSettings	getInstance()
Path	getLastDataDirectory()
Path	getLastDirectoryBy(JIPipeFileChooserApplicationSettings.LastDirectoryKey key) Gets the last directory by key
Path	getLastExternalDirectory()
Path	getLastParametersDirectory()
Path	getLastProjectsDirectory()
String	getName() The name of the settings sheet as displayed in the UI
boolean	isAddFileExtension()
static List<Path>	openDirectories(Component parent, JIPipeFileChooserApplicationSettings.LastDirectoryKey key, String title) Lets the user choose multiple directories
static Path	openDirectory(Component parent, JIPipeFileChooserApplicationSettings.LastDirectoryKey key, String title) Lets the user choose a directory
static Path	openFile(Component parent, JIPipeFileChooserApplicationSettings.LastDirectoryKey key, String title, FileNameExtensionFilter... extensionFilters) Lets the user choose a file
static List<Path>	openFiles(Component parent, JIPipeFileChooserApplicationSettings.LastDirectoryKey key, String title) Lets the user choose multiple files
static Path	openPath(Component parent, JIPipeFileChooserApplicationSettings.LastDirectoryKey key, String title) Lets the user choose a file or directory
static List<Path>	openPaths(Component parent, JIPipeFileChooserApplicationSettings.LastDirectoryKey key, String title) Lets the user choose multiple files or directories
static Path	saveDirectory(Component parent, JIPipeFileChooserApplicationSettings.LastDirectoryKey key, String title) Lets the user choose a directory
static Path	saveFile(Component parent, JIPipeFileChooserApplicationSettings.LastDirectoryKey key, String title, FileNameExtensionFilter... extensionFilters) Lets the user choose a file
static Path	savePath(Component parent, JIPipeFileChooserApplicationSettings.LastDirectoryKey key, String title) Lets the user choose a file or directory
static List<Path>	selectMulti(Component parent, JIPipeFileChooserApplicationSettings.LastDirectoryKey key, String title, PathIOMode ioMode, PathType pathMode) Generic open method for multiple paths.
static Path	selectSingle(Component parent, JIPipeFileChooserApplicationSettings.LastDirectoryKey key, String title, PathIOMode ioMode, PathType pathMode, FileNameExtensionFilter... extensionFilters) Generic open/save method for single paths
void	setAddFileExtension(boolean addFileExtension)
void	setBookmarks(FileChooserBookmarkList bookmarks)
void	setFileChooserType(JIPipeFileChooserApplicationSettings.FileChooserType fileChooserType)
void	setLastDataDirectory(Path lastDataDirectory)
void	setLastDirectoryBy(JIPipeFileChooserApplicationSettings.LastDirectoryKey key, Path lastDirectory) Sets the last directory according to the key
void	setLastExternalDirectory(Path lastExternalDirectory)
void	setLastParametersDirectory(Path lastParametersDirectory)
void	setLastProjectsDirectory(Path lastProjectsDirectory)

Methods inherited from class org.hkijena.jipipe.api.settings.JIPipeDefaultApplicationsSettingsSheet

getCategory, getCategoryIcon

Methods inherited from class org.hkijena.jipipe.api.parameters.AbstractJIPipeParameterCollection

getParameterChangedEventEmitter, getParameterStructureChangedEventEmitter, getParameterUIChangedEventEmitter, onParameterChanged, onParameterStructureChanged, onParameterUIChanged, registerSubParameter, registerSubParameters

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hkijena.jipipe.api.parameters.JIPipeParameterCollection

deserializeFromJsonNode, emitParameterChangedEvent, emitParameterStructureChangedEvent, emitParameterUIChangedEvent, getContextActions, getParameter, getParameterAccess, getParameterChangedEventEmitter, getParameterStructureChangedEventEmitter, getParameterUIChangedEventEmitter, installUIOverrideParameterEditor, installUIParameterOptions, isParameterUIVisible, isParameterUIVisible, serializeToJsonFile, serializeToJsonGenerator, serializeToJsonString, setParameter

Field Detail

ID

public static String ID

Constructor Detail

JIPipeFileChooserApplicationSettings

public JIPipeFileChooserApplicationSettings()

Method Detail

openFile

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

Lets the user choose a file

Parameters:

parent - parent component

key - location where the dialog is opened

title - dialog title

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,
                            JIPipeFileChooserApplicationSettings.LastDirectoryKey key,
                            String title,
                            FileNameExtensionFilter... extensionFilters)

Lets the user choose a file

Parameters:

parent - parent component

key - location where the dialog is opened

title - dialog title

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,
                            JIPipeFileChooserApplicationSettings.LastDirectoryKey key,
                            String title)

Lets the user choose a file or directory

Parameters:

parent - parent component

key - location where the dialog is opened

title - dialog title

Returns:

selected file or null if dialog was cancelled

savePath

public static Path savePath(Component parent,
                            JIPipeFileChooserApplicationSettings.LastDirectoryKey key,
                            String title)

Lets the user choose a file or directory

Parameters:

parent - parent component

key - location where the dialog is opened

title - dialog title

Returns:

selected file or null if dialog was cancelled

openDirectory

public static Path openDirectory(Component parent,
                                 JIPipeFileChooserApplicationSettings.LastDirectoryKey key,
                                 String title)

Lets the user choose a directory

Parameters:

parent - parent component

key - location where the dialog is opened

title - dialog title

Returns:

selected directory or null if dialog was cancelled

saveDirectory

public static Path saveDirectory(Component parent,
                                 JIPipeFileChooserApplicationSettings.LastDirectoryKey key,
                                 String title)

Lets the user choose a directory

Parameters:

parent - parent component

key - location where the dialog is opened

title - dialog title

Returns:

selected directory or null if dialog was cancelled

openFiles

public static List<Path> openFiles(Component parent,
                                   JIPipeFileChooserApplicationSettings.LastDirectoryKey key,
                                   String title)

Lets the user choose multiple files

Parameters:

parent - parent component

key - location where the dialog is opened

title - dialog title

Returns:

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

openDirectories

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

Lets the user choose multiple directories

Parameters:

parent - parent component

key - location where the dialog is opened

title - dialog title

Returns:

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

openPaths

public static List<Path> openPaths(Component parent,
                                   JIPipeFileChooserApplicationSettings.LastDirectoryKey key,
                                   String title)

Lets the user choose multiple files or directories

Parameters:

parent - parent component

key - location where the dialog is opened

title - dialog title

Returns:

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

selectSingle

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

Generic open/save method for single paths

Parameters:

parent - parent component

key - location where the dialog is opened

title - dialog title

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,
                                     JIPipeFileChooserApplicationSettings.LastDirectoryKey key,
                                     String title,
                                     PathIOMode ioMode,
                                     PathType pathMode)

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

Parameters:

parent - parent component

key - location where the dialog is opened

title - dialog title

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

getInstance

public static JIPipeFileChooserApplicationSettings getInstance()

getBookmarks

public FileChooserBookmarkList getBookmarks()

setBookmarks

public void setBookmarks(FileChooserBookmarkList bookmarks)

getFileChooserType

public JIPipeFileChooserApplicationSettings.FileChooserType getFileChooserType()

setFileChooserType

public void setFileChooserType(JIPipeFileChooserApplicationSettings.FileChooserType fileChooserType)

getLastDirectoryBy

public Path getLastDirectoryBy(JIPipeFileChooserApplicationSettings.LastDirectoryKey key)

Gets the last directory by key

Parameters:

key - the key

Returns:

the last path or Paths.get() (home directory)

setLastDirectoryBy

public void setLastDirectoryBy(JIPipeFileChooserApplicationSettings.LastDirectoryKey key,
                               Path lastDirectory)

Sets the last directory according to the key

Parameters:

key - the key

lastDirectory - directory or file

getLastExternalDirectory

public Path getLastExternalDirectory()

setLastExternalDirectory

public void setLastExternalDirectory(Path lastExternalDirectory)

getLastProjectsDirectory

public Path getLastProjectsDirectory()

setLastProjectsDirectory

public void setLastProjectsDirectory(Path lastProjectsDirectory)

getLastParametersDirectory

public Path getLastParametersDirectory()

setLastParametersDirectory

public void setLastParametersDirectory(Path lastParametersDirectory)

getLastDataDirectory

public Path getLastDataDirectory()

setLastDataDirectory

public void setLastDataDirectory(Path lastDataDirectory)

isAddFileExtension

public boolean isAddFileExtension()

setAddFileExtension

public void setAddFileExtension(boolean addFileExtension)

getDefaultCategory

public JIPipeDefaultApplicationSettingsSheetCategory getDefaultCategory()

Description copied from class: JIPipeDefaultApplicationsSettingsSheet

Returns one of the predefined categories

Specified by:

getDefaultCategory in class JIPipeDefaultApplicationsSettingsSheet

Returns:

the category

getId

public String getId()

Description copied from interface: JIPipeSettingsSheet

The unique ID of the settings sheet

Returns:

the ID

getIcon

public Icon getIcon()

Description copied from interface: JIPipeSettingsSheet

The icon of the settings sheet

Returns:

the icon

getName

public String getName()

Description copied from interface: JIPipeSettingsSheet

The name of the settings sheet as displayed in the UI

Returns:

the name

getDescription

public String getDescription()

Description copied from interface: JIPipeSettingsSheet

Description of this settings sheet

Returns:

the description