hu.scelightapibase.gui.comp

Interface IPathField

All Superinterfaces:

IIndicatorComp, IIndicatorTextField

public interface IPathField
extends IIndicatorTextField

An IIndicatorTextField path editor field with an IButton which shows an IFileChooser.

The field has 2 modes based on whether it is to choose a folder or a file.

Author:

Andras Belicza

See Also:

IGuiFactory.newPathField(), IGuiFactory.newPathField(boolean), IGuiFactory.newPathField(Path), IGuiFactory.newPathField(Path, boolean)

Method Summary

Methods

Modifier and Type	Method and Description
IButton	getButton() Returns the button to open an IFileChooser.
IFileChooser	getFileChooser() Returns the file chooser displayed when the button is clicked.
java.nio.file.Path	getPath() Returns the selected path.
boolean	hasPath() Tells if a path has been entered.
void	setPath(java.nio.file.Path path) Sets the specified path.

Methods inherited from interface hu.scelightapibase.gui.comp.IIndicatorTextField

getText, getTextField, setText

Methods inherited from interface hu.scelightapibase.gui.comp.IIndicatorComp

asComponent, configureIndicator, getIndicator, setAccepted, setEmpty, setError, setNotAccepted

Method Detail

getButton

IButton getButton()

Returns the button to open an IFileChooser.

Returns:

the button to open an IFileChooser

getFileChooser

IFileChooser getFileChooser()

Returns the file chooser displayed when the button is clicked.

Returns:

the file chooser displayed when the button is clicked

hasPath

boolean hasPath()

Tells if a path has been entered.

Returns:

true if a path has been entered; false otherwise

getPath

java.nio.file.Path getPath()

Returns the selected path.

Returns:

the selected path or an empty path (Paths.get("")) if no valid path has been entered

setPath

void setPath(java.nio.file.Path path)

Sets the specified path.

Parameters:

path - path to be set