java.lang.Object
- adams.core.logging.LoggingObject
- - adams.core.logging.CustomLoggingLevelObject
  - - adams.core.option.AbstractOptionHandler
    - - adams.flow.core.AbstractActor
      - adams.flow.source.AbstractSource
        
        adams.flow.source.AbstractArrayProvider
        
        adams.flow.source.SelectFile

All Implemented Interfaces:: AdditionalInformationHandler, ArrayProvider, CleanUpHandler, Destroyable, GlobalInfoSupporter, ForwardSlashSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, ArrayProvider, AutomatableInteraction, AutomatableInteractiveActor, ErrorHandler, InteractionDisplayLocationSupporter, InteractiveActor, InteractiveActorWithCustomParentComponent, OutputProducer, RestorableActor, StopModeSupporter, Serializable, Comparable

public class SelectFile
extends AbstractArrayProvider
implements InteractiveActorWithCustomParentComponent, AutomatableInteractiveActor, RestorableActor, ForwardSlashSupporter, InteractionDisplayLocationSupporter

Pops up a file chooser dialog, prompting the user to select one or more files. The files then get forwarded as strings.

Input/output:
- generates:
java.lang.String

-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST> (property: loggingLevel)
    The logging level for outputting errors and debugging output.
    default: WARNING
    min-user-mode: Expert

-name <java.lang.String> (property: name)
    The name of the actor.
    default: SelectFile

-annotation <adams.core.base.BaseAnnotation> (property: annotations)
    The annotations to attach to this actor.
    default:

-skip <boolean> (property: skip)
    If set to true, transformation is skipped and the input token is just forwarded
    as it is.
    default: false

-stop-flow-on-error <boolean> (property: stopFlowOnError)
    If set to true, the flow execution at this level gets stopped in case this
    actor encounters an error; the error gets propagated; useful for critical
    actors.
    default: false
    min-user-mode: Expert

-silent <boolean> (property: silent)
    If enabled, then no errors are output in the console; Note: the enclosing
    actor handler must have this enabled as well.
    default: false
    min-user-mode: Expert

-output-array <boolean> (property: outputArray)
    Whether to output the files as array or one-by-one.
    default: false

-stop-if-canceled <boolean> (property: stopFlowIfCanceled)
    If enabled, the flow gets stopped in case the user cancels the dialog.
    default: false

-custom-stop-message <java.lang.String> (property: customStopMessage)
    The custom stop message to use in case a user cancelation stops the flow
    (default is the full name of the actor)
    default:

-stop-mode <GLOBAL|STOP_RESTRICTOR> (property: stopMode)
    The stop mode to use.
    default: GLOBAL

-file-chooser-title <java.lang.String> (property: fileChooserTitle)
    The title for the file chooser dialog.
    default:

-initial-dir <adams.core.io.PlaceholderDirectory> (property: initialDirectory)
    The initial directory for the file chooser.
    default: ${CWD}

-extension <adams.core.base.BaseString> [-extension ...] (property: extensions)
    The extensions available through the file chooser (no dot; use comma to
    use multiple extensions per file filter).
    default:

-initial-file <adams.core.io.PlaceholderFile> [-initial-file ...] (property: initialFiles)
    The initial files for the file chooser.
    default:

-absolute <boolean> (property: absoluteFileNames)
    If enabled, absolute file names instead of relative ones are output.
    default: false

-use-forward-slashes <boolean> (property: useForwardSlashes)
    If enabled, forward slashes are used in the output (but the '\\' prefix
    of UNC paths is not converted).
    default: false

-non-interactive <boolean> (property: nonInteractive)
    If enabled, the initial value is forwarded without user interaction.
    default: false

-restoration-enabled <boolean> (property: restorationEnabled)
    If enabled, the state of the actor is being preserved and attempted to read
    in again next time this actor is executed.
    default: false

-restoration-file <adams.core.io.PlaceholderFile> (property: restorationFile)
    The file to store the restoration information in.
    default: ${CWD}

-display-location <DIALOG|NOTIFICATION_AREA> (property: displayLocation)
    Determines where the interaction is being displayed.
    default: DIALOG

-parent-component-actor <adams.flow.core.CallableActorReference> (property: parentComponentActor)
    The (optional) callable actor to use as parent component instead of the
    flow panel.
    default: unknown
    min-user-mode: Expert

