Package adams.flow.source

Class EnterValue

  • All Implemented Interfaces:
    AdditionalInformationHandler, CleanUpHandler, Destroyable, GlobalInfoSupporter, 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 EnterValue
extends AbstractInteractiveSource
implements AutomatableInteractiveActor, RestorableActor, InteractionDisplayLocationSupporter
    Pops up a dialog, prompting the user to enter a value.

    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: EnterValue
 
    -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
 
    -message <adams.core.base.BaseString> (property: message)
    The message to prompt the user with; variables get expanded prior to prompting
    user.
    default: Please enter a value
 
    -initial-value <adams.core.base.BaseString> (property: initialValue)
    The initial value to prompt the user with; variables get expanded prior
    to prompting user.
    default:
 
    -selection-values <adams.core.base.BaseString> [-selection-values ...] (property: selectionValues)
    The options to let the user choose from.
    default:
 
    -num-cols <int> (property: numCols)
    The number of columns to use for the text box.
    default: 20
    minimum: 1
 
    -num-rows <int> (property: numRows)
    The number of rows to use for the text box.
    default: 1
    minimum: 1
 
    -use-buttons <boolean> (property: useButtons)
    If enabled and selection values are available, then instead of a dropdown
    list a button per selection value is displayed.
    default: false
 
    -vertical-buttons <boolean> (property: verticalButtons)
    If enabled and buttons are used, they get displayed vertically rather than
    horizontally.
    default: false
 
    -display-location <DIALOG|NOTIFICATION_AREA> (property: displayLocation)
    Determines where the interaction is being displayed.
    default: DIALOG
 
    -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}
    Author:
    fracpete (fracpete at waikato dot ac dot nz)
    See Also:
    Serialized Form

    • Field Detail

      • m_Message

        protected BaseString m_Message
        the message for the user.

      • m_InitialValue

        protected BaseString m_InitialValue
        the initial value.

      • m_SelectionValues

        protected BaseString[] m_SelectionValues
        options to select from.

      • m_NonInteractive

        protected boolean m_NonInteractive
        whether to automate the actor.

      • m_NumCols

        protected int m_NumCols
        the number of columns for the text box.

      • m_NumRows

        protected int m_NumRows
        the number of rows for the text box.

      • m_UseButtons

        protected boolean m_UseButtons
        whether to use buttons instead of a dropdown list.

      • m_VerticalButtons

        protected boolean m_VerticalButtons
        whether to use vertical buttons instead of a horizontal ones.

      • 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
        the output token to broadcast.

    • Constructor Detail

      • EnterValue

        public EnterValue()

    • Method Detail

      • setMessage

        public void setMessage​(BaseString value)
        Sets the message to prompt the user with.
        Parameters:
        value - the message

      • getMessage

        public BaseString getMessage()
        Returns the message the user is prompted with.
        Returns:
        the message

      • messageTipText

        public String messageTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setInitialValue

        public void setInitialValue​(BaseString value)
        Sets the initial value to prompt the user with.
        Parameters:
        value - the initial value

      • getInitialValue

        public BaseString getInitialValue()
        Returns the initial value the user is prompted with.
        Returns:
        the initial value

      • initialValueTipText

        public String initialValueTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setSelectionValues

        public void setSelectionValues​(BaseString[] value)
        Sets the selection values to prompt the user with.
        Parameters:
        value - the selection values

      • getSelectionValues

        public BaseString[] getSelectionValues()
        Returns the selection values to prompt the user with.
        Returns:
        the selection values

      • selectionValuesTipText

        public String selectionValuesTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setNumCols

        public void setNumCols​(int value)
        Sets the number of columns to use for the text box.
        Parameters:
        value - the number of columns

      • getNumCols

        public int getNumCols()
        Returns the number of columns to use for the text box.
        Returns:
        the number of columns

      • numColsTipText

        public String numColsTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setNumRows

        public void setNumRows​(int value)
        Sets the number of rows to use for the text box.
        Parameters:
        value - the number of rows

      • getNumRows

        public int getNumRows()
        Returns the number of rows to use for the text box.
        Returns:
        the number of rows

      • numRowsTipText

        public String numRowsTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setUseButtons

        public void setUseButtons​(boolean value)
        Sets whether to use buttons or a drop-down list for the selection values.
        Parameters:
        value - true if to use buttons

      • getUseButtons

        public boolean getUseButtons()
        Returns whether to use buttons or a drop-down list for the selection values.
        Returns:
        true if to use buttons

      • useButtonsTipText

        public String useButtonsTipText()
        Returns the tip text for this property.
        Returns:
        tip text for this property suitable for displaying in the GUI or for listing the options.

      • setVerticalButtons

        public void setVerticalButtons​(boolean value)
        Sets whether to use vertical buttons instead of horizontal ones.
        Parameters:
        value - true if to use buttons

      • getVerticalButtons

        public boolean getVerticalButtons()
        Returns whether to use vertical buttons instead of horizontal ones.
        Returns:
        true if to use buttons

      • verticalButtonsTipText

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

      • generates

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

      • 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