java.lang.Object
- adams.core.logging.LoggingObject
- - adams.core.logging.CustomLoggingLevelObject
  - - adams.core.option.AbstractOptionHandler
    - - adams.flow.source.valuedefinition.AbstractValueDefinition
      - adams.flow.source.valuedefinition.FileValueDefinition

All Implemented Interfaces:

Destroyable, GlobalInfoSupporter, AbsolutePathSupporter, ForwardSlashSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, SizeOfHandler, FlowContextHandler, Serializable
```
public class FileValueDefinition
extends AbstractValueDefinition
implements ForwardSlashSupporter, AbsolutePathSupporter
```
Value definition specifically for files.

Author:

FracPete (fracpete at waikato dot ac dot nz)

See Also:

Serialized Form

Field Summary

Fields
Modifier and Type	Field	Description
`protected boolean`	`m_AcceptAllFileFilter`	whether to allow the "All files" filter.
`protected PlaceholderFile`	`m_DefaultValue`	the default file.
`protected BaseString[]`	`m_Extensions`	the extensions to offer in the file chooser.
`protected String`	`m_FileChooserTitle`	the title of the file chooser dialog.
`protected PlaceholderDirectory`	`m_InitialDirectory`	the initial directory.
`protected boolean`	`m_MultiSelect`	whether to select multiple files.
`protected boolean`	`m_UseAbsolutePath`	whether to use absolute path rather than placeholders.
`protected boolean`	`m_UseForwardSlashes`	whether to output forward slashes.

Fields inherited from class adams.flow.source.valuedefinition.AbstractValueDefinition
m_Display, m_Enabled, m_FlowContext, m_Help, m_Name

Fields inherited from class adams.core.option.AbstractOptionHandler
m_OptionManager

Fields inherited from class adams.core.logging.LoggingObject
m_Logger, m_LoggingIsEnabled, m_LoggingLevel

Constructor Summary

Constructors
Constructor Description

FileValueDefinition()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`acceptAllFileFilterTipText()`	Returns the tip text for this property.
`boolean`	`addToPanel(PropertiesParameterPanel panel)`	Adds the value to the panel.
`String`	`defaultValueTipText()`	Returns the tip text for this property.
`void`	`defineOptions()`	Adds options to the internal list of options.
`String`	`extensionsTipText()`	Returns the tip text for this property.
`String`	`fileChooserTitleTipText()`	Returns the tip text for this property.
`boolean`	`getAcceptAllFileFilter()`	Returns whether to show the 'All files' filter.
`PlaceholderFile`	`getDefaultValue()`	Returns the default of the value.
`String`	`getDefaultValueAsString()`	Returns the default of the value as string.
`BaseString[]`	`getExtensions()`	Returns the extension on offer in the file chooser.
`String`	`getFileChooserTitle()`	Returns the title for the file chooser dialog.
`PlaceholderDirectory`	`getInitialDirectory()`	Returns the initial directory.
`boolean`	`getMultiSelect()`	Returns whether multiple files can be selected.
`PropertiesParameterPanel.PropertyType`	`getType()`	Returns the type of the value.
`boolean`	`getUseAbsolutePath()`	Returns whether to use absolute paths.
`boolean`	`getUseForwardSlashes()`	Returns whether to use forward slashes in the output.
`String`	`globalInfo()`	Returns a string describing the object.
`String`	`headlessInteraction()`	Prompts the user to enter a value in headless mode and returns it.
`String`	`initialDirectoryTipText()`	Returns the tip text for this property.
`String`	`multiSelectTipText()`	Returns the tip text for this property.
`protected boolean`	`requiresFlowContext()`	Returns whether flow context is required.
`void`	`setAcceptAllFileFilter(boolean value)`	Sets whether to show the 'All files' filter.
`void`	`setDefaultValue(PlaceholderFile value)`	Sets the default of the value.
`void`	`setDefaultValueAsString(String value)`	Sets the default value as string.
`void`	`setExtensions(BaseString[] value)`	Sets the extensions to offer in the file chooser.
`void`	`setFileChooserTitle(String value)`	Sets the title for the file chooser dialog.
`void`	`setInitialDirectory(PlaceholderDirectory value)`	Sets the initial directory.
`void`	`setMultiSelect(boolean value)`	Sets whether multiple files can be selected.
`void`	`setUseAbsolutePath(boolean value)`	Sets whether to use absolute paths.
`void`	`setUseForwardSlashes(boolean value)`	Sets whether to use forward slashes in the output.
`String`	`useAbsolutePathTipText()`	Returns the tip text for this property.
`String`	`useForwardSlashesTipText()`	Returns the tip text for this property.