-use-outer-window <boolean> (property: useOuterWindow)
    If enabled, the outer window (dialog/frame) is used instead of the component
    of the callable actor.
    default: false
    min-user-mode: Expert

Author:: fracpete (fracpete at waikato dot ac dot nz)
See Also:: Serialized Form

Field Summary

Fields
Modifier and Type	Field	Description
`static String`	`KEY_INITIAL_DIR`
`static String`	`KEY_INITIAL_FILES`
`protected boolean`	`m_AbsoluteFileNames`	whether to use absolute file/dir names.
`protected Actor`	`m_CallableActor`	the callable actor.
`protected GUIHelper.DialogCommunication`	`m_Comm`	for communicating with the input dialog.
`protected String`	`m_CustomStopMessage`	the custom stop message to use if flow gets stopped due to cancelation.
`protected InteractionDisplayLocation`	`m_DisplayLocation`	where to display the prompt.
`protected BaseString[]`	`m_Extensions`	the extensions to offer in the file chooser.
`protected String`	`m_FileChooserTitle`	the title of the file chooser dialog.
`protected CallableActorHelper`	`m_Helper`	the helper class.
`protected PlaceholderDirectory`	`m_InitialDirectory`	the initial directory.
`protected PlaceholderFile[]`	`m_InitialFiles`	the initial files to use.
`protected boolean`	`m_NonInteractive`	whether to automate the actor.
`protected CallableActorReference`	`m_ParentComponentActor`	the (optional) parent component to use.
`protected boolean`	`m_ParentComponentActorConfigured`	whether the callable actor has been configured.
`protected boolean`	`m_RestorationEnabled`	whether restoration is enabled.
`protected PlaceholderFile`	`m_RestorationFile`	the file to store the restoration state in.
`protected boolean`	`m_StopFlowIfCanceled`	whether to stop the flow if canceled.
`protected StopMode`	`m_StopMode`	how to perform the stop.
`protected boolean`	`m_UseForwardSlashes`	whether to output forward slashes.
`protected boolean`	`m_UseOuterWindow`	whether to use the outer window as parent.

Fields inherited from class adams.flow.source.AbstractArrayProvider
m_Index, m_OutputArray, m_Queue

Fields inherited from class adams.flow.core.AbstractActor
m_Annotations, m_BackupState, m_DetectedObjectVariables, m_DetectedVariables, m_ErrorHandler, m_Executed, m_Executing, m_ExecutionListeningSupporter, m_FullName, m_LoggingPrefix, m_Name, m_Parent, m_ScopeHandler, m_Self, m_Silent, m_Skip, m_StopFlowOnError, m_StopMessage, m_Stopped, m_StorageHandler, m_VariablesUpdated

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

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

Fields inherited from interface adams.flow.core.Actor
FILE_EXTENSION, FILE_EXTENSION_GZ

Fields inherited from interface adams.flow.core.InteractiveActor
INTERACTION_CANCELED

Constructor Summary

Constructors
Constructor Description

