Name

adams.flow.transformer.ConfirmationDialog

Synopsis

Pops up a confirmation dialog, prompting the user to select 'yes', 'no' or 'cancel'.
If no custom tokens are used, the current token is only forwarded when the user selects 'yes'. Otherwise the token simply gets dropped.
In case of custom tokens, depending on the user's selection, either the user-defined 'yes', 'no' or 'cancel' string get forwarded as string tokens.
Closing the dialog gets interpreted as selecting the 'cancel' button.

Additional information

Flow input/output:
- input: adams.flow.core.Unknown
- output: adams.flow.core.Unknown

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	ConfirmationDialog

  
  
• 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

  
  
• title
  

  The title to prompt the user with (variables get expanded).

  command-line	-title <java.lang.String>
  default	Confirm

  
  
• message
  

  The message to prompt the user with (variables get expanded).

  command-line	-message <java.lang.String>
  default	Continue with processing of token?

  
  
• useCustomTokens
  

  If enabled, custom string tokens are forwarded based on the selection the user makes; otherwise the current token gets forwarded when the user selects 'yes' and nothing for 'no'.

  command-line	-custom-tokens <boolean>
  default	false

  
  
• yesToken
  

  The string to forward as token if the user chooses 'yes' in case custom tokens are enabled.

  command-line	-yes-token <java.lang.String>
  default

  
  
• noToken
  

  The string to forward as token if the user chooses 'no' in case custom tokens are enabled.

  command-line	-no-token <java.lang.String>
  default

  
  
• cancelToken
  

  The string to forward as token if the user chooses 'cancel' (or closes the dialog) in case custom tokens are enabled.

  command-line	-cancel-token <java.lang.String>
  default