Package com.motivewave.platform.sdk.common.desc

Class FileDesc

java.lang.Object

com.motivewave.platform.sdk.common.desc.SettingDescriptor<FileInfo>

com.motivewave.platform.sdk.common.desc.FileDesc

public class FileDesc
extends SettingDescriptor<FileInfo>

Constructor Summary

Constructors

Constructor	Description
FileDesc(String id, String label, FileInfo defaultValue)
FileDesc(String id, String label, FileInfo defaultValue, boolean supportsDisable)

Method Summary

Modifier and Type	Method	Description
javafx.scene.Node	createInputFX(Settings settings, boolean readOnly)	Creates the component that will accept the user input.
Object	fromJson(Object json)
List<String>	getExtensions()	Gets the list of file extensions to filter in the file chooser dialog.
String	getFilterName()	Gets the name of the filter to display when showing the file chooser dialog.
FileDesc	setExtensions(List<String> extensions)	Sets the list of file extensions to filter in the file chooser dialog.
FileDesc	setFilterName(String filterName)	Sets the name of the filter to display when showing the file chooser dialog.

Methods inherited from class com.motivewave.platform.sdk.common.desc.SettingDescriptor

createInput, createTBInput, getDefaultValue, getDescription, getGridWidth, getHelpLink, getIconFactory, getId, getLabel, getName, isAllowUserDefaults, isDisplaySetting, isEnabled, isShowLabel, isSupportsDisable, setAllowUserDefaults, setDefaultValue, setDescription, setEnabled, setGridWidth, setHelpLink, setIconFactory, setShowLabel, setSupportsDisable

Methods inherited from class java.lang.Object

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

Constructor Details

FileDesc

public FileDesc(String id,
 String label,
 FileInfo defaultValue)

FileDesc

public FileDesc(String id,
 String label,
 FileInfo defaultValue,
 boolean supportsDisable)

Method Details

getExtensions

public List<String> getExtensions()

Gets the list of file extensions to filter in the file chooser dialog. For example: *.txt, *.TXT

Returns:

file extensions used to filter in the file chooser dialog in the form '*.ext'.

setExtensions

public FileDesc setExtensions(List<String> extensions)

Sets the list of file extensions to filter in the file chooser dialog. For example: *.txt, *.TXT

Parameters:

extensions - list of file extensions in the form '*.ext'

getFilterName

public String getFilterName()

Gets the name of the filter to display when showing the file chooser dialog.

Returns:

filter name

setFilterName

public FileDesc setFilterName(String filterName)

Sets the name of the filter to display when showing the file chooser dialog.

Parameters:

filterName - filter name

createInputFX

public javafx.scene.Node createInputFX(Settings settings,
 boolean readOnly)

Description copied from class: SettingDescriptor

Creates the component that will accept the user input. This is called by the study framework.

Specified by:

createInputFX in class SettingDescriptor<FileInfo>

Parameters:

settings - settings for the study

readOnly - true if the component should not accept user input

Returns:

component that will accept user input.

fromJson

public Object fromJson(Object json)

Overrides:

fromJson in class SettingDescriptor<FileInfo>