SelectFile()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`absoluteFileNamesTipText()`	Returns the tip text for this property.
`protected String`	`convert(File file)`	Converts the file object into a string.
`String`	`customStopMessageTipText()`	Returns the tip text for this property.
`void`	`defineOptions()`	Adds options to the internal list of options.
`String`	`displayLocationTipText()`	Returns the tip text for this property.
`protected String`	`doExecute()`	Executes the flow item.
`String`	`doInteract()`	Performs the interaction with the user.
`String`	`doInteractHeadless()`	Performs the interaction with the user in a headless environment.
`protected File[]`	`doInteractInDialog(BaseFileChooser fileChooser)`	Performs the interaction with the user in a dialog.
`protected File[]`	`doInteractInNotificationArea(BaseFileChooser fileChooser)`	Performs the interaction with the user in the notification area.
`String`	`extensionsTipText()`	Returns the tip text for this property.
`String`	`fileChooserTitleTipText()`	Returns the tip text for this property.
`protected Actor`	`findCallableActor()`	Tries to find the callable actor referenced by its callable name.
`boolean`	`getAbsoluteFileNames()`	Returns whether to output absolute file names or not.
`Component`	`getActualParentComponent()`	Returns the parent component to use.
`String`	`getCustomStopMessage()`	Returns the custom message to use when stopping the flow.
`InteractionDisplayLocation`	`getDisplayLocation()`	Returns where the interaction is being displayed.
`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.
`PlaceholderFile[]`	`getInitialFiles()`	Returns the initial files.
`protected Class`	`getItemClass()`	Returns the base class of the items.
`CallableActorReference`	`getParentComponentActor()`	Returns the (optional) callable actor to use as parent component instead of the flow panel.
`String`	`getQuickInfo()`	Returns a quick info about the actor, which will be displayed in the GUI.
`PlaceholderFile`	`getRestorationFile()`	Returns the file for storing the state.
`boolean`	`getStopFlowIfCanceled()`	Returns whether to stop the flow if dialog canceled.
`StopMode`	`getStopMode()`	Returns the stop mode.
`boolean`	`getUseForwardSlashes()`	Returns whether to use forward slashes in the output.
`boolean`	`getUseOuterWindow()`	Returns whether to use the outer window as parent.
`String`	`globalInfo()`	Returns a string describing the object.
`String`	`initialDirectoryTipText()`	Returns the tip text for this property.
`String`	`initialFilesTipText()`	Returns the tip text for this property.
`protected void`	`initialize()`	Initializes the members.
`boolean`	`isNonInteractive()`	Returns whether interactiveness is enabled/disabled.
`boolean`	`isRestorationEnabled()`	Returns whether restoration is enabled.
`String`	`nonInteractiveTipText()`	Returns the tip text for this property.
`String`	`outputArrayTipText()`	Returns the tip text for this property.
`String`	`parentComponentActorTipText()`	Returns the tip text for this property.
`protected void`	`reset()`	Resets the scheme.
`String`	`restorationEnabledTipText()`	Returns the tip text for this property.
`String`	`restorationFileTipText()`	Returns the tip text for this property.
`void`	`setAbsoluteFileNames(boolean value)`	Sets whether to output absolute file names or not.
`void`	`setCustomStopMessage(String value)`	Sets the custom message to use when stopping the flow.
`void`	`setDisplayLocation(InteractionDisplayLocation value)`	Sets where the interaction is being displayed.
`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`	`setInitialFiles(PlaceholderFile[] value)`	Sets the initial files.
`void`	`setNonInteractive(boolean value)`	Sets whether to enable/disable interactiveness.
`void`	`setParentComponentActor(CallableActorReference value)`	Sets the (optional) callable actor to use as parent component instead of the flow panel.
`void`	`setRestorationEnabled(boolean value)`	Sets whether to enable restoration.
`void`	`setRestorationFile(PlaceholderFile value)`	Sets the file for storing the state.
`void`	`setStopFlowIfCanceled(boolean value)`	Sets whether to stop the flow if dialog canceled.
`void`	`setStopMode(StopMode value)`	Sets the stop mode.
`void`	`setUseForwardSlashes(boolean value)`	Sets whether to use forward slashes in the output.
`void`	`setUseOuterWindow(boolean value)`	Sets whether to use the outer window as parent.
`void`	`stopExecution()`	Stops the execution.
`String`	`stopFlowIfCanceledTipText()`	Returns the tip text for this property.
`String`	`stopModeTipText()`	Returns the tip text for this property.
`boolean`	`supportsHeadlessInteraction()`	Returns whether headless interaction is supported.
`String`	`useForwardSlashesTipText()`	Returns the tip text for this property.
`String`	`useOuterWindowTipText()`	Returns the tip text for this property.

Methods inherited from class adams.flow.source.AbstractArrayProvider
generates, getOutputArray, hasPendingOutput, output, preExecute, setOutputArray, wrapUp

Methods inherited from class adams.flow.core.AbstractActor
annotationsTipText, backupState, canInspectOptions, canPerformSetUpCheck, cleanUp, compareTo, configureLogger, destroy, equals, execute, finalUpdateVariables, findVariables, findVariables, forceVariables, forCommandLine, forName, forName, getAdditionalInformation, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowActors, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getParentComponent, getPreviousSibling, getRoot, getScopeHandler, getSilent, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, handleException, hasErrorHandler, hasStopMessage, index, isBackedUp, isExecuted, isExecuting, isFinished, isHeadless, isStopped, nameTipText, performSetUpChecks, performVariableChecks, postExecute, pruneBackup, pruneBackup, restoreState, setAnnotations, setErrorHandler, setName, setParent, setSilent, setSkip, setStopFlowOnError, setUp, setVariables, shallowCopy, shallowCopy, silentTipText, sizeOf, skipTipText, stopExecution, stopFlowOnErrorTipText, updateDetectedVariables, updatePrefix, updateVariables, variableChanged

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

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

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

Methods inherited from interface adams.flow.core.Actor
cleanUp, compareTo, destroy, equals, execute, findVariables, getAnnotations, getDefaultName, getDetectedVariables, getErrorHandler, getFlowExecutionListeningSupporter, getFullName, getName, getNextSibling, getParent, getParentComponent, getPreviousSibling, getRoot, getScopeHandler, getSilent, getSkip, getStopFlowOnError, getStopMessage, getStorageHandler, getVariables, handleError, hasErrorHandler, hasStopMessage, index, isExecuted, isFinished, isHeadless, isStopped, setAnnotations, setErrorHandler, setName, setParent, setSilent, setSkip, setStopFlowOnError, setUp, setVariables, shallowCopy, shallowCopy, sizeOf, stopExecution, toCommandLine, variableChanged, wrapUp

Methods inherited from interface adams.core.AdditionalInformationHandler
getAdditionalInformation

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

Methods inherited from interface adams.core.logging.LoggingSupporter
getLogger, isLoggingEnabled

Methods inherited from interface adams.core.option.OptionHandler
cleanUpOptions, getOptionManager

Methods inherited from interface adams.core.VariablesInspectionHandler
canInspectOptions

- Field Detail
  - KEY_INITIAL_DIR
```
public static final String KEY_INITIAL_DIR
```
    See Also:
    
    Constant Field Values
  - KEY_INITIAL_FILES
```
public static final String KEY_INITIAL_FILES
```
    See Also:
    
    Constant Field Values
  - m_FileChooserTitle
```
protected String m_FileChooserTitle
```
    the title of the file chooser dialog.
  - m_InitialDirectory
```
protected PlaceholderDirectory m_InitialDirectory
```
    the initial directory.
  - m_Extensions
```
protected BaseString[] m_Extensions
```
    the extensions to offer in the file chooser.
  - m_InitialFiles
```
protected PlaceholderFile[] m_InitialFiles
```
    the initial files to use.
  - m_AbsoluteFileNames
```
protected boolean m_AbsoluteFileNames
```
    whether to use absolute file/dir names.
  - m_UseForwardSlashes
```
protected boolean m_UseForwardSlashes
```
    whether to output forward slashes.
  - m_StopFlowIfCanceled
```
protected boolean m_StopFlowIfCanceled
```
    whether to stop the flow if canceled.
  - m_CustomStopMessage
```
protected String m_CustomStopMessage
```
    the custom stop message to use if flow gets stopped due to cancelation.
  - m_StopMode
```
protected StopMode m_StopMode
```
    how to perform the stop.
  - m_NonInteractive
```
protected boolean m_NonInteractive
```
    whether to automate the actor.
  - m_RestorationEnabled
```
protected boolean m_RestorationEnabled
```
    whether restoration is enabled.
  - m_RestorationFile
```
protected PlaceholderFile m_RestorationFile
```
    the file to store the restoration state in.
  - m_DisplayLocation
```
protected InteractionDisplayLocation m_DisplayLocation
```
    where to display the prompt.
  - m_ParentComponentActor
```
protected CallableActorReference m_ParentComponentActor
```
    the (optional) parent component to use.
  - m_CallableActor
```
protected Actor m_CallableActor
```
    the callable actor.
  - m_ParentComponentActorConfigured
```
protected boolean m_ParentComponentActorConfigured
```
    whether the callable actor has been configured.
  - m_Helper
```
protected CallableActorHelper m_Helper
```
    the helper class.
  - m_UseOuterWindow
```
protected boolean m_UseOuterWindow
```
    whether to use the outer window as parent.
  - m_Comm
```
protected GUIHelper.DialogCommunication m_Comm
```
    for communicating with the input dialog.
- Constructor Detail
  - SelectFile
```
public SelectFile()
```
- 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 AbstractArrayProvider
  - reset
```
protected void reset()
```
    Resets the scheme.
    
    Overrides:
    
    reset in class AbstractArrayProvider
  - initialize
```
protected void initialize()
```
    Initializes the members.
    
    Overrides:
    
    initialize in class AbstractActor
  - getQuickInfo
```
public String getQuickInfo()
```
    Returns a quick info about the actor, which will be displayed in the GUI.
    
    Specified by:
    
    getQuickInfo in interface Actor
    
    Specified by:
    
    getQuickInfo in interface QuickInfoSupporter
    
    Overrides:
    
    getQuickInfo in class AbstractActor
    
    Returns:
    
    null if no info available, otherwise short string
  - outputArrayTipText
```
public String outputArrayTipText()
```
    Returns the tip text for this property.
    
    Specified by:
    
    outputArrayTipText in interface ArrayProvider
    
    Specified by:
    
    outputArrayTipText in interface ArrayProvider
    
    Specified by:
    
    outputArrayTipText in class AbstractArrayProvider
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - 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.
  - setInitialFiles
```
public void setInitialFiles(PlaceholderFile[] value)
```
    Sets the initial files.
    
    Parameters:
    
    value - the initial files
  - getInitialFiles
```
public PlaceholderFile[] getInitialFiles()
```
    Returns the initial files.
    
    Returns:
    
    the initial files
  - initialFilesTipText
```
public String initialFilesTipText()
```
    Returns the tip text for this property.
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setAbsoluteFileNames
```
public void setAbsoluteFileNames(boolean value)
```
    Sets whether to output absolute file names or not.
    
    Parameters:
    
    value - if true absolute file names are output
  - getAbsoluteFileNames
```
public boolean getAbsoluteFileNames()
```
    Returns whether to output absolute file names or not.
    
    Returns:
    
    true if absolute files are output
  - absoluteFileNamesTipText
```
public String absoluteFileNamesTipText()
```
    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.
  - setStopFlowIfCanceled
```
public void setStopFlowIfCanceled(boolean value)
```
    Sets whether to stop the flow if dialog canceled.
    
    Specified by:
    
    setStopFlowIfCanceled in interface InteractiveActor
    
    Parameters:
    
    value - if true flow gets stopped if dialog canceled
  - getStopFlowIfCanceled
```
public boolean getStopFlowIfCanceled()
```
    Returns whether to stop the flow if dialog canceled.
    
    Specified by:
    
    getStopFlowIfCanceled in interface InteractiveActor
    
    Returns:
    
    true if the flow gets stopped if dialog canceled
  - stopFlowIfCanceledTipText
```
public String stopFlowIfCanceledTipText()
```
    Returns the tip text for this property.
    
    Specified by:
    
    stopFlowIfCanceledTipText in interface InteractiveActor
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setCustomStopMessage
```
public void setCustomStopMessage(String value)
```
    Sets the custom message to use when stopping the flow.
    
    Specified by:
    
    setCustomStopMessage in interface InteractiveActor
    
    Parameters:
    
    value - the stop message
  - getCustomStopMessage
```
public String getCustomStopMessage()
```
    Returns the custom message to use when stopping the flow.
    
    Specified by:
    
    getCustomStopMessage in interface InteractiveActor
    
    Returns:
    
    the stop message
  - customStopMessageTipText
```
public String customStopMessageTipText()
```
    Returns the tip text for this property.
    
    Specified by:
    
    customStopMessageTipText in interface InteractiveActor
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setStopMode
```
public void setStopMode(StopMode value)
```
    Sets the stop mode.
    
    Specified by:
    
    setStopMode in interface StopModeSupporter
    
    Parameters:
    
    value - the mode
  - getStopMode
```
public StopMode getStopMode()
```
    Returns the stop mode.
    
    Specified by:
    
    getStopMode in interface StopModeSupporter
    
    Returns:
    
    the mode
  - stopModeTipText
```
public String stopModeTipText()
```
    Returns the tip text for this property.
    
    Specified by:
    
    stopModeTipText in interface StopModeSupporter
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setNonInteractive
```
public void setNonInteractive(boolean value)
```
    Sets whether to enable/disable interactiveness.
    
    Specified by:
    
    setNonInteractive in interface AutomatableInteraction
    
    Specified by:
    
    setNonInteractive in interface AutomatableInteractiveActor
    
    Parameters:
    
    value - if true actor is not interactive, but automated
  - isNonInteractive
```
public boolean isNonInteractive()
```
    Returns whether interactiveness is enabled/disabled.
    
    Specified by:
    
    isNonInteractive in interface AutomatableInteraction
    
    Specified by:
    
    isNonInteractive in interface AutomatableInteractiveActor
    
    Returns:
    
    true if actor is not interactive i.e., automated
  - nonInteractiveTipText
```
public String nonInteractiveTipText()
```
    Returns the tip text for this property.
    
    Specified by:
    
    nonInteractiveTipText in interface AutomatableInteraction
    
    Specified by:
    
    nonInteractiveTipText in interface AutomatableInteractiveActor
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setRestorationEnabled
```
public void setRestorationEnabled(boolean value)
```
    Sets whether to enable restoration.
    
    Specified by:
    
    setRestorationEnabled in interface RestorableActor
    
    Parameters:
    
    value - true if to enable restoration
  - isRestorationEnabled
```
public boolean isRestorationEnabled()
```
    Returns whether restoration is enabled.
    
    Specified by:
    
    isRestorationEnabled in interface RestorableActor
    
    Returns:
    
    true if restoration enabled
  - restorationEnabledTipText
```
public String restorationEnabledTipText()
```
    Returns the tip text for this property.
    
    Specified by:
    
    restorationEnabledTipText in interface RestorableActor
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setRestorationFile
```
public void setRestorationFile(PlaceholderFile value)
```
    Sets the file for storing the state.
    
    Specified by:
    
    setRestorationFile in interface RestorableActor
    
    Parameters:
    
    value - the file
  - getRestorationFile
```
public PlaceholderFile getRestorationFile()
```
    Returns the file for storing the state.
    
    Specified by:
    
    getRestorationFile in interface RestorableActor
    
    Returns:
    
    the file
  - restorationFileTipText
```
public String restorationFileTipText()
```
    Returns the tip text for this property.
    
    Specified by:
    
    restorationFileTipText in interface RestorableActor
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setDisplayLocation
```
public void setDisplayLocation(InteractionDisplayLocation value)
```
    Sets where the interaction is being displayed.
    
    Specified by:
    
    setDisplayLocation in interface InteractionDisplayLocationSupporter
    
    Parameters:
    
    value - the location
  - getDisplayLocation
```
public InteractionDisplayLocation getDisplayLocation()
```
    Returns where the interaction is being displayed.
    
    Specified by:
    
    getDisplayLocation in interface InteractionDisplayLocationSupporter
    
    Returns:
    
    the location
  - displayLocationTipText
```
public String displayLocationTipText()
```
    Returns the tip text for this property.
    
    Specified by:
    
    displayLocationTipText in interface InteractionDisplayLocationSupporter
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setParentComponentActor
```
public void setParentComponentActor(CallableActorReference value)
```
    Sets the (optional) callable actor to use as parent component instead of the flow panel.
    
    Specified by:
    
    setParentComponentActor in interface InteractiveActorWithCustomParentComponent
    
    Parameters:
    
    value - the callable actor
  - getParentComponentActor
```
public CallableActorReference getParentComponentActor()
```
    Returns the (optional) callable actor to use as parent component instead of the flow panel.
    
    Specified by:
    
    getParentComponentActor in interface InteractiveActorWithCustomParentComponent
    
    Returns:
    
    the callable actor
  - parentComponentActorTipText
```
public String parentComponentActorTipText()
```
    Returns the tip text for this property.
    
    Specified by:
    
    parentComponentActorTipText in interface InteractiveActorWithCustomParentComponent
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - setUseOuterWindow
```
public void setUseOuterWindow(boolean value)
```
    Sets whether to use the outer window as parent.
    
    Specified by:
    
    setUseOuterWindow in interface InteractiveActorWithCustomParentComponent
    
    Parameters:
    
    value - true if to use outer window
  - getUseOuterWindow
```
public boolean getUseOuterWindow()
```
    Returns whether to use the outer window as parent.
    
    Specified by:
    
    getUseOuterWindow in interface InteractiveActorWithCustomParentComponent
    
    Returns:
    
    true if to use outer window
  - useOuterWindowTipText
```
public String useOuterWindowTipText()
```
    Returns the tip text for this property.
    
    Specified by:
    
    useOuterWindowTipText in interface InteractiveActorWithCustomParentComponent
    
    Returns:
    
    tip text for this property suitable for displaying in the GUI or for listing the options.
  - findCallableActor
```
protected Actor findCallableActor()
```
    Tries to find the callable actor referenced by its callable name.
    
    Returns:
    
    the callable actor or null if not found
  - getActualParentComponent
```
public Component getActualParentComponent()
```
    Returns the parent component to use.
    
    Specified by:
    
    getActualParentComponent in interface InteractiveActorWithCustomParentComponent
    
    Returns:
    
    the parent
  - getItemClass
```
protected Class getItemClass()
```
    Returns the base class of the items.
    
    Specified by:
    
    getItemClass in class AbstractArrayProvider
    
    Returns:
    
    the class
  - convert
```
protected String convert(File file)
```
    Converts the file object into a string.
    
    Parameters:
    
    file - the file to convert
    
    Returns:
    
    the generated string
    
    See Also:
    
    getAbsoluteFileNames(), getUseForwardSlashes()
  - doInteractInDialog
```
protected File[] doInteractInDialog(BaseFileChooser fileChooser)
```
    Performs the interaction with the user in a dialog.
    
    Parameters:
    
    fileChooser - the file chooser instance to use
    
    Returns:
    
    the files, null if dialog cancelled
  - doInteractInNotificationArea
```
protected File[] doInteractInNotificationArea(BaseFileChooser fileChooser)
```
    Performs the interaction with the user in the notification area.
    
    Parameters:
    
    fileChooser - the file chooser instance to use
    
    Returns:
    
    the files, null if cancelled or flow stopped
  - doInteract
```
public String doInteract()
```
    Performs the interaction with the user.
    
    Specified by:
    
    doInteract in interface InteractiveActor
    
    Returns:
    
    null if successfully interacted, otherwise error message
  - supportsHeadlessInteraction
```
public boolean supportsHeadlessInteraction()
```
    Returns whether headless interaction is supported.
    
    Specified by:
    
    supportsHeadlessInteraction in interface InteractiveActor
    
    Returns:
    
    true if interaction in headless environment is possible
  - doInteractHeadless
```
public String doInteractHeadless()
```
    Performs the interaction with the user in a headless environment.
    
    Specified by:
    
    doInteractHeadless in interface InteractiveActor
    
    Returns:
    
    true if successfully interacted
  - doExecute
```
protected String doExecute()
```
    Executes the flow item.
    
    Specified by:
    
    doExecute in class AbstractActor
    
    Returns:
    
    null if everything is fine, otherwise error message
  - stopExecution
```
public void stopExecution()
```
    Stops the execution. No message set.
    
    Specified by:
    
    stopExecution in interface Actor
    
    Specified by:
    
    stopExecution in interface Stoppable
    
    Overrides:
    
    stopExecution in class AbstractActor

Class SelectFile

Field Summary

Fields inherited from class adams.flow.source.AbstractArrayProvider

Fields inherited from class adams.flow.core.AbstractActor

Fields inherited from class adams.core.option.AbstractOptionHandler

Fields inherited from class adams.core.logging.LoggingObject

Fields inherited from interface adams.flow.core.Actor

Fields inherited from interface adams.flow.core.InteractiveActor

Constructor Summary

Method Summary

Methods inherited from class adams.flow.source.AbstractArrayProvider

Methods inherited from class adams.flow.core.AbstractActor

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.flow.core.Actor

Methods inherited from interface adams.core.AdditionalInformationHandler

Methods inherited from interface adams.core.logging.LoggingLevelHandler

Methods inherited from interface adams.core.logging.LoggingSupporter

Methods inherited from interface adams.core.option.OptionHandler

Methods inherited from interface adams.core.VariablesInspectionHandler

Field Detail

KEY_INITIAL_DIR

KEY_INITIAL_FILES

m_FileChooserTitle

m_InitialDirectory

m_Extensions

m_InitialFiles

m_AbsoluteFileNames

m_UseForwardSlashes

m_StopFlowIfCanceled

m_CustomStopMessage

m_StopMode

m_NonInteractive

m_RestorationEnabled

m_RestorationFile

m_DisplayLocation

m_ParentComponentActor

m_CallableActor

m_ParentComponentActorConfigured

m_Helper

m_UseOuterWindow

m_Comm

Constructor Detail

SelectFile

Method Detail

globalInfo

defineOptions

reset

initialize

getQuickInfo

outputArrayTipText

setFileChooserTitle

getFileChooserTitle

fileChooserTitleTipText

setInitialDirectory

getInitialDirectory

initialDirectoryTipText

setExtensions

getExtensions

extensionsTipText

setInitialFiles

getInitialFiles

initialFilesTipText

setAbsoluteFileNames

getAbsoluteFileNames

absoluteFileNamesTipText

setUseForwardSlashes

getUseForwardSlashes

useForwardSlashesTipText

setStopFlowIfCanceled

getStopFlowIfCanceled

stopFlowIfCanceledTipText

setCustomStopMessage

getCustomStopMessage

customStopMessageTipText

setStopMode

getStopMode

stopModeTipText

setNonInteractive