Package Acquisition.layoutFX

Class FolderInputPane

java.lang.Object

PamController.SettingsPane<FolderInputParameters>

Acquisition.layoutFX.DAQSettingsPane<FolderInputParameters>

Acquisition.layoutFX.FolderInputPane

public class FolderInputPane
extends DAQSettingsPane<FolderInputParameters>

JavaFX pane for the folder input of the sound acquisition.

Author:

Jamie Macaulay

Field Summary

Fields

Modifier and Type	Field	Description
protected final javafx.stage.FileChooser	fileChooser	File chooser dialog.

Constructor Summary

Constructors

Constructor	Description
FolderInputPane(FolderInputSystem folderInputSystem2, AcquisitionPaneFX acquisitionPaneFX)

Method Summary

Modifier and Type	Method	Description
protected static void	configureFileChooser(javafx.stage.FileChooser fileChooser)	Set params for the file chooser.
javafx.scene.Node	getContentNode()	Get node for GUI change of settings.
String	getName()	Get the name of the pane.
boolean	getParams()	Called by the acquisition pane whenever parameters are to be got.
FolderInputParameters	getParams(FolderInputParameters folderInputParameters)	Get settings from the pane.
void	newFileList(FileListData<WavFileType> fileListData)	Called once the wav worker thread has finished making the audio file list.
void	paneInitialized()	Called when settings pane is first initialised.
protected void	selectFolder(boolean folderDir)	Open a dialog to select either a folder or a list of files.
void	setFileOptionPane(javafx.collections.ObservableList<WavFileType> fileList)	Set bespoke options for certain file types.
void	setFileWorker(PamWorker<FileListData<WavFileType>> worker)	Called whenever a new file worker is initialised to search a folder for wav files.
void	setNewFile(String newFile, FolderInputParameters currParams)	Called when user selects a file or folder in the dialog.
void	setParams()	these are the functions called by the aquisition main settings pane
void	setParams(FolderInputParameters currParams)	Called whenever the pane is first shown/open to set pane to show current settings.

Methods inherited from class PamController.SettingsPane

getAWTWindow, getFXWindow, getHelpPoint, getOwnerWindow, notifyChange, repackContents, setDefaults, setOwnerWindow

Methods inherited from class java.lang.Object

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

Field Details

fileChooser

protected final javafx.stage.FileChooser fileChooser

File chooser dialog.

Constructor Details

FolderInputPane

public FolderInputPane(FolderInputSystem folderInputSystem2,
 AcquisitionPaneFX acquisitionPaneFX)

Method Details

selectFolder

protected void selectFolder(boolean folderDir)

Open a dialog to select either a folder or a list of files.

Parameters:

folderDir - - true to use directory chooser, false to use multiple file chooser.

configureFileChooser

protected static void configureFileChooser(javafx.stage.FileChooser fileChooser)

Set params for the file chooser.

Parameters:

fileChooser - - filechooser to configure.

setNewFile

public void setNewFile(String newFile,
 FolderInputParameters currParams)

Called when user selects a file or folder in the dialog.

Parameters:

newFile - - the new file or folder.

getParams

public FolderInputParameters getParams(FolderInputParameters folderInputParameters)

Description copied from class: SettingsPane

Get settings from the pane.

Specified by:

getParams in class SettingsPane<FolderInputParameters>

Returns:

settings class

setParams

public void setParams(FolderInputParameters currParams)

Description copied from class: SettingsPane

Called whenever the pane is first shown/open to set pane to show current settings.

Specified by:

setParams in class SettingsPane<FolderInputParameters>

Parameters:

currParams - - current settings class.

getName

public String getName()

Description copied from class: SettingsPane

Get the name of the pane.

Specified by:

getName in class SettingsPane<FolderInputParameters>

Returns:

name of the pane

getContentNode

public javafx.scene.Node getContentNode()

Description copied from class: SettingsPane

Get node for GUI change of settings.

Specified by:

getContentNode in class SettingsPane<FolderInputParameters>

paneInitialized

public void paneInitialized()

Description copied from class: SettingsPane

Called when settings pane is first initialised. This can be used if for example, a the size of a pane is needed for a param. (Sizes are only initialised when Nodes are shown);

Specified by:

paneInitialized in class SettingsPane<FolderInputParameters>

newFileList

public void newFileList(FileListData<WavFileType> fileListData)

Called once the wav worker thread has finished making the audio file list.

Parameters:

fileListData - - the list of new audio files.

setFileOptionPane

public void setFileOptionPane(javafx.collections.ObservableList<WavFileType> fileList)

Set bespoke options for certain file types.

setFileWorker

public void setFileWorker(PamWorker<FileListData<WavFileType>> worker)

Called whenever a new file worker is initialised to search a folder for wav files.

Parameters:

worker - - the new file worker being used.

setParams

public void setParams()

these are the functions called by the aquisition main settings pane

Specified by:

setParams in class DAQSettingsPane<FolderInputParameters>

getParams

public boolean getParams()

Description copied from class: DAQSettingsPane

Called by the acquisition pane whenever parameters are to be got.

Specified by:

getParams in class DAQSettingsPane<FolderInputParameters>