de.jstacs.fx.renderers.parameters

Class FileParameterRenderer

java.lang.Object

de.jstacs.fx.renderers.parameters.AbstractParameterRenderer<FileParameter>

de.jstacs.fx.renderers.parameters.FileParameterRenderer

All Implemented Interfaces:

ParameterRenderer<FileParameter>

public class FileParameterRenderer
extends AbstractParameterRenderer<FileParameter>

Class for rendering a FileParameter in the JavaFX GUI. The FileParameter is rendered as a drop-down list of all admissible files (or results) that are already in the ResultRepository and a button for loading new files from disk. This button opens a file dialog for selecting files from disk.

Author:

Jan Grau

Method Summary

Modifier and Type	Method and Description
protected void	addInputs(FileParameter parameter, Pane parent, Label name, Node comment, Label error, Application.ToolReady ready) Adds the parameter-specific input fields to the provided parent pane.
static ChoiceBox	getBox(FileParameter parameter) Returns the ChoiceBox that represents this provided FileParameter in the GUI.
protected void	loadFromFile(FileParameter parameter, ChoiceBox<de.jstacs.fx.renderers.parameters.FileParameterRenderer.ResultContainer> box, Label error, Application.ToolReady ready) Loads the contents of a file.
static void	register() Registers this ParameterRenderer for class FileParameter in the ParameterRendererLibrary.

Methods inherited from class de.jstacs.fx.renderers.parameters.AbstractParameterRenderer

render

Methods inherited from class java.lang.Object

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

Method Detail

register

public static void register()

Registers this ParameterRenderer for class FileParameter in the ParameterRendererLibrary.

getBox

public static ChoiceBox getBox(FileParameter parameter)

Returns the ChoiceBox that represents this provided FileParameter in the GUI.

Parameters:

parameter - the parameter

Returns:

the box

loadFromFile

protected void loadFromFile(FileParameter parameter,
                            ChoiceBox<de.jstacs.fx.renderers.parameters.FileParameterRenderer.ResultContainer> box,
                            Label error,
                            Application.ToolReady ready)

Loads the contents of a file. Opens a file dialog for selecting the input file, adds the corresponding FileParameter.FileRepresentation to the ResultRepository, and selects the loaded file in the drop-down list of admissible files. Extensions of accepted files are obtained from the FileParameter.getAcceptedMimeType() method.

Parameters:

parameter - the FileParameter that is rendered

box - the drop-down list of admissible files

error - the error label, required if a file could not be loaded

ready - the object for checking if all parameters have been set

addInputs

protected void addInputs(FileParameter parameter,
                         Pane parent,
                         Label name,
                         Node comment,
                         Label error,
                         Application.ToolReady ready)

Description copied from class: AbstractParameterRenderer

Adds the parameter-specific input fields to the provided parent pane.

Specified by:

addInputs in class AbstractParameterRenderer<FileParameter>

Parameters:

parameter - the parameter that is rendered

parent - the parent pane containing the rendered parameter

name - the name label that has been created by AbstractParameterRenderer.render(Parameter, Pane, Application.ToolReady)

comment - the comment label that has been created by AbstractParameterRenderer.render(Parameter, Pane, Application.ToolReady)

error - the error label that has been created by AbstractParameterRenderer.render(Parameter, Pane, Application.ToolReady)

ready - object that checks if all parameters have been specified. Any change to a parameter value should issue the method Application.ToolReady.testReady() to test this condition.