Name

adams.flow.source.EnterValue

Synopsis

Pops up a dialog, prompting the user to enter a value.

Additional information

Flow input/output:
- output: java.lang.String

Interactive actor information:
- supports interaction in headless mode: true

Options

• loggingLevel
  

  The logging level for outputting errors and debugging output.

  command-line	-logging-level <OFF|SEVERE|WARNING|INFO|CONFIG|FINE|FINER|FINEST>
  default	WARNING
  min-user-mode	Expert

  
  
• name
  

  The name of the actor.

  command-line	-name <java.lang.String>
  default	EnterValue

  
  
• annotations
  

  The annotations to attach to this actor.

  command-line	-annotation <adams.core.base.BaseAnnotation>
  default

  
  
• skip
  

  If set to true, transformation is skipped and the input token is just forwarded as it is.

  command-line	-skip <boolean>
  default	false

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

  command-line	-stop-flow-on-error <boolean>
  default	false
  min-user-mode	Expert

  
  
• silent
  

  If enabled, then no errors are output in the console; Note: the enclosing actor handler must have this enabled as well.

  command-line	-silent <boolean>
  default	false
  min-user-mode	Expert

  
  
• stopFlowIfCanceled
  

  If enabled, the flow gets stopped in case the user cancels the dialog.

  command-line	-stop-if-canceled <boolean>
  default	false

  
  
• customStopMessage
  

  The custom stop message to use in case a user cancelation stops the flow (default is the full name of the actor)

  command-line	-custom-stop-message <java.lang.String>
  default

  
  
• stopMode
  

  The stop mode to use.

  command-line	-stop-mode <GLOBAL|STOP_RESTRICTOR>
  default	GLOBAL

  
  
• parentComponentActor
  

  The (optional) callable actor to use as parent component instead of the flow panel.

  command-line	-parent-component-actor <adams.flow.core.CallableActorReference>
  default	unknown
  min-user-mode	Expert

  
  
• useOuterWindow
  

  If enabled, the outer window (dialog/frame) is used instead of the component of the callable actor.

  command-line	-use-outer-window <boolean>
  default	false
  min-user-mode	Expert

  
  
• message
  

  The message to prompt the user with; variables get expanded prior to prompting user.

  command-line	-message <adams.core.base.BaseString>
  default	Please enter a value

  
  
• initialValue
  

  The initial value to prompt the user with; variables get expanded prior to prompting user.

  command-line	-initial-value <adams.core.base.BaseString>
  default

  
  
• selectionValues
  

  The options to let the user choose from.

  command-line	-selection-values <adams.core.base.BaseString> [-selection-values ...]
  default

  
  
• numCols
  

  The number of columns to use for the text box.

  command-line	-num-cols <int>
  default	20
  minimum	1

  
  
• numRows
  

  The number of rows to use for the text box.

  command-line	-num-rows <int>
  default	1
  minimum	1

  
  
• useButtons
  

  If enabled and selection values are available, then instead of a dropdown list a button per selection value is displayed.

  command-line	-use-buttons <boolean>
  default	false

  
  
• verticalButtons
  

  If enabled and buttons are used, they get displayed vertically rather than horizontally.

  command-line	-vertical-buttons <boolean>
  default	false

  
  
• displayLocation
  

  Determines where the interaction is being displayed.

  command-line	-display-location <DIALOG|NOTIFICATION_AREA>
  default	DIALOG

  
  
• nonInteractive
  

  If enabled, the initial value is forwarded without user interaction.

  command-line	-non-interactive <boolean>
  default	false

  
  
• restorationEnabled
  

  If enabled, the state of the actor is being preserved and attempted to read in again next time this actor is executed.

  command-line	-restoration-enabled <boolean>
  default	false

  
  
• restorationFile
  

  The file to store the restoration information in.

  command-line	-restoration-file <adams.core.io.PlaceholderFile>
  default	${CWD}