Package adams.flow.source

Class SelectDirectory

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, ForwardSlashSupporter, LoggingLevelHandler, LoggingSupporter, OptionHandler, QuickInfoSupporter, ShallowCopySupporter<Actor>, SizeOfHandler, Stoppable, StoppableWithFeedback, VariablesInspectionHandler, VariableChangeListener, Actor, AutomatableInteraction, AutomatableInteractiveActor, ErrorHandler, InteractionDisplayLocationSupporter, InteractiveActor, InteractiveActorWithCustomParentComponent, OutputProducer, RestorableActor, StopModeSupporter, Serializable, Comparable
    public class SelectDirectory
extends AbstractInteractiveSource
implements AutomatableInteractiveActor, RestorableActor, ForwardSlashSupporter, InteractionDisplayLocationSupporter
    Pops up a directory chooser dialog, prompting the user to select a directory. The directory then gets forwarded as string.

    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: SelectDirectory
 
    -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
 
    -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
 
    -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
 
    -dir-chooser-title <java.lang.String> (property: directoryChooserTitle)
    The title for the directory chooser dialog.
    default:
 
    -initial-dir <adams.core.io.PlaceholderDirectory> (property: initialDirectory)
    The initial directory for the directory chooser.
    default: ${CWD}
 
    -absolute <boolean> (property: absoluteDirectoryName)
    If enabled, the directory name is output in absolute instead of relative
    form.
    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
 
    -multi-selection-enabled <boolean> (property: multiSelectionEnabled)
    If enabled, multiple directories can be selected.
    default: false
 
    -non-interactive <boolean> (property: nonInteractive)
    If enabled, the initial directory 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
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_DirectoryChooserTitle

        protected String m_DirectoryChooserTitle
        the title of the directory chooser dialog.

      • m_AbsoluteDirectoryName

        protected boolean m_AbsoluteDirectoryName
        whether to use absolute file/dir names.

      • m_UseForwardSlashes

        protected boolean m_UseForwardSlashes
        whether to output forward slashes.

      • m_MultiSelectionEnabled

        protected boolean m_MultiSelectionEnabled
        whether to allow multi-selection.

      • 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_OutputToken

        protected Token m_OutputToken
        for the chosen directory.

    • Constructor Detail

      • SelectDirectory

        public SelectDirectory()

    • Method Detail

      • setDirectoryChooserTitle

        public void setDirectoryChooserTitle​(String value)
        Sets the title for the directory chooser dialog.
        Parameters:
        value - the title

      • getDirectoryChooserTitle

        public String getDirectoryChooserTitle()
        Returns the title for the directory chooser dialog.
        Returns:
        the title

      • directoryChooserTitleTipText

        public String directoryChooserTitleTipText()
        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.

      • setAbsoluteDirectoryName

        public void setAbsoluteDirectoryName​(boolean value)
        Sets whether to output absolute directory names or not.
        Parameters:
        value - if true absolute directory names are output

      • getAbsoluteDirectoryName

        public boolean getAbsoluteDirectoryName()
        Returns whether to output absolute directory name or not.
        Returns:
        true if absolute directory name are output

      • absoluteDirectoryNameTipText

        public String absoluteDirectoryNameTipText()
        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.

      • setMultiSelectionEnabled

        public void setMultiSelectionEnabled​(boolean value)
        Sets whether to allow selection of multiple directories.
        Parameters:
        value - if true to allow selection of multiple dirs

      • getMultiSelectionEnabled

        public boolean getMultiSelectionEnabled()
        Returns whether to allow selection of multiple directories.
        Returns:
        true if multiple dirs can be selected

      • multiSelectionEnabledTipText

        public String multiSelectionEnabledTipText()
        Returns the tip text for this property.
        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.

      • 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.

      • getItemClass

        protected Class getItemClass()
        Returns the base class of the items.
        Returns:
        the class

      • convert

        protected String convert​(File file,
                         boolean absolute,
                         boolean forward)
        Converts the file object into a string.
        Parameters:
        file - the file to convert
        absolute - whether to generate absolute paths
        forward - whether to enforce forward slashes
        Returns:
        the generated string

      • convert

        protected String[] convert​(File[] files,
                           boolean absolute,
                           boolean forward)
        Converts the file objects into a string.
        Parameters:
        files - the files to convert
        absolute - whether to generate absolute paths
        forward - whether to enforce forward slashes
        Returns:
        the generated string

      • doInteractInDialog

        protected File[] doInteractInDialog​(FileChooser dirChooser)
        Performs the interaction with the user in a dialog.
        Parameters:
        dirChooser - the directory chooser instance to use
        Returns:
        the dirs, null if dialog cancelled

      • doInteractInNotificationArea

        protected File[] doInteractInNotificationArea​(FileChooser dirChooser)
        Performs the interaction with the user in the notification area.
        Parameters:
        dirChooser - the directory chooser instance to use
        Returns:
        the dirs, null if cancelled or flow stopped

      • generates

        public Class[] generates()
        Returns the class of objects that it generates.
        Specified by:
        generates in interface OutputProducer
        Returns:
        the Class of the generated tokens

      • output

        public Token output()
        Returns the generated token.
        Specified by:
        output in interface OutputProducer
        Returns:
        the generated token

      • hasPendingOutput

        public boolean hasPendingOutput()
        Checks whether there is pending output to be collected after executing the flow item.
        Specified by:
        hasPendingOutput in interface OutputProducer
        Returns:
        true if there is pending output