Methods inherited from class adams.flow.source.valuedefinition.AbstractValueDefinition
canBeRestored, check, displayTipText, enabledTipText, getDisplay, getEnabled, getFlowContext, getHelp, getName, helpTipText, nameTipText, setDisplay, setEnabled, setFlowContext, setHelp, setName

Methods inherited from class adams.core.option.AbstractOptionHandler
cleanUpOptions, destroy, finishInit, getDefaultLoggingLevel, getOptionManager, initialize, loggingLevelTipText, newOptionManager, reset, setLoggingLevel, toCommandLine, toString

Methods inherited from class adams.core.logging.LoggingObject
configureLogger, getLogger, getLoggingLevel, initializeLogging, isLoggingEnabled, sizeOf

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface adams.core.logging.LoggingLevelHandler
getLoggingLevel

- Field Detail
  - m_FileChooserTitle
```
protected String m_FileChooserTitle
```
    the title of the file chooser dialog.
  - m_InitialDirectory
```
protected PlaceholderDirectory m_InitialDirectory
```
    the initial directory.
  - m_DefaultValue
```
protected PlaceholderFile m_DefaultValue
```
    the default file.
  - m_Extensions
```
protected BaseString[] m_Extensions
```
    the extensions to offer in the file chooser.
  - m_UseForwardSlashes
```
protected boolean m_UseForwardSlashes
```
    whether to output forward slashes.
  - m_UseAbsolutePath
```
protected boolean m_UseAbsolutePath
```
    whether to use absolute path rather than placeholders.
  - m_AcceptAllFileFilter
```
protected boolean m_AcceptAllFileFilter
```
    whether to allow the "All files" filter.
  - m_MultiSelect
```
protected boolean m_MultiSelect
```
    whether to select multiple files.
- Constructor Detail
  - FileValueDefinition
```
public FileValueDefinition()
```
- Method Detail
  - globalInfo
```
public String globalInfo()
```
    Returns a string describing the object.
    
    Specified by:
    
    globalInfo in interface GlobalInfoSupporter
    
    Specified by:
    
    globalInfo in class AbstractOptionHandler
    
    Returns:
    
    a description suitable for displaying in the gui
  - defineOptions
```
public void defineOptions()
```
    Adds options to the internal list of options.
    
    Specified by:
    
    defineOptions in interface OptionHandler
    
    Overrides:
    
    defineOptions in class AbstractValueDefinition
  - setFileChooserTitle
```
public void setFileChooserTitle(String value)
```
    Sets the title for the file chooser dialog.
    
    Parameters:
    
    value - the title
  - getFileChooserTitle
```
public String getFileChooserTitle()
```
    Returns the title for the file chooser dialog.
    
    Returns:
    
    the title
  - fileChooserTitleTipText
```
public String fileChooserTitleTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setInitialDirectory
```
public void setInitialDirectory(PlaceholderDirectory value)
```
    Sets the initial directory.
    
    Parameters:
    
    value - the initial directory
  - getInitialDirectory
```
public PlaceholderDirectory getInitialDirectory()
```
    Returns the initial directory.
    
    Returns:
    
    the initial directory
  - initialDirectoryTipText
```
public String initialDirectoryTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setExtensions
```
public void setExtensions(BaseString[] value)
```
    Sets the extensions to offer in the file chooser.
    
    Parameters:
    
    value - the extensions
  - getExtensions
```
public BaseString[] getExtensions()
```
    Returns the extension on offer in the file chooser.
    
    Returns:
    
    the extensions
  - extensionsTipText
```
public String extensionsTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setDefaultValue
```
public void setDefaultValue(PlaceholderFile value)
```
    Sets the default of the value.
    
    Parameters:
    
    value - the default
  - getDefaultValue
```
public PlaceholderFile getDefaultValue()
```
    Returns the default of the value.
    
    Returns:
    
    the default
  - defaultValueTipText
```
public String defaultValueTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setUseForwardSlashes
```
public void setUseForwardSlashes(boolean value)
```
    Sets whether to use forward slashes in the output.
    
    Specified by:
    
    setUseForwardSlashes in interface ForwardSlashSupporter
    
    Parameters:
    
    value - if true then use forward slashes
  - getUseForwardSlashes
```
public boolean getUseForwardSlashes()
```
    Returns whether to use forward slashes in the output.
    
    Specified by:
    
    getUseForwardSlashes in interface ForwardSlashSupporter
    
    Returns:
    
    true if forward slashes are used
  - useForwardSlashesTipText
```
public String useForwardSlashesTipText()
```
    Returns the tip text for this property.
    
    Specified by:
    
    useForwardSlashesTipText in interface ForwardSlashSupporter
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setUseAbsolutePath
```
public void setUseAbsolutePath(boolean value)
```
    Sets whether to use absolute paths.
    
    Specified by:
    
    setUseAbsolutePath in interface AbsolutePathSupporter
    
    Parameters:
    
    value - if true if absolute paths
  - getUseAbsolutePath
```
public boolean getUseAbsolutePath()
```
    Returns whether to use absolute paths.
    
    Specified by:
    
    getUseAbsolutePath in interface AbsolutePathSupporter
    
    Returns:
    
    true if absolute paths
  - useAbsolutePathTipText
```
public String useAbsolutePathTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setAcceptAllFileFilter
```
public void setAcceptAllFileFilter(boolean value)
```
    Sets whether to show the 'All files' filter.
    
    Parameters:
    
    value - true if to show
  - getAcceptAllFileFilter
```
public boolean getAcceptAllFileFilter()
```
    Returns whether to show the 'All files' filter.
    
    Returns:
    
    true if to show
  - acceptAllFileFilterTipText
```
public String acceptAllFileFilterTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setMultiSelect
```
public void setMultiSelect(boolean value)
```
    Sets whether multiple files can be selected.
    
    Parameters:
    
    value - true if can select multiple files
  - getMultiSelect
```
public boolean getMultiSelect()
```
    Returns whether multiple files can be selected.
    
    Returns:
    
    true if can select multiple files
  - multiSelectTipText
```
public String multiSelectTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - requiresFlowContext
```
protected boolean requiresFlowContext()
```
    Returns whether flow context is required.
    
    Specified by:
    
    requiresFlowContext in class AbstractValueDefinition
    
    Returns:
    
    true if required
  - getType
```
public PropertiesParameterPanel.PropertyType getType()
```
    Returns the type of the value.
    
    Specified by:
    
    getType in class AbstractValueDefinition
    
    Returns:
    
    the type
  - setDefaultValueAsString
```
public void setDefaultValueAsString(String value)
```
    Sets the default value as string.
    
    Specified by:
    
    setDefaultValueAsString in class AbstractValueDefinition
    
    Parameters:
    
    value - the default value
  - getDefaultValueAsString
```
public String getDefaultValueAsString()
```
    Returns the default of the value as string.
    
    Specified by:
    
    getDefaultValueAsString in class AbstractValueDefinition
    
    Returns:
    
    the default
  - addToPanel
```
public boolean addToPanel(PropertiesParameterPanel panel)
```
    Adds the value to the panel.
    
    Specified by:
    
    addToPanel in class AbstractValueDefinition
    
    Parameters:
    
    panel - the panel to add to
    
    Returns:
    
    true if successfully added
  - headlessInteraction
```
public String headlessInteraction()
```
    Prompts the user to enter a value in headless mode and returns it.
    
    Specified by:
    
    headlessInteraction in class AbstractValueDefinition
    
    Returns:
    
    the entered value, null if canceled

Class FileValueDefinition

Field Summary

Fields inherited from class adams.flow.source.valuedefinition.AbstractValueDefinition

Fields inherited from class adams.core.option.AbstractOptionHandler

Fields inherited from class adams.core.logging.LoggingObject

Constructor Summary

Method Summary

Methods inherited from class adams.flow.source.valuedefinition.AbstractValueDefinition

Methods inherited from class adams.core.option.AbstractOptionHandler

Methods inherited from class adams.core.logging.LoggingObject

Methods inherited from class java.lang.Object

Methods inherited from interface adams.core.logging.LoggingLevelHandler

Field Detail

m_FileChooserTitle

m_InitialDirectory

m_DefaultValue

m_Extensions

m_UseForwardSlashes

m_UseAbsolutePath

m_AcceptAllFileFilter

m_MultiSelect

Constructor Detail

FileValueDefinition

Method Detail

globalInfo

defineOptions

setFileChooserTitle

getFileChooserTitle

fileChooserTitleTipText

setInitialDirectory

getInitialDirectory

initialDirectoryTipText

setExtensions

getExtensions

extensionsTipText

setDefaultValue

getDefaultValue

defaultValueTipText

setUseForwardSlashes

getUseForwardSlashes

useForwardSlashesTipText

setUseAbsolutePath

getUseAbsolutePath

useAbsolutePathTipText

setAcceptAllFileFilter

getAcceptAllFileFilter

acceptAllFileFilterTipText

setMultiSelect

getMultiSelect

multiSelectTipText

requiresFlowContext

getType

setDefaultValueAsString

getDefaultValueAsString

addToPanel

headlessInteraction